MethodReflection.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2009 Christopher Hlubek <hlubek@networkteam.com>
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/

/**
 * Extended version of the ReflectionMethod
 *
 * @package Extbase
 * @subpackage Reflection
 * @version $Id: MethodReflection.php 1052 2009-08-05 21:51:32Z sebastian $
 */
class Tx_Extbase_Reflection_MethodReflection extends ReflectionMethod {

    /**
     * @var Tx_Extbase_Reflection_DocCommentParser: An instance of the doc comment parser
     */
    protected $docCommentParser;

    /**
     * The constructor, initializes the reflection class
     *
     * @param  string $className Name of the method's class
     * @param  string $methodName Name of the method to reflect
     * @return void
     */
    public function __construct($className, $methodName) {
        parent::__construct($className, $methodName);
    }

    /**
     * Returns the declaring class
     *
     * @return Tx_Extbase_Reflection_ClassReflection The declaring class
     */
    public function getDeclaringClass() {
        return new Tx_Extbase_Reflection_ClassReflection(parent::getDeclaringClass()->getName());
    }

    /**
     * Replacement for the original getParameters() method which makes sure
     * that Tx_Extbase_Reflection_ParameterReflection objects are returned instead of the
     * orginal ReflectionParameter instances.
     *
     * @return array of Tx_Extbase_Reflection_ParameterReflection Parameter reflection objects of the parameters of this method
     */
    public function getParameters() {
        $extendedParameters = array();
        foreach (parent::getParameters() as $parameter) {
            $extendedParameters[] = new Tx_Extbase_Reflection_ParameterReflection(array($this->getDeclaringClass()->getName(), $this->getName()), $parameter->getName());
        }
        return $extendedParameters;
    }

    /**
     * Checks if the doc comment of this method is tagged with
     * the specified tag
     *
     * @param string $tag Tag name to check for
     * @return boolean TRUE if such a tag has been defined, otherwise FALSE
     */
    public function isTaggedWith($tag) {
        $result = $this->getDocCommentParser()->isTaggedWith($tag);
        return $result;
    }

    /**
     * Returns an array of tags and their values
     *
     * @return array Tags and values
     */
    public function getTagsValues() {
        return $this->getDocCommentParser()->getTagsValues();
    }

    /**
     * Returns the values of the specified tag
     *
     * @param string $tag Tag name to check for
     * @return array Values of the given tag
     */
    public function getTagValues($tag) {
        return $this->getDocCommentParser()->getTagValues($tag);
    }

    /**
     * Returns an instance of the doc comment parser and
     * runs the parse() method.
     *
     * @return Tx_Extbase_Reflection_DocCommentParser
     */
    protected function getDocCommentParser() {
        if (!is_object($this->docCommentParser)) {
            $this->docCommentParser = new Tx_Extbase_Reflection_DocCommentParser;
            $this->docCommentParser->parseDocComment($this->getDocComment());
        }
        return $this->docCommentParser;
    }
}

?>