TimeSync.php
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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_TimeSync
- Version
- $Id$
\Zend_TimeSync
Package: Zend_TimeSync




Throws

Returns
Throws






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


array $_allowedSchemes = array('Ntp', 'Sntp')
Allowed timeserver schemes
Default value
array('Ntp', 'Sntp')
Details- Type
- array


array $_timeservers = array()
Contains array of timeserver objects
Default value
array()
Details- Type
- array
Methods


__construct(string | array $target = null, string $alias = null) : object
Zend_TimeSync constructor
Parameters
Returns
Name | Type | Description |
---|---|---|
$target | string | array |
|
$alias | string |
|
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 |
|
$alias | string |
|


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:
Parameters
$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
- sntpName | Type | Description |
---|---|---|
$target | string | array |
|
$alias | string |
|
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.
ParametersName | Type | Description |
---|---|---|
$locale | \Zend_Locale |
|
Type | Description |
---|---|
object |
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
Returns
Throws
Name | Type | Description |
---|---|---|
$key | string |
|
Type | Description |
---|---|
mixed |
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
Returns
Throws
Name | Type | Description |
---|---|---|
$alias | string | integer |
|
Type | Description |
---|---|
object |
Exception | Description |
---|---|
\Zend_TimeSync_Exception |


setOptions(array $options) : void
static
Sets the value for the given options
This will replace any currently defined options.
ParametersName | Type | Description |
---|---|---|
$options | array |
|


setServer(string | integer $alias) : void
Marks a nameserver as current
Parameters
Throws
Name | Type | Description |
---|---|---|
$alias | string | integer |
|
Exception | Description |
---|---|
\Zend_TimeSync_Exception |