gossi\codegen\model\parts\TraitsPart

Complexity

Total Complexity

15

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

83.78%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
	addUseStatement()	0	1	?
	removeUseStatement()	0	1	?
	getNamespace()	0	1	?
A	addTrait()	0	15	3
A	getTraits()	0	3	1
A	getPhpTraits()	0	9	3
A	hasTrait()	0	7	2
A	removeTrait()	0	19	4
A	setTraits()	0	7	2

<?php
declare(strict_types=1);

namespace gossi\codegen\model\parts;

use gossi\codegen\model\PhpTrait;

/**
 * Traits part
 *
 * For all models that can have traits
 *
 * @author Thomas Gossmann
 */
trait TraitsPart {

	/** @var string[] */
	private $traits = [];

	/**
	 * Adds a use statement with an optional alias
	 *
	 * @param string $qualifiedName
	 * @param null|string $alias
	 * @return $this
	 */
	abstract public function addUseStatement($qualifiedName, string $alias = null);

	/**
	 * Removes a use statement
	 *
	 * @param string $qualifiedName
	 * @return $this
	 */
	abstract public function removeUseStatement(string $qualifiedName);

	/**
	 * Returns the namespace
	 *
	 * @return string
	 */
	abstract public function getNamespace(): ?string;

	/**
	 * Adds a trait.
	 *
	 * If the trait is passed as PhpTrait object,
	 * the trait is also added as use statement.
	 *
	 * @param PhpTrait|string $trait trait or qualified name
	 * @return $this
	 */
	public function addTrait($trait) {
		if ($trait instanceof PhpTrait) {
			$name = $trait->getName();
			$qname = $trait->getQualifiedName();
			$this->addUseStatement($qname);
		} else {
			$name = $trait;
		}

		if (!in_array($name, $this->traits, true)) {
			$this->traits[] = $name;
		}

		return $this;
	}

	/**
	 * Returns a collection of traits
	 *
	 * @return string[]
	 */
	public function getTraits(): array {
		return $this->traits;
	}

    /**
     * @return iterable|PhpTrait[]
     */
    public function getPhpTraits(): iterable {
        $traits = [];
        foreach ($this->traits as $trait) {
            $traits[] = trait_exists($trait) ?
                PhpTrait::fromName($trait) : PhpTrait::create($trait);
        }

        return $traits;
    }

	/**
	 * Checks whether a trait exists
	 *
	 * @param PhpTrait|string $trait
	 * @return bool `true` if it exists and `false` if not
	 */
	public function hasTrait($trait): bool {
		if (!$trait instanceof PhpTrait) {
			$trait = new PhpTrait($trait);
		}
		$name = $trait->getName();
		return in_array($name, $this->traits);
	}

	/**
	 * Removes a trait.
	 *
	 * If the trait is passed as PhpTrait object,
	 * the trait is also removed from use statements.
	 *
	 * @param PhpTrait|string $trait trait or qualified name
	 * @return $this
	 */
	public function removeTrait($trait) {
		if ($trait instanceof PhpTrait) {
			$name = $trait->getName();
		} else {
			$name = $trait;
		}

		$index = array_search($name, $this->traits);
		if ($index !== false) {
			unset($this->traits[$index]);

			if ($trait instanceof PhpTrait) {
				$qname = $trait->getQualifiedName();
				$this->removeUseStatement($qname);
			}
		}

		return $this;
	}

	/**
	 * Sets a collection of traits
	 *
	 * @param PhpTrait[] $traits
	 * @return $this
	 */
	public function setTraits(array $traits) {
		foreach ($traits as $trait) {
			$this->addTrait($trait);
		}

		return $this;
	}
}