Slim\Container Class Reference

Inheritance diagram for Slim\Container:

Collaboration diagram for Slim\Container:

Public Member Functions
	__construct (array $values=[])
	Create new container. More...
	get ($id)
	Finds an entry of the container by its identifier and returns it. More...
	has ($id)
	Returns true if the container can return an entry for the given identifier. More...
	__get ($name)
	__isset ($name)
Public Member Functions inherited from Pimple\Container
	__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...
	get ($id)
	Finds an entry of the container by its identifier and returns it. More...
	has ($id)
	Returns true if the container can return an entry for the given identifier. More...

Private Member Functions
	registerDefaultServices ($userSettings)
	This function registers the default services that Slim needs to work. More...
	exceptionThrownByContainer (\InvalidArgumentException $exception)
	Tests whether an exception needs to be recast for compliance with Container-Interop. More...

Private Attributes
	$defaultSettings

Detailed Description

Definition at line 45 of file Container.php.

Constructor & Destructor Documentation

__construct()

Slim\Container::__construct

(

array

$values = []

)

Create new container.

Parameters

array

$values

The parameters or objects.

Reimplemented from Pimple\Container.

Definition at line 67 of file Container.php.

    {
        parent::__construct($values);
 
        $userSettings = isset($values['settings']) ? $values['settings'] : [];
        $this->registerDefaultServices($userSettings);
    }

Member Function Documentation

__get()

Slim\Container::__get

(

$name

)

Definition at line 170 of file Container.php.

    {
        return $this->get($name);
    }

References $name.

__isset()

Slim\Container::__isset

(

$name

)

Definition at line 175 of file Container.php.

    {
        return $this->has($name);
    }

References $name.

exceptionThrownByContainer()

Slim\Container::exceptionThrownByContainer ( \InvalidArgumentException  $exception )

private

Tests whether an exception needs to be recast for compliance with Container-Interop.

This will be if the exception was thrown by Pimple.

Parameters

\InvalidArgumentException

$exception

Returns

bool

Definition at line 145 of file Container.php.

    {
        $trace = $exception->getTrace()[0];
 
        return $trace['class'] === PimpleContainer::class && $trace['function'] === 'offsetGet';
    }

get()

Slim\Container::get

(

$id

)

Finds an entry of the container by its identifier and returns it.

Parameters

string

$id

Identifier of the entry to look for.

Exceptions

ContainerValueNotFoundException	No entry was found for this identifier.
ContainerException	Error while retrieving the entry.

Returns

mixed Entry.

Implements Psr\Container\ContainerInterface.

Definition at line 117 of file Container.php.

    {
        if (!$this->offsetExists($id)) {
            throw new ContainerValueNotFoundException(sprintf('Identifier "%s" is not defined.', $id));
        }
        try {
            return $this->offsetGet($id);
        } catch (\InvalidArgumentException $exception) {
            if ($this->exceptionThrownByContainer($exception)) {
                throw new SlimContainerException(
                    sprintf('Container error while retrieving "%s"', $id),
                    null,
                    $exception
                );
            } else {
                throw $exception;
            }
        }
    }

References $id, and sprintf.

has()

Slim\Container::has

(

$id

)

Returns true if the container can return an entry for the given identifier.

Returns false otherwise.

Parameters

string

$id

Identifier of the entry to look for.

Returns

boolean

Implements Psr\Container\ContainerInterface.

Definition at line 160 of file Container.php.

    {
        return $this->offsetExists($id);
    }

References $id.

registerDefaultServices()

Slim\Container::registerDefaultServices (   $userSettings )

private

This function registers the default services that Slim needs to work.

All services are shared - that is, they are registered such that the same instance is returned on subsequent calls.

Parameters

array

$userSettings

Associative array of application settings

Returns

void

This service MUST return an array or an instance of \ArrayAccess.

Returns

array|\ArrayAccess

Definition at line 85 of file Container.php.

    {
        $defaultSettings = $this->defaultSettings;
 
        $this['settings'] = function () use ($userSettings, $defaultSettings) {
            return new Collection(array_merge($defaultSettings, $userSettings));
        };
 
        $defaultProvider = new DefaultServicesProvider();
        $defaultProvider->register($this);
    }

Field Documentation

$defaultSettings

Slim\Container::$defaultSettings

private

Initial value:

= [
        'httpVersion' => '1.1',
        'responseChunkSize' => 4096,
        'outputBuffering' => 'append',
        'determineRouteBeforeAppMiddleware' => false,
        'displayErrorDetails' => false,
        'addContentLengthHeader' => true,
        'routerCacheFile' => false,
    ]

Definition at line 52 of file Container.php.

---

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

• libs/composer/vendor/slim/slim/Slim/Container.php