phpDocumentor\Reflection\Php\Function_

Complexity

Total Complexity

10

Size/Duplication

Total Lines	120
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Test Coverage

Coverage

92%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	19	3
A	getArguments()	0	4	1
A	addArgument()	0	4	1
A	getFqsen()	0	4	1
A	getName()	0	4	1
A	getDocBlock()	0	4	1
A	getLocation()	0	4	1
A	getReturnType()	0	4	1

<?php
/**
 * This file is part of phpDocumentor.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @copyright 2010-2015 Mike van Riel<mike@phpdoc.org>
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\Reflection\Php;

use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\Element;
use phpDocumentor\Reflection\Fqsen;
use phpDocumentor\Reflection\Location;
use phpDocumentor\Reflection\Type;
use phpDocumentor\Reflection\Types\Mixed_;

/**
 * Descriptor representing a function
 */
// @codingStandardsIgnoreStart
final class Function_ implements Element
// // @codingStandardsIgnoreEnd
{
    /**
     * @var Fqsen Full Qualified Structural Element Name
     */
    private $fqsen;

    /** @var Argument[] $arguments */
    private $arguments = array();

    /**
     * @var DocBlock|null
     */
    private $docBlock;

    /**
     * @var Location
     */
    private $location;

    /**
     * @var Type
     */
    private $returnType;

    /**
     * Initializes the object.
     *
     * @param Fqsen $fqsen
     * @param DocBlock|null $docBlock
     * @param Location|null $location
     * @param Type|null $returnType
     */
    public function __construct(
        Fqsen $fqsen,
        DocBlock $docBlock = null,
        Location $location = null,
        Type $returnType = null
    ) {
        if ($location === null) {
            $location = new Location(-1);
        }

        if ($returnType ===  null) {
            $returnType = new Mixed_();
        }

        $this->fqsen = $fqsen;
        $this->docBlock = $docBlock;
        $this->location = $location;
        $this->returnType = $returnType;
    }

    /**
     * Returns the arguments of this function.
     *
     * @return Argument[]
     */
    public function getArguments()
    {
        return $this->arguments;
    }

    /**
     * Add an argument to the function.
     *
     * @param Argument $argument
     */
    public function addArgument(Argument $argument)
    {
        $this->arguments[] = $argument;
    }

    /**
     * Returns the Fqsen of the element.
     *
     * @return Fqsen
     */
    public function getFqsen()
    {
        return $this->fqsen;
    }

    /**
     * Returns the name of the element.
     *
     * @return string
     */
    public function getName()
    {
        return $this->fqsen->getName();
    }

    /**
     * Returns the DocBlock of the element if available
     *
     * @return null|DocBlock
     */
    public function getDocBlock()
    {
        return $this->docBlock;
    }

    /**
     * @return Location
     */
    public function getLocation()
    {
        return $this->location;
    }

    /**
     * @return Type
     */
    public function getReturnType() : Type
    {
        return $this->returnType;
    }
}