Docs For Class Date_Holidays

Class: Date_Holidays_Holiday

Inherited Variables

Inherited Methods

Class Details

[line 36]
Simple class that wraps a holiday's data

Author: Carsten Lucke <luckec@tool-garage.de>
Version: CVS: $Id: Holiday.php,v 1.8 2008/01/06 00:47:48 kguest Exp $
Link: http://pear.php.net/package/Date_Holidays
License: PHP License 3.0.1

Method Detail

Date_Holidays_Holiday (Constructor) [line 81]

void Date_Holidays_Holiday(
string
$internalName, string
$title, object
&$date, array
$properties)

Constructor

Access: public

Parameters:

string	`$internalName`	—	internal name
string	`$title`	—	title
object	`&$date`	—	date
array	`$properties`	—	properties for this holiday

[ Top ]

getDate [line 125]

object Date getDate(
)

Returns the date

Return: date
Access: public

[ Top ]

getInternalName [line 103]

string getInternalName(
)

Returns the internal name

Return: internal name
Access: public

[ Top ]

getProperties [line 201]

array getProperties(
)

Returns the holidays additional properties that contain information like a more detailed description, etc.

Return: associative array with corresponding pairs of propertyName => $propertyValue
Access: public

[ Top ]

getTitle [line 114]

string getTitle(
)

Returns the title

Return: title
Access: public

[ Top ]

setDate [line 164]

void setDate(
object
&$date)

Set the date

Access: public

Parameters:

object &$date — date

[ Top ]

setInternalName [line 138]

void setInternalName(
string
$internalName)

Set the internal name

Access: public

Parameters:

string $internalName — internal name

[ Top ]

setTitle [line 151]

void setTitle(
string
$title)

Set the title

Access: public

Parameters:

string $title — title

[ Top ]

toArray [line 184]

array toArray(
)

Returns the holiday data as an array.

Format:

   array(
       'internalName'  => 'easter'
       'title'         => 'Easter Sunday'
       'date'          => Object of type Date
   )

Return: holiday-data
Access: public

[ Top ]

Class: Date_Holidays_Holiday

Class Overview

Author(s):

Version:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

Date_Holidays_Holiday (Constructor) [line 81]

Parameters:

getDate [line 125]

getInternalName [line 103]

getProperties [line 201]

getTitle [line 114]

setDate [line 164]

Parameters:

setInternalName [line 138]

Parameters:

setTitle [line 151]

Parameters:

toArray [line 184]