helper_date Class Reference

Inheritance diagram for helper_date:

Public Member Functions
	set ($date, $type='date', $len=null)
	getArray ()
	setArray (array $values)
	get ($part=null)
	format ($type=null, $len=null)
	formatDirect ($format)
	getJs ($default='""')
	timeago (helper_date $d=null)
	__toString ()
	getAttr ($name)
	setAttr ($name, $value)
	getCfg ()

Protected Member Functions
	afterinit ()
	beforeInit ()
	afterInit ()

Protected Attributes
	$timestamp
	$isNull = false
	$cfg

Detailed Description

Helper to deal with date

Definition at line 10 of file helper/date.class.php.

Member Function Documentation

__toString()

__toString

(

)

Definition at line 281 of file helper/date.class.php.

afterinit()

afterinit ( )

protected

Definition at line 26 of file helper/date.class.php.

afterInit()

afterInit ( )

protectedinherited

Call just after the configuration initialisation

Definition at line 40 of file object.class.php.

beforeInit()

beforeInit ( )

protectedinherited

Call just before the configuration initialisation

Definition at line 35 of file object.class.php.

format()

format	(		$type = null,
			$len = null
	)

Format the date

Parameters

string	$format	Date format (date, time, or datetime)
string	$len	Length needed (short, medium, long, full, fullMed or mysql)

Returns

string The date formated

Definition at line 176 of file helper/date.class.php.

formatDirect()

formatDirect

(

$format

)

Format the date directly by a string format

Parameters

string

$format

Date format

Returns

string The date formated

Definition at line 204 of file helper/date.class.php.

get()

get

(

$part = null

)

Get a date element

Parameters

sting

$part

Date type, could be any string used in the date PHP function

Returns

string|int

Definition at line 156 of file helper/date.class.php.

getArray()

getArray

(

)

Get an array describing the date

Returns

array

Definition at line 123 of file helper/date.class.php.

getAttr()

getAttr (   $name )

inherited

Get an attribute

Parameters

string

$name

Attribute name

Returns

mixed|null The attribute or null if not set

Definition at line 48 of file object.class.php.

getCfg()

getCfg ( )

inherited

Get the configuration object

Returns

config

Definition at line 67 of file object.class.php.

getJs()

getJs

(

$default = '""'

)

Create a javascript code to create a new Date object

Parameters

string

$default

Default string used in case of a non setted date

Returns

string the Javascript code

Definition at line 243 of file helper/date.class.php.

set()

set	(		$date,
			$type = 'date',
			$len = null
	)

Set a new date or a date element

Parameters

string | int	$date	The value to set
string	$type	The value type (timestamp, date, time or a key from getArray)

Definition at line 36 of file helper/date.class.php.

setArray()

setArray

(

array

$values

)

Set a new date element with an array

Parameters

array

$values

New values

See also

getArray

Definition at line 145 of file helper/date.class.php.

setAttr()

setAttr (   $name,   $value  )

inherited

Set an attribute

Parameters

string	$name	Attribute name
mixed	$value	Attribute value

Definition at line 58 of file object.class.php.

timeago()

timeago

(

helper_date

$d = null

)

Timeago in string to be shown

Parameters

helper_date | null

$d

Date to compare to or null to use the current time

Returns

string The timeago string

Definition at line 255 of file helper/date.class.php.

Field Documentation

$cfg

$cfg	protectedinherited

Definition at line 17 of file object.class.php.

$isNull

$isNull = false

protected

Definition at line 24 of file helper/date.class.php.

$timestamp

$timestamp

protected

Definition at line 17 of file helper/date.class.php.

---

The documentation for this class was generated from the following file:

• helper/date.class.php