Intraxia\Jaxion\Core\Container

Complexity

Total Complexity

30

Size/Duplication

Total Lines	320
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

92.68%

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	14	5
B	define()	0	25	5
A	share()	0	11	2
B	fetch()	0	31	5
A	has()	0	3	1
A	remove()	0	21	2
A	register()	0	6	1
A	offsetSet()	0	3	1
A	offsetGet()	0	3	1
A	offsetExists()	0	3	1
A	offsetUnset()	0	3	1
A	rewind()	0	4	1
A	current()	0	3	1
A	key()	0	3	1
A	next()	0	3	1
A	valid()	0	3	1

<?php
namespace Intraxia\Jaxion\Core;

use Intraxia\Jaxion\Contract\Core\Container as ContainerContract;
use Intraxia\Jaxion\Contract\Core\ServiceProvider;

/**
 * Class Container
 *
 * Contains, manages, and retrieves service objects.
 *
 * @package Intraxia\Jaxion
 * @subpackage Core
 */
class Container implements ContainerContract {
	/**
	 * ServiceProvider names to register with the container.
	 *
	 * Can be overwritten to include predefined providers.
	 *
	 * @var string[]
	 */
	protected $providers = array();

	/**
	 * Registered definitions.
	 *
	 * @var mixed[]
	 */
	private $definitions = array();

	/**
	 * Aliases to share between fetches.
	 *
	 * @var <string, true>[]
	 */
	private $shared = array();

	/**
	 * Aliases of all the registered services.
	 *
	 * @var <string, true>[]
	 */
	private $aliases = array();

	/**
	 * Array of classes registered on the container.
	 *
	 * @var <string, true>[]
	 */
	private $classes = array();

	/**
	 * Current position in the loop.
	 *
	 * @var int
	 */
	private $position;

	/**
	 * 0-indexed array of aliases for looping.
	 *
	 * @var string[]
	 */
	private $keys = array();

	/**
	 * Create a new container with the given providers.
	 *
	 * Providers can be instances or the class of the provider as a string.
	 *
	 * @param ServiceProvider[]|string[] $providers
	 */
	public function __construct( array $providers = array() ) {
		// array_unique ensures we only register each provider once.
		$providers = array_unique( array_merge( $this->providers, $providers ) );

		foreach ( $providers as $provider ) {
			if ( is_string( $provider ) && class_exists( $provider ) ) {
				$provider = new $provider;
			}

			if ( $provider instanceof ServiceProvider ) {
				$this->register( $provider );
			}
		}
	}


	/**
	 * {@inheritdoc}
	 *
	 * @param string|array $alias
	 * @param mixed        $definition
	 *
	 * @throws DefinedAliasException
	 *
	 * @return $this
	 */
	public function define( $alias, $definition ) {
		if ( is_array( $alias ) ) {
			$class = current( $alias );
			$alias = key( $alias );
		}

		if ( isset( $this->aliases[ $alias ] ) ) {
			throw new DefinedAliasException( $alias );
		}

		$this->aliases[ $alias ]     = true;
		$this->definitions[ $alias ] = $definition;

		// Closures are treated as factories unless
		// defined via Container::share.
		if ( ! $definition instanceof \Closure ) {
			$this->shared[ $alias ] = true;
		}

		if ( isset( $class ) ) {
			$this->classes[ $class ] = $alias;
		}

		return $this;
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param string|array $alias
	 * @param mixed        $definition
	 *
	 * @throws DefinedAliasException
	 *
	 * @return $this
	 */
	public function share( $alias, $definition ) {
		$this->define( $alias, $definition );

		if ( is_array( $alias ) ) {
			$alias = key( $alias );
		}

		$this->shared[ $alias ] = true;

		return $this;
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param string $alias
	 *
	 * @throws UndefinedAliasException
	 *
	 * @return mixed
	 */
	public function fetch( $alias ) {
		if ( isset( $this->classes[ $alias ] ) ) {
			// If the alias is a class name,
			// then retrieve its linked alias.
			// This is only registered when
			// registering using an array.
			$alias = $this->classes[ $alias ];
		}

		if ( ! isset( $this->aliases[ $alias ] ) ) {
			throw new UndefinedAliasException( $alias );
		}

		$value = $this->definitions[ $alias ];

		// If the shared value is a closure,
		// execute it and assign the result
		// in place of the closure.
		if ( $value instanceof \Closure ) {
			$factory = $value;
			$value   = $factory( $this );
		}

		// If the value is shared, save the shared value.
		if ( isset( $this->shared[ $alias ] ) ) {
			$this->definitions[ $alias ] = $value;
		}

		// Return the fetched value.
		return $value;
	}

	/**
	 * {@inheritdoc}
	 *
	 * @param  string $alias
	 *
	 * @return bool
	 */
	public function has( $alias ) {
		return isset( $this->aliases[ $alias ] );
	}

	/**
	 * {@inheritDoc}
	 *
	 * @param string $alias
	 *
	 * @return $this
	 */
	public function remove( $alias ) {
		if ( isset( $this->aliases[ $alias ] ) ) {
			/**
			 * If there's no reference in the aliases array,
			 * the service won't be found on fetching and
			 * can be overwritten on setting.
			 *
			 * Pros: Quick setting/unsetting, faster
			 * performance on those operations when doing
			 * a lot of these.
			 *
			 * Cons: Objects and values set in the container
			 * can't get garbage collected.
			 *
			 * If this is a problem, this may need to be revisited.
			 */
			unset( $this->aliases[ $alias ] );
		}

		return $this;

The return type of return $this; (Intraxia\Jaxion\Core\Container) is incompatible with the return type declared by the interface Intraxia\Jaxion\Contract\Core\Container::remove of type boolean.

	}

	/**
	 * {@inheritDoc}
	 *
	 * @param ServiceProvider $provider
	 *
	 * @return $this
	 */
	public function register( ServiceProvider $provider ) {
		// @todo make sure provider is only registered once
		$provider->register( $this );

		return $this;
	}

	/**
	 * Set a value into the container.
	 *
	 * @param  string $id
	 * @param  mixed  $value
	 *
	 * @see    define
	 */
	public function offsetSet( $id, $value ) {

The function name offsetSet is in camel caps, but expected offset_set instead as per the coding standard.

		$this->define( $id, $value );
	}

	/**
	 * Get an value from the container.
	 *
	 * @param  string $id
	 *
	 * @return object
	 * @throws UndefinedAliasException
	 *
	 * @see    fetch
	 */
	public function offsetGet( $id ) {

The function name offsetGet is in camel caps, but expected offset_get instead as per the coding standard.

		return $this->fetch( $id );
	}

	/**
	 * Checks if a key is set on the container.
	 *
	 * @param  string $id
	 *
	 * @return bool
	 *
	 * @see    has
	 */
	public function offsetExists( $id ) {

The function name offsetExists is in camel caps, but expected offset_exists instead as per the coding standard.

		return $this->has( $id );
	}

	/**
	 * Remove a key from the container.
	 *
	 * @param string $id
	 *
	 * @see   remove
	 */
	public function offsetUnset( $id ) {

The function name offsetUnset is in camel caps, but expected offset_unset instead as per the coding standard.

		$this->remove( $id );
	}

	/**
	 * Sets the object properties to prepare for the loop.
	 */
	public function rewind() {
		$this->position = 0;
		$this->keys     = array_keys( $this->aliases );

It seems like array_keys($this->aliases) of type array<integer,integer|string> is incompatible with the declared type array<integer,string> of property $keys.

	}

	/**
	 * Retrieves the service object for the current step in the loop.
	 *
	 * @return object
	 */
	public function current() {
		return $this->fetch( $this->keys[ $this->position ] );
	}

	/**
	 * Retrieves the key for the current step in the loop.
	 *
	 * @return string
	 */
	public function key() {
		return $this->keys[ $this->position ];
	}

	/**
	 * Increments to the next step in the loop.
	 */
	public function next() {
		$this->position ++;
	}

	/**
	 * Checks if the next step in the loop in valid.
	 *
	 * @return bool
	 */
	public function valid() {
		return isset( $this->keys[ $this->position ] );
	}
}