ilLoggingSetupAgent Class Reference

Inheritance diagram for ilLoggingSetupAgent:

Collaboration diagram for ilLoggingSetupAgent:

Public Member Functions
	__construct (Factory $refinery)
	hasConfig ()
	Does this agent require a configuration? More...
	getArrayToConfigTransformation ()
	Agents must be able to tell how to create a configuration from a nested array. Exceptions LogicException if Agent has no Config More...
	getInstallObjective (Config $config=null)
	getUpdateObjective (Config $config=null)
	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. Exceptions InvalidArgumentException if Config does not match the Agent. More...
	getStatusObjective (Storage $storage)
	getMigrations ()
Public Member Functions inherited from ILIAS\Setup\Agent
	getInstallObjective (Config $config=null)
	Get the goals the agent wants to achieve on setup. More...
	getUpdateObjective (Config $config=null)
	Get the goal the agent wants to achieve on update. More...
	getStatusObjective (Metrics\Storage $storage)
	Get the objective to be achieved when status is requested. More...
	getNamedObjectives (?Config $config=null)
	Gets all named objectives The keys of the returned array are the commands. More...

Protected Attributes
Factory	$refinery

Detailed Description

Definition at line 29 of file class.ilLoggingSetupAgent.php.

Constructor & Destructor Documentation

__construct()

ilLoggingSetupAgent::__construct

(

Factory

$refinery

)

Definition at line 35 of file class.ilLoggingSetupAgent.php.

References $refinery, and ILIAS\Repository\refinery().

    {
        $this->refinery = $refinery;
    }

Here is the call graph for this function:

Member Function Documentation

getArrayToConfigTransformation()

ilLoggingSetupAgent::getArrayToConfigTransformation

(

)

Agents must be able to tell how to create a configuration from a nested array.

Exceptions

LogicException

if Agent has no Config

Implements ILIAS\Setup\Agent.

Definition at line 51 of file class.ilLoggingSetupAgent.php.

References $data, and ILIAS\Repository\refinery().

                                                    : Transformation
    {
        return $this->refinery->custom()->transformation(function ($data) {
            return new \ilLoggingSetupConfig(
                $data["enable"] ?? false,
                $data["path_to_logfile"] ?? null,
                $data["errorlog_dir"] ?? null
            );
        });
    }

Here is the call graph for this function:

getBuildObjective()

ilLoggingSetupAgent::getBuildObjective

(

)

Get the goal the agent wants to achieve to build artifacts.

Exceptions

InvalidArgumentException

if Config does not match the Agent.

Implements ILIAS\Setup\Agent.

Definition at line 92 of file class.ilLoggingSetupAgent.php.

                                       : Objective
    {
        return new Setup\Objective\NullObjective();
    }

getInstallObjective()

ilLoggingSetupAgent::getInstallObjective

(

Config

$config = null

)

Definition at line 65 of file class.ilLoggingSetupAgent.php.

                                                              : Objective
    {
        return new ilLoggingConfigStoredObjective($config);
    }

getMigrations()

ilLoggingSetupAgent::getMigrations

(

)

Implements ILIAS\Setup\Agent.

Definition at line 113 of file class.ilLoggingSetupAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ilLoggingSetupAgent::getStatusObjective

(

Storage

$storage

)

Definition at line 100 of file class.ilLoggingSetupAgent.php.

                                                        : Objective
    {
        return new Setup\ObjectiveCollection(
            'Component Logging',
            true,
            new ilLoggingMetricsCollectedObjective($storage),
            new ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new ilLoggingUpdateSteps8())
        );
    }

getUpdateObjective()

ilLoggingSetupAgent::getUpdateObjective

(

Config

$config = null

)

Definition at line 73 of file class.ilLoggingSetupAgent.php.

                                                             : Objective
    {
        $objective = new Setup\Objective\NullObjective();
        if ($config !== null) {
            $objective = new ilLoggingConfigStoredObjective($config);
        }
        return new ILIAS\Setup\ObjectiveCollection(
            'Update of Services/Logging',
            false,
            $objective,
            new ilDatabaseUpdateStepsExecutedObjective(
                new ilLoggingUpdateSteps8()
            )
        );
    }

hasConfig()

ilLoggingSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 43 of file class.ilLoggingSetupAgent.php.

                               : bool
    {
        return true;
    }

Field Documentation

$refinery

Factory ilLoggingSetupAgent::$refinery

protected

Definition at line 33 of file class.ilLoggingSetupAgent.php.

Referenced by __construct().

---

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

• components/ILIAS/Logging/classes/Setup/class.ilLoggingSetupAgent.php