ilStyleSetupAgent Class Reference

Inheritance diagram for ilStyleSetupAgent:

Collaboration diagram for ilStyleSetupAgent:

Public Member Functions
	__construct (Refinery\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 (?Setup\Config $config=null)
	getUpdateObjective (?Setup\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 (Setup\Metrics\Storage $storage)
	getMigrations ()
	getNamedObjectives (?Setup\Config $config=null)
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
	$refinery

Detailed Description

Definition at line 24 of file class.ilStyleSetupAgent.php.

Constructor & Destructor Documentation

__construct()

ilStyleSetupAgent::__construct

(

Refinery\Factory

$refinery

)

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

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

      {
        $this->refinery = $refinery;
    }

Here is the call graph for this function:

Member Function Documentation

getArrayToConfigTransformation()

ilStyleSetupAgent::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 50 of file class.ilStyleSetupAgent.php.

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

                                                    : Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(function ($data) {
            return new \ilStyleSetupConfig(
                $data["manage_system_styles"] ?? false,
                $data["path_to_scss"] ?? null
            );
        });
    }

Here is the call graph for this function:

getBuildObjective()

ilStyleSetupAgent::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 82 of file class.ilStyleSetupAgent.php.

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

getInstallObjective()

ilStyleSetupAgent::getInstallObjective

(

?Setup\Config

$config = null

)

Definition at line 63 of file class.ilStyleSetupAgent.php.

                                                                     : Setup\Objective
    {
        return new ilStyleConfigStoredObjective($config);
    }

getMigrations()

ilStyleSetupAgent::getMigrations

(

)

Implements ILIAS\Setup\Agent.

Definition at line 98 of file class.ilStyleSetupAgent.php.

                                   : array
    {
        return [
            new ilStyleIRSSMigration()
        ];
    }

getNamedObjectives()

ilStyleSetupAgent::getNamedObjectives

(

?Setup\Config

$config = null

)

Definition at line 105 of file class.ilStyleSetupAgent.php.

                                                                    : array
    {
        return [
            'buildUIFrameworkExampleTestCases.update' => new Setup\ObjectiveConstructor(
                'builds an import file for testrail for all KNOWN ids.',
                fn() => new ilUITestRailExampleTestCasesObjective(false)
            ),

            'buildUIFrameworkExampleTestCases.new' => new Setup\ObjectiveConstructor(
                'builds an import file for testrail with ONLY NEW cases.',
                fn() => new ilUITestRailExampleTestCasesObjective(true)
            ),


        ];
    }

getStatusObjective()

ilStyleSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 90 of file class.ilStyleSetupAgent.php.

                                                                      : Setup\Objective
    {
        return new ilStyleMetricsCollectedObjective($storage);
    }

getUpdateObjective()

ilStyleSetupAgent::getUpdateObjective

(

?Setup\Config

$config = null

)

Definition at line 71 of file class.ilStyleSetupAgent.php.

References null.

                                                                    : Setup\Objective
    {
        if ($config !== null) {
            return new ilStyleConfigStoredObjective($config);
        }
        return new Setup\Objective\NullObjective();
    }

hasConfig()

ilStyleSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 42 of file class.ilStyleSetupAgent.php.

                               : bool
    {
        return true;
    }

Field Documentation

$refinery

ilStyleSetupAgent::$refinery

protected

Definition at line 31 of file class.ilStyleSetupAgent.php.

Referenced by __construct().

---

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

• components/ILIAS/Style/classes/Setup/class.ilStyleSetupAgent.php