ILIAS\Setup\ArrayEnvironment Class Reference

Inheritance diagram for ILIAS\Setup\ArrayEnvironment:

Collaboration diagram for ILIAS\Setup\ArrayEnvironment:

Public Member Functions
	__construct (array $resources)
	getResource (string $id)
	Consumers of this method should check if the result is what they expect, e.g.implements some known interface. Returns mixed|null More...
	withResource (string $id, $resource)
	Exceptions RuntimeException if this resource is already in the environment. More...
	withConfigFor (string $component, $config)
	Stores a config for some component in the environment. Exceptions RuntimeException if this config is already in the environment. More...
	getConfigFor (string $component)
	Exceptions RuntimeException if there is no config for the component Returns mixed More...
	hasConfigFor (string $component)
	getResource (string $id)
	Consumers of this method should check if the result is what they expect, e.g. More...
	withResource (string $id, $resource)
	withConfigFor (string $component, $config)
	Stores a config for some component in the environment. More...
	getConfigFor (string $component)
	hasConfigFor (string $component)

Protected Attributes
	$resources
	$configs

Additional Inherited Members
Data Fields inherited from ILIAS\Setup\Environment
const	RESOURCE_DATABASE = "resource_database"
const	RESOURCE_ADMIN_INTERACTION = "resource_admin_interaction"
const	RESOURCE_ILIAS_INI = "resource_ilias_ini"
const	RESOURCE_CLIENT_INI = "resource_client_ini"
const	RESOURCE_SETTINGS_FACTORY = "resource_settings_factory"
const	RESOURCE_CLIENT_ID = "resource_client_id"
const	RESOURCE_PLUGIN_ADMIN = "resource_plugin_admin"

Detailed Description

Definition at line 9 of file ArrayEnvironment.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Setup\ArrayEnvironment::__construct

(

array

$resources

)

Definition at line 21 of file ArrayEnvironment.php.

    {
        $this->resources = $resources;
    }

References ILIAS\Setup\ArrayEnvironment\$resources.

Member Function Documentation

getConfigFor()

ILIAS\Setup\ArrayEnvironment::getConfigFor

(

string

$component

)

Exceptions

RuntimeException if there is no config for the component

Returns

mixed

Implements ILIAS\Setup\Environment.

Definition at line 70 of file ArrayEnvironment.php.

    {
        if (!isset($this->configs[$component])) {
            throw new \RuntimeException(
                "Config for '$component' is not contained in the environment"
            );
        }
        return $this->configs[$component];
    }

getResource()

ILIAS\Setup\ArrayEnvironment::getResource

(

string

$id

)

Consumers of this method should check if the result is what they expect, e.g.implements some known interface.

Returns

mixed|null

Implements ILIAS\Setup\Environment.

Definition at line 29 of file ArrayEnvironment.php.

    {
        if (!isset($this->resources[$id])) {
            return null;
        }
        return $this->resources[$id];
    }

hasConfigFor()

ILIAS\Setup\ArrayEnvironment::hasConfigFor

(

string

$component

)

Implements ILIAS\Setup\Environment.

Definition at line 83 of file ArrayEnvironment.php.

                                                    : bool
    {
        return isset($this->configs[$component]);
    }

withConfigFor()

ILIAS\Setup\ArrayEnvironment::withConfigFor	(	string	$component,
			$config
	)

Stores a config for some component in the environment.

Exceptions

RuntimeException if this config is already in the environment.

Implements ILIAS\Setup\Environment.

Definition at line 55 of file ArrayEnvironment.php.

                                                              : Environment
    {
        if (isset($this->configs[$component])) {
            throw new \RuntimeException(
                "Config for '$component' is already contained in the environment"
            );
        }
        $clone = clone $this;
        $clone->configs[$component] = $config;
        return $clone;
    }

References $config.

withResource()

ILIAS\Setup\ArrayEnvironment::withResource	(	string	$id,
			$resource
	)

Exceptions

RuntimeException if this resource is already in the environment.

Implements ILIAS\Setup\Environment.

Definition at line 40 of file ArrayEnvironment.php.

                                                        : Environment
    {
        if (isset($this->resources[$id])) {
            throw new \RuntimeException(
                "Resource '$id' is already contained in the environment"
            );
        }
        $clone = clone $this;
        $clone->resources[$id] = $resource;
        return $clone;
    }

Field Documentation

$configs

ILIAS\Setup\ArrayEnvironment::$configs

protected

Definition at line 19 of file ArrayEnvironment.php.

$resources

ILIAS\Setup\ArrayEnvironment::$resources

protected

Definition at line 14 of file ArrayEnvironment.php.

Referenced by ILIAS\Setup\ArrayEnvironment\__construct().

---

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

• src/Setup/ArrayEnvironment.php