ilWebServicesSetupAgent Class Reference

Inheritance diagram for ilWebServicesSetupAgent:

Collaboration diagram for ilWebServicesSetupAgent:

Public Member Functions
	__construct (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. 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 ()
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 Factory	$refinery

Detailed Description

Definition at line 25 of file class.ilWebServicesSetupAgent.php.

Constructor & Destructor Documentation

__construct()

ilWebServicesSetupAgent::__construct

(

Refinery\Factory

$refinery

)

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

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

    {
        $this->refinery = $refinery;
    }

Here is the call graph for this function:

Member Function Documentation

getArrayToConfigTransformation()

ilWebServicesSetupAgent::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 55 of file class.ilWebServicesSetupAgent.php.

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

                                                    : Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(function ($data) {
            return new \ilWebServicesSetupConfig(
                (bool) ($data["soap_user_administration"] ?? false),
                $data["soap_wsdl_path"] ?? "",
                (int) ($data["soap_connect_timeout"] ?? ilSoapClient::DEFAULT_CONNECT_TIMEOUT),
                (int) ($data["soap_response_timeout"] ?? ilSoapClient::DEFAULT_RESPONSE_TIMEOUT),
                $data["rpc_server_host"] ?? "",
                (int) ($data["rpc_server_port"] ?? 0),
                (string) ($data['soap_internal_wsdl_path'] ?? ''),
                (bool) ($data['soap_internal_wsdl_verify_peer'] ?? true),
                (bool) ($data['soap_internal_wsdl_verify_peer_name'] ?? true),
                (bool) ($data['soap_internal_wsdl_allow_self_signed'] ?? false),
            );
        });
    }

Here is the call graph for this function:

getBuildObjective()

ilWebServicesSetupAgent::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 106 of file class.ilWebServicesSetupAgent.php.

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

getConfigInput()

ilWebServicesSetupAgent::getConfigInput

(

Setup\Config

$config = null

)

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

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

getInstallObjective()

ilWebServicesSetupAgent::getInstallObjective

(

Setup\Config

$config = null

)

Definition at line 76 of file class.ilWebServicesSetupAgent.php.

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

getMigrations()

ilWebServicesSetupAgent::getMigrations

(

)

Implements ILIAS\Setup\Agent.

Definition at line 122 of file class.ilWebServicesSetupAgent.php.

                                   : array
    {
        return [];
    }

getStatusObjective()

ilWebServicesSetupAgent::getStatusObjective

(

Setup\Metrics\Storage

$storage

)

Definition at line 114 of file class.ilWebServicesSetupAgent.php.

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

getUpdateObjective()

ilWebServicesSetupAgent::getUpdateObjective

(

Setup\Config

$config = null

)

Definition at line 84 of file class.ilWebServicesSetupAgent.php.

                                                                   : Setup\Objective
    {
        $wsrv_objective = new Setup\Objective\NullObjective();
        if (!is_null($config)) {
            $wsrv_objective = new ilWebServicesConfigStoredObjective($config);
        }
        return new ILIAS\Setup\ObjectiveCollection(
            'Updates of Services/WebServices',
            false,
            $wsrv_objective,
            new ilDatabaseUpdateStepsExecutedObjective(
                new ilECSUpdateSteps8()
            ),
            new ilDatabaseUpdateStepsExecutedObjective(
                new ilSoapWsdlPathUpdateStep()
            )
        );
    }

hasConfig()

ilWebServicesSetupAgent::hasConfig

(

)

Does this agent require a configuration?

Implements ILIAS\Setup\Agent.

Definition at line 39 of file class.ilWebServicesSetupAgent.php.

                               : bool
    {
        return true;
    }

Field Documentation

$refinery

Refinery Factory ilWebServicesSetupAgent::$refinery

protected

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

Referenced by __construct().

---

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

• components/ILIAS/WebServices/classes/Setup/class.ilWebServicesSetupAgent.php