ILIAS\WebServices\Setup\WebServicesMetricsCollectedObjective Class Reference

Inheritance diagram for ILIAS\WebServices\Setup\WebServicesMetricsCollectedObjective:

Collaboration diagram for ILIAS\WebServices\Setup\WebServicesMetricsCollectedObjective:

Protected Member Functions
	getTentativePreconditions (Setup\Environment $environment)
	Give preconditions that might or might not be fullfilled. More...
	collectFrom (Setup\Environment $environment, Setup\Metrics\Storage $storage)
	Attempt to gather metrics based on the provided environment. More...
	collectFrom (Setup\Environment $environment, Storage $storage)
	Attempt to gather metrics based on the provided environment. More...
	getTentativePreconditions (Setup\Environment $environment)
	Give preconditions that might or might not be fullfilled. More...

Additional Inherited Members
Public Member Functions inherited from ILIAS\Setup\Metrics\CollectedObjective
	__construct (Storage $storage)
	getHash ()
	Get a hash for this objective. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	Get to know if this is an interesting objective for a human. More...
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)
Public Member Functions inherited from ILIAS\Setup\Objective
	getHash ()
	Get a hash for this objective. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	Get to know if this is an interesting objective for a human. More...
	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...
Protected Attributes inherited from ILIAS\Setup\Metrics\CollectedObjective
Storage	$storage

Detailed Description

Definition at line 25 of file WebServicesMetricsCollectedObjective.php.

Member Function Documentation

collectFrom()

ILIAS\WebServices\Setup\WebServicesMetricsCollectedObjective::collectFrom ( Setup\Environment  $environment, Setup\Metrics\Storage  $storage  )

protected

Attempt to gather metrics based on the provided environment.

Make sure to be very cautious regarding expectations towards the environment. It might only be initialized partially or not be initialized at all, since preconditions might not have been met. This should be implemented with a best effort approach to gather as much metrics as possible even when the installation is damaged.

Reimplemented from ILIAS\Setup\Metrics\CollectedObjective.

Definition at line 34 of file WebServicesMetricsCollectedObjective.php.

                                                                                                  : void
    {
        $factory = $environment->getResource(Setup\Environment::RESOURCE_SETTINGS_FACTORY);
        $settings = $factory->settingsFor('common');
 
        $is_soap_enabled = (bool) $settings->get('soap_user_administration', '0');
        $storage->storeConfigBool(
            'soap_user_administration',
            $is_soap_enabled,
            'SOAP user administration enabled.'
        );
 
        if ($is_soap_enabled) {
            $storage->storeConfigText(
                'soap_wsdl_path',
                $settings->get('soap_wsdl_path', ''),
                'Path to SOAP WSDL file.'
            );
 
            $storage->storeConfigText(
                'soap_connect_timeout',
                $settings->get('soap_connect_timeout', ''),
                'SOAP connection timeout in seconds.'
            );
 
            $storage->storeConfigText(
                'soap_response_timeout',
                $settings->get('soap_response_timeout', ''),
                'SOAP response timeout in seconds.'
            );
 
            $storage->storeConfigText(
                'soap_internal_wsdl_path',
                $settings->get('soap_internal_wsdl_path', ''),
                'Path to internal SOAP WSDL file.'
            );
 
            $storage->storeConfigBool(
                'soap_internal_wsdl_verify_peer',
                (bool) $settings->get('soap_internal_wsdl_verify_peer', '1'),
                'Verify SSL peer for internal WSDL.'
            );
 
            $storage->storeConfigBool(
                'soap_internal_wsdl_verify_peer_name',
                (bool) $settings->get('soap_internal_wsdl_verify_peer_name', '1'),
                'Verify SSL peer name for internal WSDL.'
            );
 
            $storage->storeConfigBool(
                'soap_internal_wsdl_allow_self_signed',
                (bool) $settings->get('soap_internal_wsdl_allow_self_signed', '0'),
                'Allow self-signed certificates for internal WSDL.'
            );
        }
 
        $storage->storeConfigText(
            'rpc_server_host',
            $settings->get('rpc_server_host', ''),
            'RPC server host address.'
        );
 
        $storage->storeConfigText(
            'rpc_server_port',
            $settings->get('rpc_server_port', ''),
            'RPC server port.'
        );
    }

References ILIAS\Setup\Metrics\CollectedObjective\$storage, ILIAS\Setup\Environment\RESOURCE_SETTINGS_FACTORY, ILIAS\Setup\Metrics\Storage\storeConfigBool(), and ILIAS\Setup\Metrics\Storage\storeConfigText().

Here is the call graph for this function:

getTentativePreconditions()

ILIAS\WebServices\Setup\WebServicesMetricsCollectedObjective::getTentativePreconditions ( Setup\Environment  $environment )

protected

Give preconditions that might or might not be fullfilled.

Since collection of metrics should also work in (partially) broken installations the preconditions given here will only be tentatively fullfilled when collectFrom is called.

Returns

Setup\Objective[]

Reimplemented from ILIAS\Setup\Metrics\CollectedObjective.

Definition at line 27 of file WebServicesMetricsCollectedObjective.php.

                                                                                : array
    {
        return [
            new \ilSettingsFactoryExistsObjective()
        ];
    }

---

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

• components/ILIAS/WebServices/classes/Setup/WebServicesMetricsCollectedObjective.php