ilRPCServerSettings Class Reference

Class for storing all rpc communication settings. More...

Collaboration diagram for ilRPCServerSettings:

Public Member Functions
	isEnabled ()
	Returns true if server ip and port are set. More...
	getServerUrl ()
	getHost ()
	setHost ($a_host)
	getPort ()
	setPort (string $a_port)
	getPath ()
	update ()
	pingServer ()

Static Public Member Functions
static	getInstance ()

Data Fields
string	$rpc_host = ''
string	$rpc_port = ''

Private Member Functions
	__construct ()

Private Attributes
const	RPC_SERVER_PATH = "/RPC2"
ilLogger	$log
ilSetting	$settings

Static Private Attributes
static ilRPCServerSettings	$instance = null

Detailed Description

Class for storing all rpc communication settings.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilRPCServerSettings::__construct ( )

private

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

References $DIC, and ILIAS\Repository\settings().

    {
        global $DIC;

        $this->log = $DIC->logger()->wsrv();
        $this->settings = $DIC->settings();
    }

Here is the call graph for this function:

Member Function Documentation

getHost()

ilRPCServerSettings::getHost

(

)

Definition at line 66 of file class.ilRPCServerSettings.php.

References $rpc_host, and ILIAS\Repository\settings().

Referenced by getServerUrl(), isEnabled(), and update().

                             : string
    {
        if ($this->rpc_host !== '') {
            return $this->rpc_host;
        }
        return $this->rpc_host = (string) $this->settings->get('rpc_server_host');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInstance()

static ilRPCServerSettings::getInstance ( )

static

Definition at line 45 of file class.ilRPCServerSettings.php.

Referenced by ilCertificateActiveValidator\__construct(), ilRpcClientFactory\factory(), and ilRPCServerSettingsTest\testConstruct().

                                        : ilRPCServerSettings
    {
        if (self::$instance) {
            return self::$instance;
        }
        return self::$instance = new ilRPCServerSettings();
    }

Here is the caller graph for this function:

getPath()

ilRPCServerSettings::getPath

(

)

Definition at line 92 of file class.ilRPCServerSettings.php.

                             : string
    {
        return self::RPC_SERVER_PATH;
    }

getPort()

ilRPCServerSettings::getPort

(

)

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

References $rpc_port, and ILIAS\Repository\settings().

Referenced by getServerUrl(), isEnabled(), and update().

                             : string
    {
        if ($this->rpc_port !== '') {
            return $this->rpc_port;
        }
        return $this->rpc_port = (string) $this->settings->get('rpc_server_port');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getServerUrl()

ilRPCServerSettings::getServerUrl

(

)

Definition at line 61 of file class.ilRPCServerSettings.php.

References getHost(), and getPort().

                                  : string
    {
        return 'http://' . $this->getHost() . ':' . $this->getPort() . '/' . self::RPC_SERVER_PATH;
    }

Here is the call graph for this function:

isEnabled()

ilRPCServerSettings::isEnabled

(

)

Returns true if server ip and port are set.

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

References getHost(), and getPort().

                               : bool
    {
        return $this->getHost() !== '' && $this->getPort() !== '';
    }

Here is the call graph for this function:

pingServer()

ilRPCServerSettings::pingServer

(

)

Definition at line 103 of file class.ilRPCServerSettings.php.

References Vendor\Package\$e, and ilRpcClientFactory\factory().

                                : bool
    {
        try {
            ilRpcClientFactory::factory('RPCebug')->ping();
            return true;
        } catch (Exception $e) {
            $this->log->warning('Calling RPC server failed with message: ' . $e->getMessage());
            return false;
        }
    }

Here is the call graph for this function:

setHost()

ilRPCServerSettings::setHost

(

$a_host

)

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

                                    : void
    {
        $this->rpc_host = $a_host;
    }

setPort()

ilRPCServerSettings::setPort

(

string

$a_port

)

Definition at line 87 of file class.ilRPCServerSettings.php.

                                           : void
    {
        $this->rpc_port = $a_port;
    }

update()

ilRPCServerSettings::update

(

)

Definition at line 97 of file class.ilRPCServerSettings.php.

References getHost(), getPort(), and ILIAS\Repository\settings().

                            : void
    {
        $this->settings->set('rpc_server_host', $this->getHost());
        $this->settings->set('rpc_server_port', $this->getPort());
    }

Here is the call graph for this function:

Field Documentation

$instance

ilRPCServerSettings ilRPCServerSettings::$instance = null

staticprivate

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

$log

ilLogger ilRPCServerSettings::$log

private

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

$rpc_host

string ilRPCServerSettings::$rpc_host = ''

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

Referenced by getHost().

$rpc_port

string ilRPCServerSettings::$rpc_port = ''

Definition at line 32 of file class.ilRPCServerSettings.php.

Referenced by getPort().

$settings

ilSetting ilRPCServerSettings::$settings

private

Definition at line 35 of file class.ilRPCServerSettings.php.

RPC_SERVER_PATH

const ilRPCServerSettings::RPC_SERVER_PATH = "/RPC2"

private

Definition at line 27 of file class.ilRPCServerSettings.php.

---

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

• components/ILIAS/WebServices/RPC/classes/class.ilRPCServerSettings.php