gossi\codegen\model\parts\InterfacesPart

Complexity

Total Complexity

13

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	1	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
	addUseStatement()	0	1	?
	removeUseStatement()	0	1	?
	getNamespace()	0	1	?
A	addInterface()	0	19	4
A	getInterfaces()	0	3	1
A	hasInterfaces()	0	3	1
A	hasInterface()	0	7	2
A	removeInterface()	0	17	3
A	setInterfaces()	0	7	2

<?php
namespace gossi\codegen\model\parts;

use gossi\codegen\model\PhpInterface;

/**
 * Interfaces part
 *
 * For all models that can contain interfaces
 *
 * @author Thomas Gossmann
 */
trait InterfacesPart {

	/** @var array */
	private $interfaces = [];

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

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

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

	/**
	 * Adds an interface.
	 *
	 * If the interface is passed as PhpInterface object,
	 * the interface is also added as use statement.
	 *
	 * @param PhpInterface|string $interface interface or qualified name
	 * @return $this
	 */
	public function addInterface($interface) {
		if ($interface instanceof PhpInterface) {
			$name = $interface->getName();
			$qname = $interface->getQualifiedName();
			$namespace = $interface->getNamespace();

			if ($namespace != $this->getNamespace()) {
				$this->addUseStatement($qname);
			}
		} else {
			$name = $interface;
		}

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

		return $this;
	}

	/**
	 * Returns the interfaces
	 *
	 * @return PhpInterface[]
	 */
	public function getInterfaces() {
		return $this->interfaces;
	}

	/**
	 * Checks whether interfaces exists
	 *
	 * @return bool `true` if interfaces are available and `false` if not
	 */
	public function hasInterfaces() {
		return count($this->interfaces) > 0;
	}

	/**
	 * Checks whether an interface exists
	 *
	 * @param PhpInterface|string $interface interface name or instance
	 * @return bool
	 */
	public function hasInterface($interface) {
		if (!$interface instanceof PhpInterface) {
			$interface = new PhpInterface($interface);
		}
		$name = $interface->getName();
		return in_array($name, $this->interfaces);
	}

	/**
	 * Removes an interface.
	 *
	 * If the interface is passed as PhpInterface object,
	 * the interface is also remove from the use statements.
	 *
	 * @param PhpInterface|string $interface interface or qualified name
	 * @return $this
	 */
	public function removeInterface($interface) {
		if ($interface instanceof PhpInterface) {
			$name = $interface->getName();
			$qname = $interface->getQualifiedName();

			$this->removeUseStatement($qname);
		} else {
			$name = $interface;
		}

		$index = array_search($name, $this->interfaces);
		if ($index) {
			unset($this->interfaces[$name]);
		}

		return $this;
	}

	/**
	 * Sets a collection of interfaces
	 *
	 * @param PhpInterface[] $interfaces
	 * @return $this
	 */
	public function setInterfaces(array $interfaces) {
		foreach ($interfaces as $interface) {
			$this->addInterface($interface);
		}

		return $this;
	}
}