Docs for page date.inc.php

Procedural File: date.inc.php

Page Details

Contains various functions for date manipulation

Filesource:

Source Code for this file

Includes

require_once (TANGRA_MAIN_DIR.'exceptions/te_invalid_date.class.php') [line 47]

[ Top ]

Constants

TANGRA_DATE_FORMAT_DDSMMSYYYY [line 17]

TANGRA_DATE_FORMAT_DDSMMSYYYY = 0

[ Top ]

TANGRA_DATE_FORMAT_MMSDDSYYYY [line 21]

TANGRA_DATE_FORMAT_MMSDDSYYYY = 1

[ Top ]

TANGRA_DATE_FORMAT_YYYYMMDD [line 29]

TANGRA_DATE_FORMAT_YYYYMMDD = 3

[ Top ]

TANGRA_DATE_FORMAT_YYYYSMMSDD [line 25]

TANGRA_DATE_FORMAT_YYYYSMMSDD = 2

[ Top ]

TANGRA_DATE_SEPARATOR_MINUS [line 37]

TANGRA_DATE_SEPARATOR_MINUS = '-'

[ Top ]

TANGRA_DATE_SEPARATOR_POINT [line 33]

TANGRA_DATE_SEPARATOR_POINT = '.'

[ Top ]

TANGRA_DATE_SEPARATOR_SLASH [line 42]

TANGRA_DATE_SEPARATOR_SLASH = '/'

[ Top ]

Functions

check_timestamp [line 253]

void check_timestamp(
unknown_type $ts, [boolean $allow_zero_timestamp = true] 
)

Checks timestamp in format: Y-m-d H:i:s if it is valid.

Parameters:

unknown_type	$ts:	Timestamp in Y-m-d H:i:s format.
boolean	$allow_zero_timestamp:	If true 0000-00-00 (zero timestamp) will be accepted as valid timestamp. Default is true.

[ Top ]

datetime_to_timestamp [line 215]

string datetime_to_timestamp(
string $datetime 
)

Converts datetime to timestamp (uses mktime to create timestamp)

This function is PHP version safe, i.e. it always returns false in case of invalid datetime passed. Before PHP5.1 mktime returned -1 in case of error. Since PHP 5.1. mktime returns false in case of error.

Parameters:

string

$datetime:

Datetime value

API Tags:

Return:

Returns timestamp or false in case of error.

[ Top ]

date_ddsmmsyyyy_to_yyyysmmsdd [line 140]

string date_ddsmmsyyyy_to_yyyysmmsdd(
string $date, [string $separator = TANGRA_DATE_SEPARATOR_MINUS], [boolean $forgiving = true] 
)

Converts date from TANGRA_DATE_FORMAT_DDSMMSYYYY to TANGRA_DATE_FORMAT_YYYYSMMSDD format

Parameters:

string	$date:	Date to be converted
string	$separator:	Separator that will be used in converted date. Default is TANGRA_DATE_SEPARATOR_MINUS, i.e. dminus sign (-)
boolean	$forgiving:	If true in case of invalid date passed by $date will return empty string. If false will throw exception

API Tags:

Return:

Converted date or empty string in case of error

Information Tags:

Throws:

TE_Invalid_Date

[ Top ]

date_mmsddsyyyy_to_yyyysmmsdd [line 191]

string date_mmsddsyyyy_to_yyyysmmsdd(
string $date, [string $separator = TANGRA_DATE_SEPARATOR_MINUS], [boolean $forgiving = true] 
)

Converts date from TANGRA_DATE_FORMAT_MMSDDSYYYY to TANGRA_DATE_FORMAT_YYYYSMMSDD format

Parameters:

string	$date:	Date to be converted
string	$separator:	Separator that will be used in converted date. Default is TANGRA_DATE_SEPARATOR_MINUS, i.e. dminus sign (-)
boolean	$forgiving:	If true in case of invalid date passed by $date will return empty string. If false will throw exception

API Tags:

Return:

Converted date or empty string in case of error

Information Tags:

Throws:

TE_Invalid_Date

[ Top ]

date_yyyysmmsdd_to_ddsmmsyyyy [line 115]

string date_yyyysmmsdd_to_ddsmmsyyyy(
string $date, [string $separator = TANGRA_DATE_SEPARATOR_POINT], [boolean $forgiving = true] 
)

Converts date from TANGRA_DATE_FORMAT_YYYYSMMSDD to TANGRA_DATE_FORMAT_DDSMMSYYYY format

Parameters:

string	$date:	Date to be converted
string	$separator:	Separator that will be used in converted date. Default is TANGRA_DATE_SEPARATOR_POINT, i.e. decimal point (.)
boolean	$forgiving:	If true in case of invalid date passed by $date will return empty string. If false will throw exception

API Tags:

Return:

Converted date or empty string in case of error

Information Tags:

Throws:

TE_Invalid_Date

[ Top ]

date_yyyysmmsdd_to_mmsddsyyyy [line 166]

string date_yyyysmmsdd_to_mmsddsyyyy(
string $date, [string $separator = TANGRA_DATE_SEPARATOR_POINT], [boolean $forgiving = true] 
)

Converts date from TANGRA_DATE_FORMAT_YYYYSMMSDD to TANGRA_DATE_FORMAT_MMSDDSYYYY format

Parameters:

string	$date:	Date to be converted
string	$separator:	Separator that will be used in converted date. Default is TANGRA_DATE_SEPARATOR_POINT, i.e. decimal point (.)
boolean	$forgiving:	If true in case of invalid date passed by $date will return empty string. If false will throw exception

API Tags:

Return:

Converted date or empty string in case of error

Information Tags:

Throws:

TE_Invalid_Date

[ Top ]

days_in_month [line 238]

integer days_in_month(
integer $month, integer $year 
)

Returns days count in given month

Parameters:

integer	$month:
integer	$year:

[ Top ]

is_valid_date [line 57]

boolean is_valid_date(
string $s_date, [integer $format = TANGRA_DATE_FORMAT_YYYYSMMSDD] 
)

Checks if it is valid date

Parameters:

string	$s_date:	Date string to be checked
integer	$format:	Date format. Default is TANGRA_DATE_FORMAT_YYYYSMMSDD. Other options are TANGRA_DATE_FORMAT_DDSMMSYYYY, TANGRA_DATE_FORMAT_MMSDDSYYYY and TANGRA_DATE_FORMAT_YYYYMMDD

API Tags:

Return:

Returns true if date is valid

[ Top ]