ilVirusScannerSetupAgent Class Reference

Inheritance diagram for ilVirusScannerSetupAgent:

Collaboration diagram for ilVirusScannerSetupAgent:

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. More...
	getInstallObjective (?Setup\Config $config=null)
	getUpdateObjective (?Setup\Config $config=null)
	getBuildObjective ()
	Get the goal the agent wants to achieve to build artifacts. More...
	getStatusObjective (?Setup\Metrics\Storage $storage)
	getMigrations ()
	Get a named map of migrations available for this Agent. More...
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 25 of file class.ilVirusScannerSetupAgent.php.

Constructor & Destructor Documentation

__construct()

ilVirusScannerSetupAgent::__construct

(

Factory

$refinery

)

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

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

      {
        $this->refinery = $refinery;
    }

Here is the call graph for this function:

Member Function Documentation

getArrayToConfigTransformation()

ilVirusScannerSetupAgent::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 42 of file class.ilVirusScannerSetupAgent.php.

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

                                                    : Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(fn($data): ilVirusScannerSetupConfig => new ilVirusScannerSetupConfig(
            $data['virusscanner'] ?? ilVirusScannerSetupConfig::VIRUS_SCANNER_NONE,
            $data['path_to_scan'] ?? null,
            $data['path_to_clean'] ?? null,
            $data['icap_host'] ?? null,
            $data['icap_port'] ?? null,
            $data['icap_service_name'] ?? null,
            $data['icap_client_path'] ?? null,
        ));
    }

Here is the call graph for this function:

getBuildObjective()

ilVirusScannerSetupAgent::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 69 of file class.ilVirusScannerSetupAgent.php.

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

getInstallObjective()

ilVirusScannerSetupAgent::getInstallObjective

(

?Setup\Config

$config = null

)

Definition at line 55 of file class.ilVirusScannerSetupAgent.php.

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

getMigrations()

ilVirusScannerSetupAgent::getMigrations

(

)

Get a named map of migrations available for this Agent.

Should also return Migrations that have run completely.

Returns

array<string,Migration>|Migration[]

Implements ILIAS\Setup\Agent.

Definition at line 79 of file class.ilVirusScannerSetupAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ilVirusScannerSetupAgent::getStatusObjective

(

?Setup\Metrics\Storage

$storage

)

Definition at line 74 of file class.ilVirusScannerSetupAgent.php.

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

getUpdateObjective()

ilVirusScannerSetupAgent::getUpdateObjective

(

?Setup\Config

$config = null

)

Definition at line 60 of file class.ilVirusScannerSetupAgent.php.

References null.

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

        return new Setup\Objective\NullObjective();
    }

hasConfig()

ilVirusScannerSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 37 of file class.ilVirusScannerSetupAgent.php.

                               : bool
    {
        return true;
    }

Field Documentation

$refinery

Factory ilVirusScannerSetupAgent::$refinery

protected

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

Referenced by __construct().

---

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

• components/ILIAS/VirusScanner/classes/Setup/class.ilVirusScannerSetupAgent.php