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


Classes:
Driver
   Date_Holidays_Driver
   Date_Holidays_Driver_Austria
   Date_Holidays_Driver_Christian
   Date_Holidays_Driver_Composite
   Date_Holidays_Driver_Denmark
   Date_Holidays_Driver_Discordian
   Date_Holidays_Driver_EnglandWales
   Date_Holidays_Driver_Germany
   Date_Holidays_Driver_Ireland
   Date_Holidays_Driver_Jewish
   Date_Holidays_Driver_PHPdotNet
   Date_Holidays_Driver_Slovenia
   Date_Holidays_Driver_Sweden
   Date_Holidays_Driver_UNO
   Date_Holidays_Driver_USA
Filter
   Date_Holidays_Filter_Blacklist
   Date_Holidays_Filter_Composite
   Date_Holidays_Filter_Germany_BadenWuerttemberg
   Date_Holidays_Filter_Germany_Bavaria
   Date_Holidays_Filter_Germany_Berlin
   Date_Holidays_Filter_Germany_Brandenburg
   Date_Holidays_Filter_Germany_Bremen
   Date_Holidays_Filter_Germany_Hamburg
   Date_Holidays_Filter_Germany_Hesse
   Date_Holidays_Filter_Germany_LowerSaxony
   Date_Holidays_Filter_Germany_MecklenburgWesternPomerania
   Date_Holidays_Filter_Germany_NorthRhineWestphalia
   Date_Holidays_Filter_Germany_Official
   Date_Holidays_Filter_Germany_RhinelandPalatinate
   Date_Holidays_Filter_Germany_Saarland
   Date_Holidays_Filter_Germany_Saxony
   Date_Holidays_Filter_Germany_SaxonyAnhalt
   Date_Holidays_Filter_Germany_SchleswigHolstein
   Date_Holidays_Filter_Germany_Thuringia
   Date_Holidays_Filter_Ireland_Official
   Date_Holidays_Filter_Whitelist
Examples
   Date_Holidays_Driver_Example
Date_Holidays
Date_Holidays_Filter
Date_Holidays_Holiday
Files:
Filter.php
Holiday.php
Holidays.php

subpackage Driver
Austria.php
Christian.php
Composite.php
Denmark.php
Discordian.php
Driver.php
EnglandWales.php
Germany.php
Ireland.php
Jewish.php
PHPdotNet.php
Slovenia.php
Sweden.php
UNO.php
USA.php

subpackage Examples
addingTranslations.php
creating_drivers.php
fetchingInstalledDrivers.php
usingCompositeDriver.php
usingStandaloneDriver.php

subpackage Filter
BadenWuerttemberg.php
Bavaria.php
Berlin.php
Blacklist.php
Brandenburg.php
Bremen.php
Composite.php
Hamburg.php
Hesse.php
LowerSaxony.php
MecklenburgWesternPomerania.php
NorthRhineWestphalia.php
Official.php
Official.php
RhinelandPalatinate.php
Saarland.php
Saxony.php
SaxonyAnhalt.php
SchleswigHolstein.php
Thuringia.php
Whitelist.php

Class: Date_Holidays_Driver_Example

Source Location: /Date_Holidays-0.17.1/examples/creating_drivers.php

Class Overview

Date_Holidays_Driver
   |
   --Date_Holidays_Driver_Example

Example how to create an own driver-class for Date_Holidays


Author(s):

Version:

  • $Id: Driver.php,v 1.20 2006/04/03 21:04:46 luckec Exp $

Methods

Inherited Variables

Class: Date_Holidays_Driver

Date_Holidays_Driver::$_dates
Date_Holidays_Driver::$_holidays
Date_Holidays_Driver::$_internalNames
Date_Holidays_Driver::$_locale
Date_Holidays_Driver::$_titles
Date_Holidays_Driver::$_year

Inherited Methods

Class: Date_Holidays_Driver

Date_Holidays_Driver::Date_Holidays_Driver()
Constructor
Date_Holidays_Driver::addCompiledTranslationFile()
Add a compiled language-file's content
Date_Holidays_Driver::addDriver()
Add a driver component
Date_Holidays_Driver::addTranslationFile()
Add a language-file's content
Date_Holidays_Driver::getHoliday()
Returns the specified holiday
Date_Holidays_Driver::getHolidayDate()
Returns date of a holiday
Date_Holidays_Driver::getHolidayDates()
Returns dates of all holidays or those accepted by the applied filter.
Date_Holidays_Driver::getHolidayForDate()
Returns a 
  1. Date_Holidays_Holiday
    2.
object, if any was found, matching the specified date.
Date_Holidays_Driver::getHolidayProperties()
Returns the localized properties of a holiday. If no properties have been stored an empty array will be returned.
Date_Holidays_Driver::getHolidays()
Returns all holidays that the driver knows.
Date_Holidays_Driver::getHolidaysForDatespan()
Returns an array containing a number of 
  1. Date_Holidays_Holiday
    2.
items.
Date_Holidays_Driver::getHolidayTitle()
Returns localized title for a holiday
Date_Holidays_Driver::getHolidayTitles()
Returns localized titles of all holidays or those accepted by the filter
Date_Holidays_Driver::getInternalHolidayNames()
Returns the internal names of holidays that were calculated
Date_Holidays_Driver::getISO3166Codes()
Method that returns an array containing the ISO3166 codes that may possibly identify a driver.
Date_Holidays_Driver::getYear()
Returns the driver's current year
Date_Holidays_Driver::isHoliday()
Determines whether a date represents a holiday or not
Date_Holidays_Driver::removeDriver()
Remove a driver component
Date_Holidays_Driver::setLocale()
Sets the driver's locale
Date_Holidays_Driver::setYear()
Sets the driver's current year
Date_Holidays_Driver::_addHoliday()
Adds a holiday to the driver's holidays
Date_Holidays_Driver::_addStaticHolidays()
Adds all holidays in the array to the driver's internal list of holidays.
Date_Holidays_Driver::_addStringPropertiesForHoliday()
Adds a arbitrary number of localized string-properties for the specified holiday.
Date_Holidays_Driver::_addStringPropertyForHoliday()
Adds a localized (regrading translation etc.) string-property for a holiday.
Date_Holidays_Driver::_addTranslationData()
Add a language-file's content. Translations, properties, etc. for holidays will be made available with the specified locale.
Date_Holidays_Driver::_addTranslationForHoliday()
Add a localized translation for a holiday's title. Overwrites existing data.
Date_Holidays_Driver::_buildHolidays()
Build the internal arrays that contain data about the calculated holidays
Date_Holidays_Driver::_findBestLocale()
Finds the best internally available locale for the specified one
Date_Holidays_Driver::_removeHoliday()
Remove a holiday from internal storage

Class Details

[line 14]
Example how to create an own driver-class for Date_Holidays

To test this class, you have to copy it into the drivers-directory.

The classname has to be something like Date_Holidays_Driver_*. Otherwise it won't be compatible to be used within PEAR's strict directory structure.

  • Author: Carsten Lucke <luckec@tool-garage.de>
  • Version: $Id: Driver.php,v 1.20 2006/04/03 21:04:46 luckec Exp $


[ Top ]

Method Detail

Date_Holidays_Driver_Example (Constructor)   [line 23]

Date_Holidays_Driver_Example Date_Holidays_Driver_Example( )

Constructor

Use the Date_Holidays::factory() method to construct an object of a certain driver

  • Access: protected

[ Top ]

_buildHolidays   [line 34]

boolean _buildHolidays( )

Build the internal arrays that contain data about the calculated holidays
  • Return: true on success, otherwise a PEAR_ErrorStack object
  • Throws: object PEAR_ErrorStack
  • Access: protected

Overrides Date_Holidays_Driver::_buildHolidays() (Build the internal arrays that contain data about the calculated holidays)
[ Top ]
Documentation generated on Mon, 11 Mar 2019 15:03:06 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.