Documentation

Horde_Kolab_Format_Date
in package

Kolab date handling functions. Based upon Kolab.php from Stuart Binge.

Copyright 2004-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Tags
category

Kolab

author

Stuart Binge omicron@mighty.co.za

author

Thomas Jarosch thomas.jarosch@intra2net.com

license

http://www.horde.org/licenses/lgpl21 LGPL

link
http://www.horde.org/libraries/Horde_Kolab_Format

Table of Contents

readDate()  : DateTime
Parse the provided string into a PHP DateTime object.
readDateOrDateTime()  : DateTime
Parse the provided string into a PHP DateTime object.
readDateTime()  : DateTime
Parse the provided string into a PHP DateTime object.
readUtcDateTime()  : DateTime
Parse the provided string into a PHP DateTime object.
writeDate()  : string
Write the provided PHP DateTime object into a Kolab format date representation.
writeDateTime()  : string
Write the provided PHP DateTime object into a Kolab format date-time representation.
writeUtcDateTime()  : string
Write the provided PHP DateTime object into a Kolab format UTC date-time representation.

Methods

readDate()

Parse the provided string into a PHP DateTime object.

public static readDate(string $date[, string $timezone = null ]) : DateTime
Parameters
$date : string

The Kolab date value.

$timezone : string = null

The associated timezone. Deprecated.

Tags
todo

Drop $timezone parameter in version 3.0.0.

Return values
DateTime

The date-time value represented as PHP DateTime object.

readDateOrDateTime()

Parse the provided string into a PHP DateTime object.

public static readDateOrDateTime(string $date[, string $timezone = null ]) : DateTime
Parameters
$date : string

The string representation of the date (& time).

$timezone : string = null

The associated timezone. Deprecated.

Tags
todo

Drop $timezone parameter in version 3.0.0.

Return values
DateTime

The date-time value represented as PHP DateTime object.

readDateTime()

Parse the provided string into a PHP DateTime object.

public static readDateTime(string $date_time[, string $timezone = null ]) : DateTime
Parameters
$date_time : string

The Kolab date-time value.

$timezone : string = null

The associated timezone. Deprecated.

Tags
todo

Drop $timezone parameter in version 3.0.0.

Return values
DateTime

The date-time value represented as PHP DateTime object.

readUtcDateTime()

Parse the provided string into a PHP DateTime object.

public static readUtcDateTime(string $date_time) : DateTime
Parameters
$date_time : string

The Kolab date-time value.

Tags
todo

Drop in version 3.0.0.

Return values
DateTime

The date-time value represented as PHP DateTime object.

writeDate()

Write the provided PHP DateTime object into a Kolab format date representation.

public static writeDate(DateTime $date) : string
Parameters
$date : DateTime

The PHP DateTime object.

Return values
string

The Kolab format UTC date string.

writeDateTime()

Write the provided PHP DateTime object into a Kolab format date-time representation.

public static writeDateTime(DateTime $date_time) : string
Parameters
$date_time : DateTime

The PHP DateTime object.

Return values
string

The Kolab format date-time string.

writeUtcDateTime()

Write the provided PHP DateTime object into a Kolab format UTC date-time representation.

public static writeUtcDateTime(DateTime $date_time) : string
Parameters
$date_time : DateTime

The PHP DateTime object.

Tags
todo

Drop in version 3.0.0.

Return values
string

The Kolab format UTC date-time string.

Search results