PimpleCopy\Pimple\Container

Complexity

Total Complexity

32

Size/Duplication

Total Lines	253
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

98.77%

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	offsetSet()	0	9	2
C	offsetGet()	0	26	7
A	offsetExists()	0	4	1
A	offsetUnset()	0	10	3
A	factory()	0	10	2
A	protect()	0	10	2
A	raw()	0	12	3
C	extend()	0	27	7
A	keys()	0	4	1
A	register()	0	10	2

<?php

/*
 * This file is part of Pimple.
 *
 * Copyright (c) 2009 Fabien Potencier
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is furnished
 * to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace PimpleCopy\Pimple;


/**
 * Container main class.
 *
 * @author Fabien Potencier
 */
class Container implements \ArrayAccess
{

	private $values = array();

Private member variable "Container::values" must contain a leading underscore

Missing member variable doc comment

	private $factories;

Private member variable "Container::factories" must contain a leading underscore

Missing member variable doc comment

	private $protected;

Private member variable "Container::protected" must contain a leading underscore

Missing member variable doc comment

	private $frozen = array();

Private member variable "Container::frozen" must contain a leading underscore

Missing member variable doc comment

	private $raw = array();

Private member variable "Container::raw" must contain a leading underscore

Missing member variable doc comment

	private $keys = array();

Private member variable "Container::keys" must contain a leading underscore

Missing member variable doc comment

	/**
	 * Instantiate the container.
	 *
	 * Objects and parameters can be passed as argument to the constructor.
	 *
	 * @param array $values The parameters or objects.
	 */
	public function __construct(array $values = array())
	{
		$this->factories = new \SplObjectStorage();
		$this->protected = new \SplObjectStorage();

		foreach ( $values as $key => $value ) {
			$this->offsetSet($key, $value);
		}
	}

	/**
	 * Sets a parameter or an object.
	 *
	 * Objects must be defined as Closures.
	 *
	 * Allowing any PHP callable leads to difficult to debug problems
	 * as function names (strings) are callable (creating a function with
	 * the same name as an existing parameter would break your container).
	 *
	 * @param string $id	The unique identifier for the parameter or object.
	 * @param mixed  $value The value of the parameter or a closure to define an object.
	 *
	 * @return void
	 * @throws \RuntimeException Prevent override of a frozen service.
	 */
	public function offsetSet($id, $value)
	{
		if ( isset($this->frozen[$id]) ) {
			throw new \RuntimeException(sprintf('Cannot override frozen service "%s".', $id));
		}

		$this->values[$id] = $value;
		$this->keys[$id] = true;
	}

	/**
	 * Gets a parameter or an object.
	 *
	 * @param string $id The unique identifier for the parameter or object.
	 *
	 * @return mixed The value of the parameter or an object
	 * @throws \InvalidArgumentException If the identifier is not defined.
	 */
	public function offsetGet($id)
	{
		if ( !isset($this->keys[$id]) ) {
			throw new \InvalidArgumentException(sprintf('Identifier "%s" is not defined.', $id));
		}

		if ( isset($this->raw[$id])
			|| !is_object($this->values[$id])
			|| isset($this->protected[$this->values[$id]])
			|| !method_exists($this->values[$id], '__invoke')
		) {
			return $this->values[$id];
		}

		if ( isset($this->factories[$this->values[$id]]) ) {
			return $this->values[$id]($this);
		}

		$raw = $this->values[$id];
		$val = $this->values[$id] = $raw($this);
		$this->raw[$id] = $raw;

		$this->frozen[$id] = true;

		return $val;
	}

	/**
	 * Checks if a parameter or an object is set.
	 *
	 * @param string $id The unique identifier for the parameter or object.
	 *
	 * @return boolean
	 */
	public function offsetExists($id)
	{
		return isset($this->keys[$id]);
	}

	/**
	 * Unsets a parameter or an object.
	 *
	 * @param string $id The unique identifier for the parameter or object.
	 *
	 * @return void
	 */
	public function offsetUnset($id)
	{
		if ( isset($this->keys[$id]) ) {
			if ( is_object($this->values[$id]) ) {
				unset($this->factories[$this->values[$id]], $this->protected[$this->values[$id]]);
			}

			unset($this->values[$id], $this->frozen[$id], $this->raw[$id], $this->keys[$id]);
		}
	}

	/**
	 * Marks a callable as being a factory service.
	 *
	 * @param callable $callable A service definition to be used as a factory.
	 *
	 * @return callable The passed callable
	 * @throws \InvalidArgumentException Service definition has to be a closure of an invokable object.
	 */
	public function factory($callable)

Type hint "callable" missing for $callable

	{
		if ( !method_exists($callable, '__invoke') ) {
			throw new \InvalidArgumentException('Service definition is not a Closure or invokable object.');
		}

		$this->factories->attach($callable);

		return $callable;
	}

	/**
	 * Protects a callable from being interpreted as a service.
	 *
	 * This is useful when you want to store a callable as a parameter.
	 *
	 * @param callable $callable A callable to protect from being evaluated.
	 *
	 * @return callable The passed callable
	 * @throws \InvalidArgumentException Service definition has to be a closure of an invokable object.
	 */
	public function protect($callable)

Type hint "callable" missing for $callable

	{
		if ( !method_exists($callable, '__invoke') ) {
			throw new \InvalidArgumentException('Callable is not a Closure or invokable object.');
		}

		$this->protected->attach($callable);

		return $callable;
	}

	/**
	 * Gets a parameter or the closure defining an object.
	 *
	 * @param string $id The unique identifier for the parameter or object.
	 *
	 * @return mixed The value of the parameter or the closure defining an object
	 * @throws \InvalidArgumentException If the identifier is not defined.
	 */
	public function raw($id)
	{
		if ( !isset($this->keys[$id]) ) {
			throw new \InvalidArgumentException(sprintf('Identifier "%s" is not defined.', $id));
		}

		if ( isset($this->raw[$id]) ) {
			return $this->raw[$id];
		}

		return $this->values[$id];
	}

	/**
	 * Extends an object definition.
	 *
	 * Useful when you want to extend an existing object definition,
	 * without necessarily loading that object.
	 *
	 * @param string   $id	     The unique identifier for the object.
	 * @param callable $callable A service definition to extend the original.
	 *
	 * @return callable The wrapped callable
	 * @throws \InvalidArgumentException If the identifier is not defined or not a service definition.
	 */
	public function extend($id, $callable)

Type hint "callable" missing for $callable

	{
		if ( !isset($this->keys[$id]) ) {
			throw new \InvalidArgumentException(sprintf('Identifier "%s" is not defined.', $id));
		}

		if ( !is_object($this->values[$id]) || !method_exists($this->values[$id], '__invoke') ) {
			throw new \InvalidArgumentException(sprintf('Identifier "%s" does not contain an object definition.', $id));
		}

		if ( !is_object($callable) || !method_exists($callable, '__invoke') ) {
			throw new \InvalidArgumentException('Extension service definition is not a Closure or invokable object.');
		}

		$factory = $this->values[$id];

		$extended = function ($c) use ($callable, $factory) {
			return $callable($factory($c), $c);
		};

		if ( isset($this->factories[$factory]) ) {
			$this->factories->detach($factory);
			$this->factories->attach($extended);
		}

		return $this[$id] = $extended;
	}

	/**
	 * Returns all defined value names.
	 *
	 * @return array An array of value names
	 */
	public function keys()
	{
		return array_keys($this->values);
	}

	/**
	 * Registers a service provider.
	 *
	 * @param ServiceProviderInterface $provider A ServiceProviderInterface instance.
	 * @param array					   $values   An array of values that customizes the provider.
	 *
	 * @return static
	 */
	public function register(ServiceProviderInterface $provider, array $values = array())
	{
		$provider->register($this);

		foreach ( $values as $key => $value ) {
			$this[$key] = $value;
		}

		return $this;
	}

}