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

	$err = 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 56 of file class.ilRPCServerSettings.php.

    {
        global $ilLog,$ilDB,$ilError,$ilias;
 
        $this->log =&$ilLog;
        $this->db =&$ilDB;
        $this->err =&$ilError;
        $this->ilias =&$ilias;
    }

References $ilDB, and $ilLog.

Member Function Documentation

◆ getHost()

ilRPCServerSettings::getHost ( )

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

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

References $rpc_host.

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

Here is the caller graph for this function:

◆ getInstance()

static ilRPCServerSettings::getInstance ( )

static

Get singelton instance.

Returns: object $ilRPCServerSettings

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

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

References $instance.

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

Here is the caller graph for this function:

◆ getPath()

ilRPCServerSettings::getPath ( )

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

    {
        return RPC_SERVER_PATH;
    }

References RPC_SERVER_PATH.

◆ getPort()

ilRPCServerSettings::getPort ( )

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

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

References $rpc_port.

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

Here is the caller graph for this function:

◆ getServerUrl()

ilRPCServerSettings::getServerUrl ( )

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

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

References getHost(), getPort(), and 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 82 of file class.ilRPCServerSettings.php.

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

References getHost(), and getPort().

Here is the call graph for this function:

◆ pingServer()

ilRPCServerSettings::pingServer ( )

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

    {
        include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
        
        try {
            ilRpcClientFactory::factory('RPCebug')->ping();
            return true;
        } catch (Exception $e) {
            $ilLog->write(__METHOD__ . ': ' . $e->getMessage());
            return false;
        }
    }

References $ilLog, and ilRpcClientFactory\factory().

Here is the call graph for this function:

◆ setHost()

ilRPCServerSettings::setHost ( $a_host )

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

    {
        $this->rpc_host = $a_host;
    }

◆ setPort()

ilRPCServerSettings::setPort ( $a_port )

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

    {
        $this->rpc_port = $a_port;
    }

◆ update()

ilRPCServerSettings::update ( )

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

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