Pimple\Container Class Reference

Container main class. More...

Inheritance diagram for Pimple\Container:

Collaboration diagram for Pimple\Container:

Public Member Functions
	__construct (array $values=array())
	Instantiate the container. More...
	offsetSet ($id, $value)
	Sets a parameter or an object. More...
	offsetGet ($id)
	Gets a parameter or an object. More...
	offsetExists ($id)
	Checks if a parameter or an object is set. More...
	offsetUnset ($id)
	Unsets a parameter or an object. More...
	factory ($callable)
	Marks a callable as being a factory service. More...
	protect ($callable)
	Protects a callable from being interpreted as a service. More...
	raw ($id)
	Gets a parameter or the closure defining an object. More...
	extend ($id, $callable)
	Extends an object definition. More...
	keys ()
	Returns all defined value names. More...
	register (ServiceProviderInterface $provider, array $values=array())
	Registers a service provider. More...

Private Attributes
	$values = array()
	$factories
	$protected
	$frozen = array()
	$raw = array()
	$keys = array()

Detailed Description

Container main class.

Author

Fabien Potencier

Definition at line 34 of file Container.php.

Constructor & Destructor Documentation

__construct()

Pimple\Container::__construct

(

array

$values = array()

)

Instantiate the container.

Objects and parameters can be passed as argument to the constructor.

Parameters

array

$values

The parameters or objects.

Definition at line 50 of file Container.php.

    {
        $this->factories = new \SplObjectStorage();
        $this->protected = new \SplObjectStorage();

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

Member Function Documentation

extend()

Pimple\Container::extend	(		$id,
			$callable
	)

Extends an object definition.

Useful when you want to extend an existing object definition, without necessarily loading that object.

Parameters

string	$id	The unique identifier for the object
callable	$callable	A service definition to extend the original

Returns

callable The wrapped callable

Exceptions

Definition at line 226 of file Container.php.

    {
        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;
    }

factory()

Pimple\Container::factory

(

$callable

)

Marks a callable as being a factory service.

Parameters

callable

$callable

A service definition to be used as a factory

Returns

callable The passed callable

Exceptions

Definition at line 158 of file Container.php.

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

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

        return $callable;
    }

keys()

Pimple\Container::keys

(

)

Returns all defined value names.

Returns

array An array of value names

Definition at line 259 of file Container.php.

    {
        return array_keys($this->values);
    }

offsetExists()

Pimple\Container::offsetExists

(

$id

)

Checks if a parameter or an object is set.

Parameters

string

$id

The unique identifier for the parameter or object

Returns

bool

Definition at line 128 of file Container.php.

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

offsetGet()

Pimple\Container::offsetGet

(

$id

)

Gets a parameter or an object.

Parameters

string

$id

The unique identifier for the parameter or object

Returns

mixed The value of the parameter or an object

Exceptions

Definition at line 93 of file Container.php.

    {
        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;
    }

offsetSet()

Pimple\Container::offsetSet	(		$id,
			$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).

Parameters

string	$id	The unique identifier for the parameter or object
mixed	$value	The value of the parameter or a closure to define an object

Exceptions

Definition at line 74 of file Container.php.

    {
        if (isset($this->frozen[$id])) {
            throw new \RuntimeException(sprintf('Cannot override frozen service "%s".', $id));
        }

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

offsetUnset()

Pimple\Container::offsetUnset

(

$id

)

Unsets a parameter or an object.

Parameters

string

$id

The unique identifier for the parameter or object

Definition at line 138 of file Container.php.

    {
        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]);
        }
    }

protect()

Pimple\Container::protect

(

$callable

)

Protects a callable from being interpreted as a service.

This is useful when you want to store a callable as a parameter.

Parameters

callable

$callable

A callable to protect from being evaluated

Returns

callable The passed callable

Exceptions

Definition at line 180 of file Container.php.

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

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

        return $callable;
    }

raw()

Pimple\Container::raw

(

$id

)

Gets a parameter or the closure defining an object.

Parameters

string

$id

The unique identifier for the parameter or object

Returns

mixed The value of the parameter or the closure defining an object

Exceptions

Definition at line 200 of file Container.php.

    {
        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];
    }

register()

Pimple\Container::register	(	ServiceProviderInterface	$provider,
		array	$values = array()
	)

Registers a service provider.

Parameters

ServiceProviderInterface	$provider	A ServiceProviderInterface instance
array	$values	An array of values that customizes the provider

Returns

static

Definition at line 272 of file Container.php.

References Pimple\ServiceProviderInterface\register().

    {
        $provider->register($this);

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

        return $this;
    }

Here is the call graph for this function:

Field Documentation

$factories

Pimple\Container::$factories

private

Definition at line 37 of file Container.php.

$frozen

Pimple\Container::$frozen = array()

private

Definition at line 39 of file Container.php.

$keys

Pimple\Container::$keys = array()

private

Definition at line 41 of file Container.php.

$protected

Pimple\Container::$protected

private

Definition at line 38 of file Container.php.

$raw

Pimple\Container::$raw = array()

private

Definition at line 40 of file Container.php.

$values

Pimple\Container::$values = array()

private

Definition at line 36 of file Container.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/pimple/pimple/src/Pimple/Container.php