Inheritance diagram for ilChatroomSetupAgent:

Collaboration diagram for ilChatroomSetupAgent:

Public Member Functions
	__construct (Refinery\Factory $refinery)

	hasConfig ()

	getConfigInput (Setup\Config $config=null)

	getArrayToConfigTransformation ()

	getInstallObjective (Setup\Config $config=null)

	getUpdateObjective (Setup\Config $config=null)

	getBuildArtifactObjective ()

	getStatusObjective (Setup\Metrics\Storage $storage)

	getMigrations ()
	@inheritDoc More...

Data Fields
const	PORT_MIN = 1

const	PORT_MAX = 65535

Static Public Attributes
static	$LOG_LEVELS

static	$INTERVALS

Protected Attributes
	$refinery

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilChatroomSetupAgent::__construct ( Refinery\Factory $refinery )

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

    {
        $this->refinery = $refinery;
    }

References $refinery.

Member Function Documentation

◆ getArrayToConfigTransformation()

ilChatroomSetupAgent::getArrayToConfigTransformation ( )

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

                                                     : Refinery\Transformation
    {
        $levels = self::$LOG_LEVELS;
        $intervals = self::$INTERVALS;
        // TODO: clean this up
        return $this->refinery->custom()->transformation(function ($data) use ($levels, $intervals) {
            if (is_null($data)) {
                return new Setup\NullConfig();
            }
 
            $protocol = 'http';
            if (isset($data['https']) && count($data['https']) > 0) {
                $protocol = 'https';
            }
 
            $deletion_interval = false;
            if (isset($data['deletion_interval']) && count($data['deletion_interval']) > 0) {
                $deletion_interval = true;
            }
 
            $ilias_proxy = false;
            if (isset($data['ilias_proxy']) && count($data['ilias_proxy']) > 0) {
                $ilias_proxy = true;
            }
 
            $client_proxy = false;
            if (isset($data['client_proxy']) && count($data['client_proxy']) > 0) {
                $client_proxy = true;
            }
 
            if (!is_null($data['port']) && (int) $data['port'] < self::PORT_MIN || (int) $data['port'] > self::PORT_MAX) {
                throw new InvalidArgumentException(
                    $data['port'] . ' is not a valid value for port. Please check your config file.'
                );
            }
 
            if ($data['log'] != '') {
                if (!in_array($data['log_level'], $levels)) {
                    throw new InvalidArgumentException(
                        $data['log_level'] . ' is not a valid value for log_level. Please check your config file.'
                    );
                }
            }
 
            if ($deletion_interval) {
                if (!in_array($data['deletion_interval']['deletion_unit'], $intervals)) {
                    throw new InvalidArgumentException(
                        $data['deletion_interval']['deletion_unit'] . ' is not a valid value for deletion_unit. Please check your config file.'
                    );
                }
                if (!is_numeric($data['deletion_interval']['deletion_value'])) {
                    throw new InvalidArgumentException(
                        $data['deletion_interval']['deletion_value'] . ' is not a valid value for deletion_value. Please check your config file.'
                    );
                }
                if (!preg_match_all('/([01][0-9]|[2][0-3]):[0-5][0-9]/', $data['deletion_interval']['deletion_time'])) {
                    throw new InvalidArgumentException(
                        $data['deletion_interval']['deletion_time'] . ' is not a valid value for deletion_time. Please check your config file.'
                    );
                }
            }
 
            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'] ?? ''
            );
        });
    }

References $data, $INTERVALS, and $LOG_LEVELS.

◆ getBuildArtifactObjective()

ilChatroomSetupAgent::getBuildArtifactObjective ( )

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

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

◆ getConfigInput()

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

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

                                                                : UI\Component\Input\Field\Input
    {
        throw new \LogicException("Not yet implemented.");
    }

◆ getInstallObjective()

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

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

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

References $config.

◆ getMigrations()

ilChatroomSetupAgent::getMigrations ( )

@inheritDoc

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

                                    : array
    {
        return [];
    }

◆ getStatusObjective()

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

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

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

◆ getUpdateObjective()

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

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

                                                                    : Setup\Objective
    {
        // null would be valid here, because our user might just not have passed
        // one during update.
        if ($config === null || $config instanceof Setup\NullConfig) {
            return new Setup\Objective\NullObjective();
        }
 
        return new ilChatroomServerConfigStoredObjective($config);
    }

References $config.

◆ hasConfig()

ilChatroomSetupAgent::hasConfig ( )

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

                                : bool
    {
        return true;
    }

Field Documentation

◆ $INTERVALS

ilChatroomSetupAgent::$INTERVALS

static

Initial value:

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

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

Referenced by getArrayToConfigTransformation().

◆ $LOG_LEVELS

ilChatroomSetupAgent::$LOG_LEVELS

static

Initial value:

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

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

Referenced by getArrayToConfigTransformation().

◆ $refinery

ilChatroomSetupAgent::$refinery

protected

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

Referenced by __construct().

◆ PORT_MAX

const ilChatroomSetupAgent::PORT_MAX = 65535

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

◆ PORT_MIN

const ilChatroomSetupAgent::PORT_MIN = 1

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

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

Modules/Chatroom/classes/Setup/class.ilChatroomSetupAgent.php

Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes