TimeSync.php

Show:

inherited

Classes
- \Zend_TimeSync

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_TimeSync
Version: $Id: TimeSync.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_TimeSync
jump to top

Package: Zend\TimeSync

Implements
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                DEFAULT_PROTOCOL
                = 'Ntp'

Set the default timeserver protocol to "Ntp".

This will be called when no protocol is specified

Properties

array $_allowedSchemes = array('Ntp', 'Sntp')

Allowed timeserver schemes

Default valuearray('Ntp', 'Sntp')Details

Type: array

object $_current

Holds a reference to the timeserver that is currently being used

Details

Type: object

array $_timeservers = array()

Contains array of timeserver objects

Default valuearray()Details

Type: array

array $options = array('timeout' => 1)

static

Configuration array, set using the constructor or using ::setOptions() or ::setOption()

Default valuearray('timeout' => 1)Details

Type: array

Methods

__construct(string | array $target = null, string $alias = null) : object

Zend_TimeSync constructor

Parameters

Name	Type	Description
$target	string \| array	OPTIONAL single timeserver, or an array of timeservers.
$alias	string	OPTIONAL an alias for this timeserver

Returns

Type	Description
object

_addServer(string | array $target, string $alias) : void

Adds a timeserver object to the timeserver list

Parameters

Name	Type	Description
$target	string \| array	Single timeserver, or an array of timeservers.
$alias	string	An alias for this timeserver

addServer(string | array $target, string $alias = null) : void

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

Name	Type	Description
$target	string \| array	Single timeserver, or an array of timeservers.
$alias	string	OPTIONAL an alias for this timeserver

Throws

Exception	Description
\Zend_TimeSync_Exception

getDate(\Zend_Locale $locale = null) : object

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

Name	Type	Description
$locale	\Zend_Locale	OPTIONAL locale

Returns

Type	Description
object

Throws

Exception	Description
\Zend_TimeSync_Exception

getInfo() : array

Returns information sent/returned from the current timeserver

Returns

Type	Description
array

getIterator() : \ArrayObject

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

Returns

Type	Description
\ArrayObject

getOptions(string $key = null) : mixed

static

Returns the value to the option

Parameters

Name	Type	Description
$key	string	The option's identifier

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_TimeSync_Exception

getServer(string | integer $alias = null) : object

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

Parameters

Name	Type	Description
$alias	string \| integer	The alias from the timeserver to return

Returns

Type	Description
object

Throws

Exception	Description
\Zend_TimeSync_Exception

setOptions(array $options) : void

static

Sets the value for the given options

This will replace any currently defined options.

Parameters

Name	Type	Description
$options	array	An array of options to be set

setServer(string | integer $alias) : void

Marks a nameserver as current

Parameters

Name	Type	Description
$alias	string \| integer	The alias from the timeserver to set as current

Throws

Exception	Description
\Zend_TimeSync_Exception

TimeSync.php

\Zend_TimeSyncjump to top

Constants

Properties

Methods

\Zend_TimeSync
jump to top