ilProxySettings Class Reference

class ilProxySettings More...

Collaboration diagram for ilProxySettings:

Public Member Functions
	isActive ($status=null)
	Getter/Setter for status. More...
	setHost ($host)
	Setter for host. More...
	getHost ()
	Getter for host. More...
	setPort ($port)
	Setter for port. More...
	getPort ()
	Getter for port. More...
	save ()
	Saves the current data in database. More...
	checkConnection ()
	Verifies the proxy server connection. More...

Static Public Member Functions
static	_getInstance ()
	Getter for unique instance. More...

Data Fields
const	CONNECTION_CHECK_TIMEOUT = 10

Protected Member Functions
	__construct ()
	Constructor. More...
	read ()
	Fetches data from database. More...

Protected Attributes
	$host = ''
	$post = ''
	$isActive = false

Static Protected Attributes
static	$_instance = null

Private Member Functions
	__clone ()
	__clone More...

Detailed Description

class ilProxySettings

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

Definition at line 13 of file class.ilProxySettings.php.

Constructor & Destructor Documentation

__construct()

ilProxySettings::__construct ( )

protected

Constructor.

@access protected

Definition at line 68 of file class.ilProxySettings.php.

    {
        $this->read();
    }

References read().

Here is the call graph for this function:

Member Function Documentation

__clone()

ilProxySettings::__clone ( )

private

__clone

@access private

Definition at line 80 of file class.ilProxySettings.php.

    {
    }

_getInstance()

static ilProxySettings::_getInstance ( )

static

Getter for unique instance.

@access public

Returns

ilProxySettings

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

    {
        if (null === self::$_instance) {
            self::$_instance = new self();
        }
        
        return self::$_instance;
    }

References $_instance.

Referenced by ilExternalFeed\__construct(), ilExternalFeed\_checkUrl(), ilExternalFeed\_determineFeedUrl(), ilCurlConnection\init(), ilObjSystemFolderGUI\printProxyStatus(), ilObjSystemFolderGUI\saveProxyObject(), and ilObjSystemFolderGUI\showProxyObject().

Here is the caller graph for this function:

checkConnection()

ilProxySettings::checkConnection

(

)

Verifies the proxy server connection.

@access public

Returns

ilProxySettings

Exceptions

ilProxyException

Definition at line 224 of file class.ilProxySettings.php.

    {
        global $DIC;
 
        $errno = null;
        $errstr = null;
 
        set_error_handler(function ($severity, $message, $file, $line) {
            throw new ErrorException($message, $severity, $severity, $file, $line);
        });
 
        try {
            $host = $this->getHost();
            if (strspn($host, '.0123456789') != strlen($host) && strstr($host, '/') === false) {
                $host = gethostbyname($host);
            }
            $port = $this->getPort() % 65536;
 
            if (!fsockopen($host, $port, $errno, $errstr, self::CONNECTION_CHECK_TIMEOUT)) {
                restore_error_handler();
                throw new ilProxyException(strlen($errstr) ? $errstr : $DIC->language()->txt('proxy_not_connectable'));
            }
            restore_error_handler();
        } catch (Exception $e) {
            restore_error_handler();
            throw new ilProxyException(strlen($errstr) ? $errstr : $DIC->language()->txt('proxy_not_connectable'));
        }
 
        return $this;
    }

References $DIC, Vendor\Package\$e, $host, $message, getHost(), and getPort().

Here is the call graph for this function:

getHost()

ilProxySettings::getHost

(

)

Getter for host.

@access public

Returns

string

Definition at line 162 of file class.ilProxySettings.php.

    {
        return $this->host;
    }

References $host.

Referenced by checkConnection(), and save().

Here is the caller graph for this function:

getPort()

ilProxySettings::getPort

(

)

Getter for port.

@access public

Returns

string

Definition at line 191 of file class.ilProxySettings.php.

    {
        return $this->port;
    }

Referenced by checkConnection(), and save().

Here is the caller graph for this function:

isActive()

ilProxySettings::isActive

(

$status = null

)

Getter/Setter for status.

@access public

Parameters

mixed

boolean or null

Returns

mixed ilProxySettings or boolean

Definition at line 127 of file class.ilProxySettings.php.

    {
        if (null === $status) {
            return (bool) $this->isActive;
        }
        
        $this->isActive = (bool) $status;
        
        return $this;
    }

References $isActive, and isActive().

Referenced by isActive(), read(), and save().

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilProxySettings::read ( )

protected

Fetches data from database.

@access protected

Definition at line 109 of file class.ilProxySettings.php.

    {
        global $ilSetting;
        
        $this->setHost($ilSetting->get('proxy_host'));
        $this->setPort($ilSetting->get('proxy_port'));
        $this->isActive((bool) $ilSetting->get('proxy_status'));
    }

References $ilSetting, isActive(), setHost(), and setPort().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilProxySettings::save

(

)

Saves the current data in database.

@access public

Returns

ilProxySettings

Definition at line 204 of file class.ilProxySettings.php.

    {
        global $ilSetting;
        
        $ilSetting->set('proxy_host', $this->getHost());
        $ilSetting->set('proxy_port', $this->getPort());
        $ilSetting->set('proxy_status', (int) $this->isActive());
        
        return $this;
    }

References $ilSetting, getHost(), getPort(), and isActive().

Here is the call graph for this function:

setHost()

ilProxySettings::setHost

(

$host

)

Setter for host.

@access public

Parameters

string

Returns

ilProxySettings

Definition at line 147 of file class.ilProxySettings.php.

    {
        $this->host = $host;
        
        return $this;
    }

References $host.

Referenced by read().

Here is the caller graph for this function:

setPort()

ilProxySettings::setPort

(

$port

)

Setter for port.

@access public

Parameters

string

Returns

ilProxySettings

Definition at line 176 of file class.ilProxySettings.php.

    {
        $this->port = $port;
 
        return $this;
    }

Referenced by read().

Here is the caller graph for this function:

Field Documentation

$_instance

ilProxySettings::$_instance = null

staticprotected

Definition at line 26 of file class.ilProxySettings.php.

Referenced by _getInstance().

$host

ilProxySettings::$host = ''

protected

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

Referenced by checkConnection(), getHost(), and setHost().

$isActive

ilProxySettings::$isActive = false

protected

Definition at line 59 of file class.ilProxySettings.php.

Referenced by isActive().

$post

ilProxySettings::$post = ''

protected

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

CONNECTION_CHECK_TIMEOUT

const ilProxySettings::CONNECTION_CHECK_TIMEOUT = 10

Definition at line 15 of file class.ilProxySettings.php.

---

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

• Services/Http/classes/class.ilProxySettings.php