phpDocumentor\Reflection\Php\Argument

Complexity

Total Complexity

7

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getName()	0	4	1
A	getTypes()	0	4	1
A	addType()	0	4	1
A	getDefault()	0	4	1
A	isByReference()	0	4	1
A	isVariadic()	0	4	1

<?php
declare(strict_types=1);

/**
 * 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-2018 Mike van Riel<mike@phpdoc.org>
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\Reflection\Php;

/**
 * Descriptor representing a single Argument of a method or function.
 */
final class Argument
{
    /**
     * @var string name of the Argument
     */
    private $name = null;

    /** @var string[] $type an array of normalized types that should be in this Argument */
    private $types = [];

    /** @var string|null $default the default value for an argument or null if none is provided */
    private $default = null;

    /** @var bool $byReference whether the argument passes the parameter by reference instead of by value */
    private $byReference = false;

    /** @var boolean Determines if this Argument represents a variadic argument */
    private $isVariadic = false;

    /**
     * Initializes the object.
     */
    public function __construct(string $name, string $default = null, bool $byReference = false, bool $isVariadic = false)
    {
        $this->name = $name;
        $this->default = $default;
        $this->byReference = $byReference;
        $this->isVariadic = $isVariadic;
    }

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

    /**
     * {@inheritDoc}
     */
    public function getTypes(): array
    {
        return $this->types;
    }

    /**
     * Add a type.
     * @param mixed $type
     */
    public function addType($type): void
    {
        $this->types[] = $type;
    }

    /**
     * {@inheritDoc}
     */
    public function getDefault(): ?string
    {
        return $this->default;
    }

    /**
     * {@inheritDoc}
     */
    public function isByReference(): bool
    {
        return $this->byReference;
    }

    /**
     * Returns whether this argument represents a variadic argument.
     */
    public function isVariadic(): bool
    {
        return $this->isVariadic;
    }
}