A
[ class tree: A ] [ index: A ] [ all elements ]

Class: A_Datetime

Source Location: /Datetime.php

Class Overview

DateTime
   |
   --A_Datetime

A_Datetime


Variables

Methods


Inherited Constants

Class: DateTime (Internal Class)

ATOM = 'Y-m-d\\TH:i:sP'
COOKIE = 'l, d-M-y H:i:s T'
ISO8601 = 'Y-m-d\\TH:i:sO'
RFC822 = 'D, d M y H:i:s O'
RFC850 = 'l, d-M-y H:i:s T'
RFC1036 = 'D, d M y H:i:s O'
RFC1123 = 'D, d M Y H:i:s O'
RFC2822 = 'D, d M Y H:i:s O'
RFC3339 = 'Y-m-d\\TH:i:sP'
RSS = 'D, d M Y H:i:s O'
W3C = 'Y-m-d\\TH:i:sP'

Inherited Methods

Class: DateTime (Internal Class)

constructor __construct ( [$time = ], [$object = ] )
add ( $interval )
createFromFormat ( $format, $time, [$object = ] )
diff ( $object, [$absolute = ] )
format ( $format )
getLastErrors ( )
getOffset ( )
getTimestamp ( )
getTimezone ( )
modify ( $modify )
setDate ( $year, $month, $day )
setISODate ( $year, $week, [$day = ] )
setTime ( $hour, $minute, [$second = ] )
setTimestamp ( $unixtimestamp )
setTimezone ( $timezone )
sub ( $interval )
__set_state ( )
__wakeup ( )

Class Details

[line 16]
A_Datetime

Date and time functionality




[ Top ]


Class Variables

$dateFormat =  'Y-m-d H:i:s'

[line 22]

date format returnd by _toString



Tags:

access:  protected

Type:   mixed


[ Top ]

$dayMonthOrder =  true

[line 27]

true dd/mm, false mm/dd



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 34]

A_Datetime __construct( [array $date = null], [ $timezone = null])

constructor add date array support.



Tags:

access:  public


Overrides DateTime::constructor __construct ( [$time = ], [$object = ] ) (parent method not documented)

Parameters:

array   $date  
   $timezone  

[ Top ]

method add [line 266]

void add( $duration)



Tags:

access:  public


Overrides DateTime::add ( $interval ) (parent method not documented)

Parameters:

A_Datetime_Duration   $duration  

[ Top ]

method arrayToString [line 343]

void arrayToString( [array $date = null])

Converts date array to string. Array should be in the form of PHP's getdate() array



Tags:

access:  public


Parameters:

array   $date  

[ Top ]

method getDate [line 123]

void getDate( [ $time = false])

get date string in YYYY-MM-DD format



Tags:

access:  public


Parameters:

   $time  

[ Top ]

method getDay [line 164]

void getDay( )

get day



Tags:

access:  public


[ Top ]

method getDstOffset [line 115]

void getDstOffset( )

Clearer name for existing method



Tags:

access:  public


[ Top ]

method getHour [line 172]

void getHour( [ $meridian = false])

get hour



Tags:

access:  public


Parameters:

   $meridian  

[ Top ]

method getMinute [line 180]

void getMinute( )

get minute



Tags:

access:  public


[ Top ]

method getMonth [line 156]

void getMonth( )

get month



Tags:

access:  public


[ Top ]

method getSecond [line 188]

void getSecond( )

get second



Tags:

access:  public


[ Top ]

method getTime [line 139]

void getTime( [ $meridian = false], [ $seconds = false])

get time string in 23:15 or 11:15 pm format, with or without seconds



Tags:

access:  public


Parameters:

   $meridian  
   $seconds  

[ Top ]

method getTimestamp [line 131]

void getTimestamp( )

get timestamp



Tags:

access:  public


Overrides DateTime::getTimestamp ( ) (parent method not documented)

[ Top ]

method getYear [line 148]

void getYear( )

get year



Tags:

access:  public


[ Top ]

method isAfter [line 301]

void isAfter( $date, [ $inclusive = false])

check if date/time of another objects is after the date/time of this object



Tags:

access:  public


Parameters:

   $date  
   $inclusive  

[ Top ]

method isAfterOrEqual [line 313]

void isAfterOrEqual( $date)

check if date/time of another objects is after the date/time of this object



Tags:

access:  public


Parameters:

   $date  

[ Top ]

method isBefore [line 281]

void isBefore( $date, [ $inclusive = false])

check if date/time of another objects is before the date/time of this object



Tags:

access:  public


Parameters:

   $date  
   $inclusive  

[ Top ]

method isBeforeOrEqual [line 293]

void isBeforeOrEqual( $date)

check if date/time of another objects is before the date/time of this object



Tags:

access:  public


Parameters:

   $date  

[ Top ]

method isWithin [line 321]

void isWithin( $range, [ $inclusive = false])

check if this date/time a range



Tags:

access:  public


Parameters:

A_Datetime_Range   $range  
   $inclusive  

[ Top ]

method isWithinOrEqual [line 333]

void isWithinOrEqual( $range)

check if this date/time a range or equal to the end dates



Tags:

access:  public


Parameters:

A_Datetime_Range   $range  

[ Top ]

method modify [line 49]

void modify( $date)

provide fluent interface for DateTime::modify()



Tags:

access:  public


Overrides DateTime::modify ( $modify ) (parent method not documented)

Parameters:

   $date  

[ Top ]

method newModify [line 196]

void newModify( $format)

return a new modified object based on the format string



Tags:

access:  public


Parameters:

   $format  

[ Top ]

method parseDate [line 207]

void parseDate( $date)

Set date from dates in dd-mm- or mm-dd order, with 2 or 4 digit years and any non-digit separater

This pro




Tags:

access:  public


Parameters:

   $date  

[ Top ]

method remove [line 272]

void remove( $duration)



Tags:

access:  public


Parameters:

A_Datetime_Duration   $duration  

[ Top ]

method setDate [line 79]

void setDate( $year, $month, [ $day = null])

provide fluent interface for DateTime::setDate()



Tags:

access:  public


Overrides DateTime::setDate ( $year, $month, $day ) (parent method not documented)

Parameters:

   $year  
   $month  
   $day  

[ Top ]

method setDayMonthOrder [line 106]

void setDayMonthOrder( [ $dayfirst = true])

Set internal format for __tostring



Tags:

access:  public


Parameters:

   $dayfirst  

[ Top ]

method setFormat [line 97]

void setFormat( $format)

Set format of value returned by __toString()



Tags:

access:  public


Parameters:

   $format  

[ Top ]

method setISODate [line 88]

void setISODate( $year, $week, [ $day = null])

provide fluent interface for DateTime::setISODate()



Tags:

access:  public


Overrides DateTime::setISODate ( $year, $week, [$day = ] ) (parent method not documented)

Parameters:

   $year  
   $week  
   $day  

[ Top ]

method setTime [line 70]

void setTime( $hour, $minute, [ $second = null])

provide fluent interface for DateTime::setTime()



Tags:

access:  public


Overrides DateTime::setTime ( $hour, $minute, [$second = ] ) (parent method not documented)

Parameters:

   $hour  
   $minute  
   $second  

[ Top ]

method setTimezone [line 61]

void setTimezone( $timezone)

provide fluent interface for DateTime::setTimezone()



Tags:

access:  public


Overrides DateTime::setTimezone ( $timezone ) (parent method not documented)

Parameters:

DateTimeZone   $timezone  

[ Top ]

method toString [line 378]

void toString( )

get date using internal format value



Tags:

access:  public


[ Top ]

method __toString [line 386]

void __toString( )

get date in in string context using internal format value



Tags:

access:  public


[ Top ]


Documentation generated on Sun, 24 Jul 2011 00:03:24 +0000 by phpDocumentor 1.4.3