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

Class: Date_Holidays_Holiday

Source Location: /Date_Holidays-0.21.8/Date/Holidays/Holiday.php

Class Overview


Simple class that wraps a holiday's data


Author(s):

Version:

  • CVS: $Id$

Methods


Inherited Variables

Inherited Methods


Class Details

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


[ Top ]


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 ]


Documentation generated on Tue, 22 Jan 2013 01:00:08 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.