Inheritance diagram for ilChatroomSetupAgent:

Collaboration diagram for ilChatroomSetupAgent:

Public Member Functions
	__construct (protected Refinery\Factory $refinery)

	hasConfig ()
	Does this agent require a configuration? More...

	getConfigInput (Setup\Config $config=null)

	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...

Static Public Attributes
static array	$LOG_LEVELS

static array	$INTERVALS

Private Attributes
const	PORT_MIN = 1

const	PORT_MAX = 65535

Detailed Description

Definition at line 26 of file class.ilChatroomSetupAgent.php.

Constructor & Destructor Documentation

◆ __construct()

ilChatroomSetupAgent::__construct ( protected Refinery\Factory $refinery )

Definition at line 54 of file class.ilChatroomSetupAgent.php.

55 {

56 }

Member Function Documentation

◆ getArrayToConfigTransformation()

ilChatroomSetupAgent::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 68 of file class.ilChatroomSetupAgent.php.

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

                                                     : Refinery\Transformation
     {
         $levels = self::$LOG_LEVELS;
         $intervals = self::$INTERVALS;
 
         return $this->refinery->custom()->transformation(static function ($data) use (
             $levels,
             $intervals
         ): Setup\Config {
             if (is_null($data)) {
                 return new Setup\NullConfig();
             }
 
             $protocol = 'http';
             if (isset($data['https']) && is_array($data['https']) && $data['https'] !== []) {
                 $protocol = 'https';
             }
 
             $deletion_interval = false;
             if (
                 isset($data['deletion_interval']) &&
                 is_array($data['deletion_interval']) && $data['deletion_interval'] !== []
             ) {
                 $deletion_interval = true;
             }
 
             $ilias_proxy = false;
             if (isset($data['ilias_proxy']) && is_array($data['ilias_proxy']) && $data['ilias_proxy'] !== []) {
                 $ilias_proxy = true;
             }
 
             $client_proxy = false;
             if (isset($data['client_proxy']) && is_array($data['client_proxy']) && $data['client_proxy'] !== []) {
                 $client_proxy = true;
             }
 
             if (isset($data['address']) && !is_string($data['address'])) {
                 throw new InvalidArgumentException(sprintf(
                     '%s is not a valid value for address (must be a string). Please check your config file.',
                     $data['address'],
                 ));
             }
 
             if (
                 isset($data['port']) && (
                     !is_numeric($data['port']) ||
                     ((int) $data['port'] < self::PORT_MIN || (int) $data['port'] > self::PORT_MAX)
                 )
             ) {
                 throw new InvalidArgumentException(sprintf(
                     '%s is not a valid value for port (must be between %s and %s). Please check your config file.',
                     $data['port'] ?? '',
                     self::PORT_MIN,
                     self::PORT_MAX
                 ));
             }
 
             if (isset($data['sub_directory']) && !is_string($data['sub_directory'])) {
                 throw new InvalidArgumentException(sprintf(
                     '%s is not a valid value for sub_directory (must be a string). Please check your config file.',
                     $data['sub_directory'],
                 ));
             }
 
             if (isset($data['log']) && !is_string($data['log'])) {
                 throw new InvalidArgumentException(sprintf(
                     '%s is not a valid value for log (must be a string). Please check your config file.',
                     $data['log'],
                 ));
             }
 
             if (isset($data['error_log']) && !is_string($data['error_log'])) {
                 throw new InvalidArgumentException(sprintf(
                     '%s is not a valid value for error_log (must be a string). Please check your config file.',
                     $data['error_log'],
                 ));
             }
 
             if (
                 isset($data['log']) && $data['log'] !== '' &&
                 !in_array((string) ($data['log_level'] ?? ''), $levels, true)
             ) {
                 throw new InvalidArgumentException(sprintf(
                     '%s is not a valid value for log_level (must be one of: %s). Please check your config file.',
                     $data['log_level'] ?? '',
                     implode(', ', $levels)
                 ));
             }
 
             if ($deletion_interval) {
                 if (!in_array($data['deletion_interval']['deletion_unit'] ?? null, $intervals, true)) {
                     throw new InvalidArgumentException(sprintf(
                         '%s is not a valid value for deletion_unit (must be one of: %s). Please check your config file.',
                         $data['deletion_interval']['deletion_unit'] ?? '',
                         implode(', ', $intervals)
                     ));
                 }
                 if (
                     !isset($data['deletion_interval']['deletion_value']) ||
                     !is_numeric($data['deletion_interval']['deletion_value'])
                 ) {
                     throw new InvalidArgumentException(sprintf(
                         '%s is not a valid value for deletion_value. Please check your config file.',
                         $data['deletion_interval']['deletion_value'] ?? ''
                     ));
                 }
                 if (
                     !isset($data['deletion_interval']['deletion_time']) ||
                     !is_string($data['deletion_interval']['deletion_time']) ||
                     !preg_match('/([01][0-9]|[2][0-3]):[0-5][0-9]/', $data['deletion_interval']['deletion_time'])
                 ) {
                     throw new InvalidArgumentException(sprintf(
                         '%s is not a valid value for deletion_time. Please check your config file.',
                         $data['deletion_interval']['deletion_time'] ?? ''
                     ));
                 }
             }
 
             return new ilChatroomSetupConfig(
                 $data['address'] ?? '',
                 (int) ($data['port'] ?? 0),
                 $data['sub_directory'] ?? '',
                 $protocol,
                 $data['https']['cert'] ?? '',
                 $data['https']['key'] ?? '',
                 $data['https']['dhparam'] ?? '',
                 $data['log'] ?? '',
                 $data['log_level'] ?? '',
                 $data['error_log'] ?? '',
                 $ilias_proxy,
                 $data['ilias_proxy']['ilias_url'] ?? '',
                 $client_proxy,
                 $data['client_proxy']['client_url'] ?? '',
                 $deletion_interval,
                 $data['deletion_interval']['deletion_unit'] ?? '',
                 (int) ($data['deletion_interval']['deletion_value'] ?? 0),
                 $data['deletion_interval']['deletion_time'] ?? ''
             );
         });
     }

Here is the call graph for this function:

◆ getBuildObjective()

ilChatroomSetupAgent::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 235 of file class.ilChatroomSetupAgent.php.

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

◆ getConfigInput()

ilChatroomSetupAgent::getConfigInput ( Setup\Config $config = null )

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

                                                                : never
     {
         throw new LogicException("Not yet implemented.");
     }

◆ getInstallObjective()

ilChatroomSetupAgent::getInstallObjective ( Setup\Config $config = null )

Definition at line 209 of file class.ilChatroomSetupAgent.php.

                                                                     : Setup\Objective
     {
         // null would not be valid here, because this agents strictly wants to have
         // a config.
         if ($config === null || $config instanceof Setup\NullConfig) {
             return new Setup\Objective\NullObjective();
         }
 
         return new ilChatroomServerConfigStoredObjective($config);
     }

◆ getMigrations()

ilChatroomSetupAgent::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 250 of file class.ilChatroomSetupAgent.php.

                                    : array
     {
         return [];
     }

◆ getStatusObjective()

ilChatroomSetupAgent::getStatusObjective ( Setup\Metrics\Storage $storage )

Definition at line 240 of file class.ilChatroomSetupAgent.php.

                                                                       : Setup\Objective
     {
         return new Setup\ObjectiveCollection(
             'Component Chatroom',
             true,
             new ilChatroomMetricsCollectedObjective($storage),
             new ilDatabaseUpdateStepsMetricsCollectedObjective($storage, new UpdateSteps())
         );
     }

◆ getUpdateObjective()

ilChatroomSetupAgent::getUpdateObjective ( Setup\Config $config = null )

Definition at line 220 of file class.ilChatroomSetupAgent.php.

References $objectives.

                                                                    : Setup\Objective
     {
         $objectives = [
             new ilDatabaseUpdateStepsExecutedObjective(new UpdateSteps())
         ];
 
         // null would be valid here, because our user might just not have passed
         // one during update.
         if ($config !== null && !($config instanceof Setup\NullConfig)) {
             $objectives[] = new ilChatroomServerConfigStoredObjective($config);
         }
 
         return new ObjectiveCollection('Update chatroom database and server config', false, ...$objectives);
     }

◆ hasConfig()

ilChatroomSetupAgent::hasConfig ( )

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 58 of file class.ilChatroomSetupAgent.php.

                                : bool
     {
         return true;
     }

Field Documentation

◆ $INTERVALS

array ilChatroomSetupAgent::$INTERVALS

static

Initial value:

= [
        'days',
        'weeks',
        'months',
        'years'
    ]

Definition at line 47 of file class.ilChatroomSetupAgent.php.

◆ $LOG_LEVELS

array ilChatroomSetupAgent::$LOG_LEVELS

static

Initial value:

= [
        'emerg',
        'alert',
        'crit',
        'error',
        'warning',
        'notice',
        'info',
        'debug',
        'silly'
    ]

Definition at line 34 of file class.ilChatroomSetupAgent.php.

◆ PORT_MAX

const ilChatroomSetupAgent::PORT_MAX = 65535

private

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

◆ PORT_MIN

const ilChatroomSetupAgent::PORT_MIN = 1

private

Definition at line 30 of file class.ilChatroomSetupAgent.php.

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

components/ILIAS/Chatroom/classes/Setup/class.ilChatroomSetupAgent.php

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getArrayToConfigTransformation()

◆ getBuildObjective()

◆ getConfigInput()

◆ getInstallObjective()

◆ getMigrations()

◆ getStatusObjective()

◆ getUpdateObjective()

◆ hasConfig()

Field Documentation

◆ $INTERVALS

◆ $LOG_LEVELS

◆ PORT_MAX

◆ PORT_MIN