phpDocumentor\Reflection\Php\Project

Complexity

Total Complexity

8

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	2
A	getName()	0	4	1
A	getFiles()	0	4	1
A	addFile()	0	4	1
A	getNamespaces()	0	4	1
A	addNamespace()	0	4	1
A	getRootNamespace()	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\Fqsen;
use phpDocumentor\Reflection\Project as ProjectInterface;

/**
 * Represents the entire project with its files, namespaces and indexes.
 */
final class Project implements ProjectInterface
{
    /**
     * @var string
     */
    private $name = '';

    /**
     * @var Namespace_|null
     */
    private $rootNamespace;

    /**
     * @var File[]
     */
    private $files = [];

    /**
     * @var Namespace_[]
     */
    private $namespaces = [];

    /**
     * Initializes this descriptor.
     *
     * @param string $name Name of the current project.
     * @param null|Namespace_ $namespace Root namespace of the project.
     */
    public function __construct(string $name, ?Namespace_ $namespace = null)
    {
        $this->name = $name;
        $this->rootNamespace = $namespace;
        if ($this->rootNamespace === null) {
            $this->rootNamespace = new Namespace_(new Fqsen('\\'));
        }
    }

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

    /**
     * Returns all files with their sub-elements.
     *
     * @return File[]
     */
    public function getFiles(): array
    {
        return $this->files;
    }

    /**
     * Add a file to this project.
     */
    public function addFile(File $file): void
    {
        $this->files[$file->getPath()] = $file;
    }

    /**
     * Returns all namespaces with their sub-elements.
     *
     * @return Namespace_[]
     */
    public function getNamespaces(): array
    {
        return $this->namespaces;
    }

    /**
     * Add a namespace to the project.
     */
    public function addNamespace(Namespace_ $namespace): void
    {
        $this->namespaces[(string) $namespace->getFqsen()] = $namespace;
    }

    /**
     * Returns the root (global) namespace.
     */
    public function getRootNamespace(): ?Namespace_
    {
        return $this->rootNamespace;
    }
}