Zend_TimeSync Class Reference

Inheritance diagram for Zend_TimeSync:

Public Member Functions
	__construct ($target=null, $alias=null)
	getIterator ()
	addServer ($target, $alias=null)
	setServer ($alias)
	getServer ($alias=null)
	getInfo ()
	getDate ($locale=null)

Static Public Member Functions
static	setOptions (array $options)
static	getOptions ($key=null)

Data Fields
const	DEFAULT_PROTOCOL = 'Ntp'

Static Public Attributes
static	$options

Protected Member Functions
	_addServer ($target, $alias)

Protected Attributes
	$_timeservers = array()
	$_current
	$_allowedSchemes

Detailed Description

Definition at line 34 of file TimeSync.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$target = null,
			$alias = null
	)

Zend_TimeSync constructor

Parameters

string | array	$target	- OPTIONAL single timeserver, or an array of timeservers.
string	$alias	- OPTIONAL an alias for this timeserver

Returns

object

Definition at line 83 of file TimeSync.php.

    {
        if ($target !== null) {
            $this->addServer($target, $alias);
        }
    }

Member Function Documentation

_addServer()

_addServer (   $target,   $alias  )

protected

Adds a timeserver object to the timeserver list

Parameters

string | array	$target	- Single timeserver, or an array of timeservers.
string	$alias	- An alias for this timeserver

Definition at line 264 of file TimeSync.php.

    {
        if ($pos = strpos($target, '://')) {
            $protocol = substr($target, 0, $pos);
            $adress = substr($target, $pos + 3);
        } else {
            $adress = $target;
            $protocol = self::DEFAULT_PROTOCOL;
        }

        if ($pos = strrpos($adress, ':')) {
            $posbr = strpos($adress, ']');
            if ($posbr and ($pos > $posbr)) {
                $port = substr($adress, $pos + 1);
                $adress = substr($adress, 0, $pos);
            } else if (!$posbr and $pos) {
                $port = substr($adress, $pos + 1);
                $adress = substr($adress, 0, $pos);
            } else {
                $port = null;
            }
        } else {
            $port = null;
        }

        $protocol = ucfirst(strtolower($protocol));
        if (!in_array($protocol, $this->_allowedSchemes)) {
            #require_once 'Zend/TimeSync/Exception.php';
            throw new Zend_TimeSync_Exception("'$protocol' is not a supported protocol");
        }

        $className = 'Zend_TimeSync_' . $protocol;
        if (!class_exists($className)) {
            #require_once 'Zend/Loader.php';
            Zend_Loader::loadClass($className);
        }
        $timeServerObj = new $className($adress, $port);

        $this->_timeservers[$alias] = $timeServerObj;
    }

addServer()

addServer	(		$target,
			$alias = null
	)

Add a timeserver or multiple timeservers

Server should be a single string representation of a timeserver, or a structured array listing multiple timeservers.

If you provide an array of timeservers in the $target variable, $alias will be ignored. you can enter these as the array key in the provided array, which should be structured as follows:

$example = array( 'server_a' => 'ntp://127.0.0.1', 'server_b' => 'ntp://127.0.0.1:123', 'server_c' => 'ntp://[2000:364:234::2.5]', 'server_d' => 'ntp://[2000:364:234::2.5]:123' );

If no port number has been suplied, the default matching port number will be used.

Supported protocols are:

• ntp
• sntp

Parameters

string | array	$target	- Single timeserver, or an array of timeservers.
string	$alias	- OPTIONAL an alias for this timeserver

Exceptions

Zend_TimeSync_Exception

Definition at line 131 of file TimeSync.php.

    {
        if (is_array($target)) {
            foreach ($target as $key => $server) {
                $this->_addServer($server, $key);
            }
        } else {
            $this->_addServer($target, $alias);
        }
    }

getDate()

getDate

(

$locale = null

)

Query the timeserver list using the fallback mechanism

If there are multiple servers listed, this method will act as a facade and will try to return the date from the first server that returns a valid result.

Parameters

Zend_Locale

$locale

- OPTIONAL locale

Returns

object

Exceptions

Zend_TimeSync_Exception

Definition at line 240 of file TimeSync.php.

    {
        #require_once 'Zend/TimeSync/Exception.php';
        foreach ($this->_timeservers as $alias => $server) {
            $this->_current = $server;
            try {
                return $server->getDate($locale);
            } catch (Zend_TimeSync_Exception $e) {
                if (!isset($masterException)) {
                    $masterException = new Zend_TimeSync_Exception('all timeservers are bogus');
                }
                $masterException->addException($e);
            }
        }

        throw $masterException;
    }

getInfo()

getInfo

(

)

Returns information sent/returned from the current timeserver

Returns

array

Definition at line 224 of file TimeSync.php.

    {
        return $this->getServer()->getInfo();
    }

getIterator()

getIterator

(

)

getIterator() - return an iteratable object for use in foreach and the like, this completes the IteratorAggregate interface

Returns

ArrayObject

Definition at line 96 of file TimeSync.php.

    {
        return new ArrayObject($this->_timeservers);
    }

getOptions()

static getOptions (   $key = null )

static

Returns the value to the option

Parameters

string

$key

- The option's identifier

Returns

mixed

Exceptions

Zend_TimeSync_Exception

Definition at line 179 of file TimeSync.php.

    {
        if ($key == null) {
            return Zend_TimeSync::$options;
        }

        if (isset(Zend_TimeSync::$options[$key]) === true) {
            return Zend_TimeSync::$options[$key];
        } else {
            #require_once 'Zend/TimeSync/Exception.php';
            throw new Zend_TimeSync_Exception("'$key' does not point to valid option");
        }
    }

getServer()

getServer

(

$alias = null

)

Return a specified timeserver by alias If no alias is given it will return the current timeserver

Parameters

string | integer

$alias

- The alias from the timeserver to return

Returns

object

Exceptions

Zend_TimeSync_Exception

Definition at line 201 of file TimeSync.php.

    {
        if ($alias === null) {
            if (isset($this->_current) && $this->_current !== false) {
                return $this->_current;
            } else {
                #require_once 'Zend/TimeSync/Exception.php';
                throw new Zend_TimeSync_Exception('there is no timeserver set');
            }
        }
        if (isset($this->_timeservers[$alias]) === true) {
            return $this->_timeservers[$alias];
        } else {
            #require_once 'Zend/TimeSync/Exception.php';
            throw new Zend_TimeSync_Exception("'$alias' does not point to valid timeserver");
        }
    }

setOptions()

static setOptions ( array  $options )

static

Sets the value for the given options

This will replace any currently defined options.

Parameters

array

$options

- An array of options to be set

Definition at line 149 of file TimeSync.php.

    {
        foreach ($options as $key => $value) {
            Zend_TimeSync::$options[$key] = $value;
        }
    }

setServer()

setServer

(

$alias

)

Marks a nameserver as current

Parameters

string | integer

$alias

- The alias from the timeserver to set as current

Exceptions

Zend_TimeSync_Exception

Definition at line 162 of file TimeSync.php.

    {
        if (isset($this->_timeservers[$alias]) === true) {
            $this->_current = $this->_timeservers[$alias];
        } else {
            #require_once 'Zend/TimeSync/Exception.php';
            throw new Zend_TimeSync_Exception("'$alias' does not point to valid timeserver");
        }
    }

Field Documentation

$_allowedSchemes

$_allowedSchemes

protected

Initial value:

= array(
        'Ntp',
        'Sntp'
    )

Definition at line 61 of file TimeSync.php.

$_current

$_current

protected

Definition at line 54 of file TimeSync.php.

$_timeservers

$_timeservers = array()

protected

Definition at line 47 of file TimeSync.php.

$options

$options

static

Initial value:

= array(
        'timeout' => 1
    )

Definition at line 72 of file TimeSync.php.

DEFAULT_PROTOCOL

const DEFAULT_PROTOCOL = 'Ntp'

Set the default timeserver protocol to "Ntp". This will be called when no protocol is specified

Definition at line 40 of file TimeSync.php.

---

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

• vendor/magento/zendframework1/library/Zend/TimeSync.php