ilRPCServerSettings Class Reference

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 ($a_port)
	getPath ()
	update ()
	pingServer ()

Static Public Member Functions
static	getInstance ()
	Get singelton instance. More...

Data Fields
	$rpc_host = ''
	$rpc_port = ''
	$log = null
	$db = null
	$settings_obj = null

Private Member Functions
	__construct ()
	Singleton contructor. More...

Static Private Attributes
static	$instance = null

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilRPCServerSettings::__construct ( )

private

Singleton contructor.

Returns

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

References $DIC, and $ilDB.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $ilias = $DIC['ilias'];

        $this->log = $DIC->logger()->wsrv();
        $this->db = $ilDB;
        $this->ilias = $ilias;
    }

Member Function Documentation

getHost()

ilRPCServerSettings::getHost

(

)

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

References $rpc_host.

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

    {
        if (strlen($this->rpc_host)) {
            return $this->rpc_host;
        }
        return $this->rpc_host = $this->ilias->getSetting('rpc_server_host');
    }

Here is the caller graph for this function:

getInstance()

static ilRPCServerSettings::getInstance ( )

static

Get singelton instance.

Returns

object $ilRPCServerSettings

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

Referenced by ilCertificateActiveValidator\__construct(), ilRpcClientFactory\factory(), ilSurveyEditorGUI\printViewObject(), and ilObjSearchSettingsGUI\saveSettingsObject().

    {
        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 116 of file class.ilRPCServerSettings.php.

References RPC_SERVER_PATH.

    {
        return RPC_SERVER_PATH;
    }

getPort()

ilRPCServerSettings::getPort

(

)

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

References $rpc_port.

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

    {
        if (strlen($this->rpc_port)) {
            return $this->rpc_port;
        }
        return $this->rpc_port = $this->ilias->getSetting('rpc_server_port');
    }

Here is the caller graph for this function:

getServerUrl()

ilRPCServerSettings::getServerUrl

(

)

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

References getHost(), getPort(), and RPC_SERVER_PATH.

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

Here is the call graph for this function:

isEnabled()

ilRPCServerSettings::isEnabled

(

)

Returns true if server ip and port are set.

Returns

bool

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

References getHost(), and getPort().

    {
        return strlen($this->getHost()) and strlen($this->getPort());
    }

Here is the call graph for this function:

pingServer()

ilRPCServerSettings::pingServer

(

)

Returns

bool

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

References ilRpcClientFactory\factory().

    {
        include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
        
        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 101 of file class.ilRPCServerSettings.php.

    {
        $this->rpc_host = $a_host;
    }

setPort()

ilRPCServerSettings::setPort

(

$a_port

)

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

    {
        $this->rpc_port = $a_port;
    }

update()

ilRPCServerSettings::update

(

)

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

References getHost(), and getPort().

    {
        $this->ilias->setSetting('rpc_server_host', $this->getHost());
        $this->ilias->setSetting('rpc_server_port', $this->getPort());
        
        return true;
    }

Here is the call graph for this function:

Field Documentation

$db

ilRPCServerSettings::$db = null

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

$instance

ilRPCServerSettings::$instance = null

staticprivate

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

$log

ilRPCServerSettings::$log = null

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

$rpc_host

ilRPCServerSettings::$rpc_host = ''

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

Referenced by getHost().

$rpc_port

ilRPCServerSettings::$rpc_port = ''

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

Referenced by getPort().

$settings_obj

ilRPCServerSettings::$settings_obj = null

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

---

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

• Services/WebServices/RPC/classes/class.ilRPCServerSettings.php