API Documentation

Zend/Date/DateObject.php

Show: inherited
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_Date  
Version
$Id: DateObject.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Date_DateObject

Package: Zend\Date\Zend\Date\DateObject

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

Properties

Propertyprotected  $_cache= 'null'
static
Default valuenullDetails
Type
Propertyprotected  $_cacheTags= 'false'
static
Default valuefalseDetails
Type
Propertyprotected  $_defaultOffset= '0'
static
Default value0Details
Type
Propertyprotected  $_dst= 'true'
Default valuetrueDetails
Type
Propertyprivate  $_monthTable= 'array(31'
static

Table of Monthdays

Default valuearray(31Details
Type
Propertyprivate  $_offset= '0'
Default value0Details
Type
Propertyprivate  $_syncronised= '0'
Default value0Details
Type
Propertyprivate  $_timezone= ''UTC''

active timezone

Default value'UTC'Details
Type
Propertyprivate  $_unixTimestamp= ''

UNIX Timestamp

Details
Type
Propertyprivate  $_yearTable= 'array( 1970 => 0'
static

Table of Years

Default valuearray( 1970 => 0Details
Type

Methods

methodprotected_getTagSupportForCache( ) : void
static

Internal method to check if the given cache supports tags

methodprotected_getTime( integer $sync = null ) : integer

Internal function.

Returns time(). This method exists to allow unit tests to work-around methods that might otherwise be hard-coded to use time(). For example, this makes it possible to test isYesterday() in Date.php.

Parameters
Name Type Description
$sync integer

OPTIONAL time syncronisation value

Returns
Type Description
integer timestamp
methodprivate_range( float $a, float $b ) : void

Internal _range function Sets the value $a to be in the range of [0, $b]

Parameters
Name Type Description
$a float
  • value to correct
$b float
  • maximum range to set
methodprotectedcalcSun( array $location, bool $horizon,  $rise = false ) : mixed

Calculates the sunrise or sunset based on a location

Parameters
Name Type Description
$location array

Location for calculation MUST include 'latitude', 'longitude', 'horizon'

$horizon bool

true: sunrise; false: sunset

$rise
Returns
Type Description
mixed - false: midnight sun, integer:
methodprotecteddate( string $format, mixed $timestamp = null, boolean $gmt = false ) : string

Internal mktime function used by Zend_Date for handling 64bit timestamps.

Returns a formatted date for a given timestamp.

Parameters
Name Type Description
$format string

format for output

$timestamp mixed
$gmt boolean

OPTIONAL true = other arguments are for UTC time, false = arguments are for local time/date

Returns
Type Description
string
methodprotecteddayOfWeek( integer $year, integer $month, integer $day ) : integer
static

Returns the day of week for a Gregorian calendar date.

0 = sunday, 6 = saturday

Parameters
Name Type Description
$year integer
$month integer
$day integer
Returns
Type Description
integer dayOfWeek
methodprotectedgetDateParts( mixed $timestamp = null, boolean $fast = null ) : array

Internal getDateParts function for handling 64bit timestamps, similar to: http://www.php.net/getdate

Returns an array of date parts for $timestamp, relative to 1970/01/01 00:00:00 GMT/UTC.

$fast specifies ALL date parts should be returned (slower) Default is false, and excludes $dayofweek, weekday, month and timestamp from parts returned.

Parameters
Name Type Description
$timestamp mixed
$fast boolean

OPTIONAL defaults to fast (false), resulting in fewer date parts

Returns
Type Description
array
methodpublicgetGmtOffset( ) : integer

Return the offset to GMT of $this object's timezone.

The offset to GMT is initially set when the object is instantiated using the currently, in effect, default timezone for PHP functions.

Returns
Type Description
integer seconds difference between GMT timezone and timezone when object was instantiated
methodpublicgetTimezone( ) : string

Return the timezone of $this object.

The timezone is initially set when the object is instantiated.

Returns
Type Description
string actual set timezone string
methodprotectedgetUnixTimestamp( ) : integer|string

Returns this object's UNIX timestamp A timestamp greater then the integer range will be returned as string This function does not return the timestamp as object. Use copy() instead.

Returns
Type Description
integer|string timestamp
methodprotectedisYearLeapYear( integer $year ) : boolean
static

Returns true, if given $year is a leap year.

Parameters
Name Type Description
$year integer
Returns
Type Description
boolean true, if year is leap year
methodprotectedmktime( integer $hour, integer $minute, integer $second, integer $month, integer $day, integer $year, boolean $gmt = false ) : integer|float

Internal mktime function used by Zend_Date.

The timestamp returned by mktime() can exceed the precision of traditional UNIX timestamps, by allowing PHP to auto-convert to using a float value.

Returns a timestamp relative to 1970/01/01 00:00:00 GMT/UTC. DST (Summer/Winter) is depriciated since php 5.1.0. Year has to be 4 digits otherwise it would be recognised as year 70 AD instead of 1970 AD as expected !!

Parameters
Name Type Description
$hour integer
$minute integer
$second integer
$month integer
$day integer
$year integer
$gmt boolean

OPTIONAL true = other arguments are for UTC time, false = arguments are for local time/date

Returns
Type Description
integer|float timestamp (number of seconds elapsed relative to 1970/01/01 00:00:00 GMT/UTC)
methodpublicsetTimezone( string $zone = null ) : \Zend_Date_DateObject

Sets a new timezone for calculation of $this object's gmt offset.

For a list of supported timezones look here: http://php.net/timezones If no timezone can be detected or the given timezone is wrong UTC will be set.

Parameters
Name Type Description
$zone string

OPTIONAL timezone for date calculation; defaults to date_default_timezone_get()

Returns
Type Description
\Zend_Date_DateObject Provides fluent interface
Throws
Exception Description
\Zend_Date_Exception
methodprotectedsetUnixTimestamp( string|integer $timestamp = null ) : string|integer

Set this object to have a new UNIX timestamp.

Parameters
Name Type Description
$timestamp string|integer

OPTIONAL timestamp; defaults to local time using time()

Returns
Type Description
string|integer old timestamp
Throws
Exception Description
\Zend_Date_Exception
methodprotectedweekNumber( integer $year, integer $month, integer $day ) : integer

Internal getWeekNumber function for handling 64bit timestamps

Returns the ISO 8601 week number of a given date

Parameters
Name Type Description
$year integer
$month integer
$day integer
Returns
Type Description
integer
Documentation was generated by DocBlox 0.15.1.