phpDocumentor\Reflection\Php\Class_

Complexity

Total Complexity

19

Size/Duplication

Total Lines	221
Duplicated Lines	0 %

Coupling/Cohesion

Components	6
Dependencies	5

Test Coverage

Coverage

83.67%

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	19	2
A	isFinal()	0	4	1
A	isAbstract()	0	4	1
A	getParent()	0	4	1
A	getInterfaces()	0	4	1
A	addInterface()	0	4	1
A	getConstants()	0	4	1
A	addConstant()	0	4	1
A	getMethods()	0	4	1
A	addMethod()	0	4	1
A	getProperties()	0	4	1
A	addProperty()	0	4	1
A	getUsedTraits()	0	4	1
A	addUsedTrait()	0	4	1
A	getFqsen()	0	4	1
A	getName()	0	4	1
A	getDocBlock()	0	4	1
A	getLocation()	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;

use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\Element;
use phpDocumentor\Reflection\Fqsen;
use phpDocumentor\Reflection\Location;

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

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

    /**
     * @var boolean Whether this is an abstract class.
     */
    private $abstract = false;

    /**
     * @var boolean Whether this class is marked as final and can't be subclassed.
     */
    private $final = false;

    /**
     * @var null|Fqsen The class this class is extending.
     */
    private $parent = null;

    /**
     * @var Fqsen[] References to interfaces that are implemented by this class.
     */
    private $implements = [];

    /**
     * @var Constant[] References to constants defined in this class.
     */
    private $constants = [];

    /**
     * @var Property[] References to properties defined in this class.
     */
    private $properties = [];

    /**
     * @var Method[] References to methods defined in this class.
     */
    private $methods = [];

    /**
     * @var Fqsen[] References to traits consumed by this class
     */
    private $usedTraits = [];

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

    /**
     * Initializes a number of properties with the given values. Others are initialized by definition.
     */
    public function __construct(
        Fqsen $fqsen,
        ?DocBlock $docBlock = null,
        ?Fqsen $parent = null,
        bool $abstract = false,
        bool $final = false,
        ?Location $location = null
    ) {
        if ($location === null) {
            $location = new Location(-1);
        }

        $this->fqsen = $fqsen;
        $this->parent = $parent;
        $this->docBlock = $docBlock;
        $this->abstract = $abstract;
        $this->final = $final;
        $this->location = $location;
    }

    /**
     * Returns true when this class is final. Otherwise returns false.
     */
    public function isFinal(): bool
    {
        return $this->final;
    }

    /**
     * Returns true when this class is abstract. Otherwise returns false.
     */
    public function isAbstract(): bool
    {
        return $this->abstract;
    }

    /**
     * Returns the superclass this class is extending if available.
     */
    public function getParent(): ?Fqsen
    {
        return $this->parent;
    }

    /**
     * Returns the interfaces this class is implementing.
     *
     * @return Fqsen[]
     */
    public function getInterfaces(): array
    {
        return $this->implements;
    }

    /**
     * Add a interface Fqsen this class is implementing.
     */
    public function addInterface(Fqsen $interface): void
    {
        $this->implements[(string) $interface] = $interface;
    }

    /**
     * Returns the constants of this class.
     *
     * @return Constant[]
     */
    public function getConstants(): array
    {
        return $this->constants;
    }

    /**
     * Add Constant to this class.
     */
    public function addConstant(Constant $constant): void
    {
        $this->constants[(string) $constant->getFqsen()] = $constant;
    }

    /**
     * Returns the methods of this class.
     *
     * @return Method[]
     */
    public function getMethods(): array
    {
        return $this->methods;
    }

    /**
     * Add a method to this class.
     */
    public function addMethod(Method $method): void
    {
        $this->methods[(string) $method->getFqsen()] = $method;
    }

    /**
     * Returns the properties of this class.
     *
     * @return Property[]
     */
    public function getProperties(): array
    {
        return $this->properties;
    }

    /**
     * Add a property to this class.
     */
    public function addProperty(Property $property): void
    {
        $this->properties[(string) $property->getFqsen()] = $property;
    }

    /**
     * Returns the traits used by this class.
     *
     * @return Fqsen[]
     */
    public function getUsedTraits(): array
    {
        return $this->usedTraits;
    }

    /**
     * Add trait fqsen used by this class.
     */
    public function addUsedTrait(Fqsen $fqsen): void
    {
        $this->usedTraits[(string) $fqsen] = $fqsen;
    }

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

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

    public function getDocBlock(): ?DocBlock
    {
        return $this->docBlock;
    }

    public function getLocation(): Location
    {
        return $this->location;
    }
}