Source for file Holidays.php

<?php
/* vim: set expandtab tabstop=4 shiftwidth=4: */
// +----------------------------------------------------------------------+
// | PHP Version 4                                                        |
// +----------------------------------------------------------------------+
// | Copyright (c) 1997-2002 The PHP Group                                |
// +----------------------------------------------------------------------+
// | This source file is subject to version 2.0 of the PHP license,       |
// | that is bundled with this package in the file LICENSE, and is        |
// | available at through the world-wide-web at                           |
// | http://www.php.net/license/2_02.txt.                                 |
// | If you did not receive a copy of the PHP license and are unable to   |
// | obtain it through the world-wide-web, please send a note to          |
// | license@php.net so we can mail you a copy immediately.               |
// +----------------------------------------------------------------------+
// | Authors:   Carsten Lucke <luckec@tool-garage.de>                     |
// +----------------------------------------------------------------------+
//
//    $Id: Holidays.php,v 1.13 2007/05/28 14:52:56 luckec Exp $
 
/**
 * uses PEAR errors
 */
require_once 'PEAR.php';
 
/**
 * uses PEAR::Date
 */
require_once 'Date.php';
 
/**
 * Class that wraps a holiday's data
 */
require_once 'Date/Holidays/Holiday.php';
 
/**
 * Driver baseclass
 */
require_once 'Date/Holidays/Driver.php';
 
/**
 * could not find file of driver-class
 *
 * @access  public
 */
define('DATE_HOLIDAYS_ERROR_DRIVERFILE_NOT_FOUND', 1);
 
/**
 * invalid argument was passed to a method
 *
 * @access  public
 */
define('DATE_HOLIDAYS_ERROR_INVALID_ARGUMENT', 2);
 
/**
 * Driver directory does not exist
 *
 * @access  public
 */
define('DATE_HOLIDAYS_ERROR_MISSING_DRIVER_DIR', 3);
 
/**
 * Filter directory does not exist
 *
 * @access  public
 */
define('DATE_HOLIDAYS_ERROR_MISSING_FILTER_DIR', 4);
 
/**
 * class that helps you to locate holidays for a year
 *
 * @abstract
 * @category Date
 * @package  Date_Holidays
 * @version  $Id: Holidays.php,v 1.13 2007/05/28 14:52:56 luckec Exp $
 * @author   Carsten Lucke <luckec@tool-garage.de>
 * @author   Stephan Schmidt <schst@php.net>
 */
class Date_Holidays
{
  /**
    * Constructor
    *
    * Use the Date_Holidays::factory() method to construct an object of a certain driver
    *
    * @access   protected
    */
    function Date_Holidays()
    {
    }
 
   /**
    * Factory method that creates a driver-object
    *
    * @static
    * @access   public
    * @param    string  $driverId   driver-name
    * @param    string  $year       year
    * @param    string  $locale     locale name
    * @return   object  Date_Holidays driver-object on success, otherwise a PEAR_Error object
    * @throws   object PEAR_Error
    */
    function factory($driverId, $year = null, $locale = null, $external = false)
    {
        if (! isset($GLOBALS['_DATE_HOLIDAYS']['DIE_ON_MISSING_LOCALE'])) {
            Date_Holidays::staticSetProperty('DIE_ON_MISSING_LOCALE', true);
        }
 
        $driverClass        = 'Date_Holidays_Driver_' . $driverId;
        if ($external) {
            $driverClass    = $driverId;
        }
 
        if (! class_exists($driverClass)) {
            $driverFile     = 'Date' . DIRECTORY_SEPARATOR . 'Holidays' . DIRECTORY_SEPARATOR .
                    'Driver' . DIRECTORY_SEPARATOR . $driverId . '.php';
            if ($external) {
                $driverFile = str_replace('_', DIRECTORY_SEPARATOR, $driverClass) . '.php';
            }
 
            @include_once $driverFile;
            if (! class_exists($driverClass)) {
                return Date_Holidays::raiseError(DATE_HOLIDAYS_ERROR_DRIVERFILE_NOT_FOUND,
                    'Couldn\'t find file of the driver-class,  filename: ' . $driverFile);
            }
        }
        $driver             = new $driverClass;
 
        if (is_null($year)) {
            $year           =   date('Y');
        }
        // sets internal var $_year and performs _buildHolidays()
        $res                =   $driver->setYear($year);
        if (Date_Holidays::isError($res)) {
            return $res;
        }
 
        if (is_null($locale)) {
            $locale         =   setlocale(LC_ALL, 0);
        }
        $driver->setLocale($locale);
        return $driver;
    }
 
   /**
    * Factory method that creates a driver-object
    *
    * @static
    * @access   public
    * @param    string  $isoCode    ISO3166 code identifying the driver
    * @param    string  $year       year
    * @param    string  $locale     locale name
    * @return   object  Date_Holidays driver-object on success, otherwise a PEAR_Error object
    * @throws   object PEAR_Error
    */
    function factoryISO3166($isoCode, $year = null, $locale = null, $external = false)
    {
        $driverDir = dirname(__FILE__) . DIRECTORY_SEPARATOR . 'Holidays' . DIRECTORY_SEPARATOR . 'Driver';
        if (! is_dir($driverDir)) {
            return Date_Holidays::raiseError(
                    DATE_HOLIDAYS_ERROR_DRIVERFILE_NOT_FOUND,
                    'Date_Holidays driver directory does not exist');
        }
 
        $driverMappings = array();
        $driverFiles    = array();
        $dh             = opendir($driverDir);
        while (false !== ($filename = readdir($dh))) {
            array_push($driverFiles, $filename);
        }
 
        foreach ($driverFiles as $driverFileName) {
 
            $file = dirname(__FILE__) . DIRECTORY_SEPARATOR . 'Holidays'
                    . DIRECTORY_SEPARATOR . 'Driver'
                    . DIRECTORY_SEPARATOR . $driverFileName;
            if (! is_file($file)) {
                continue;
            }
 
            $driverId       = str_replace('.php', '', $driverFileName);
            $driverClass    = 'Date_Holidays_Driver_' . $driverId;
            $driverFilePath = $driverDir . DIRECTORY_SEPARATOR . $driverFileName;
 
            @include_once $driverFilePath;
            if (! class_exists($driverClass)) {
                return Date_Holidays::raiseError(
                        DATE_HOLIDAYS_ERROR_DRIVERFILE_NOT_FOUND,
                        'Couldn\'t find file of the driver-class ' . $driverClass
                                . ',  filename: ' . $driverFilePath);
            }
 
            $isoCodes = call_user_func(
                    array(
                            $driverClass,
                            DATE_HOLIDAYS_DRIVER_IDENTIFY_ISO3166_METHOD));
 
            foreach ($isoCodes as $code) {
                if (strtolower($code) === $isoCode) {
                    return Date_Holidays::factory($driverId, $year, $locale, $external);
                }
            }
        }
 
        /*
         * If this line is reached the iso-code couldn't be mapped to
         * a driver-class and an error will be thrown.
         */
        return Date_Holidays::raiseError(DATE_HOLIDAYS_ERROR_DRIVERFILE_NOT_FOUND,
            'Couldn\'t find a driver for the given ISO 3166 code: ' . $isoCode);
 
    }
 
   /**
    * Returns a list of the installed drivers
    *
    * @access public
    * @static
    * @param  string      directory, where the drivers are installed
    * @return array 
    */
    function getInstalledDrivers($directory = null)
    {
        $drivers = array();
        if ($directory === null) {
            $directory = dirname(__FILE__) . '/Holidays/Driver';
        }
        if (!file_exists($directory) || !is_dir($directory)) {
            return PEAR::raiseError(DATE_HOLIDAYS_ERROR_MISSING_DRIVER_DIR, 'The driver directory "'.$directory.'" does not exist');
        }
        return Date_Holidays::_getModulesFromDir($directory);
    }
 
   /**
    * Returns a list of the installed filters
    *
    * @access public
    * @static
    * @param  string      directory, where the filters are installed
    * @return array 
    */
    function getInstalledFilters($directory = null)
    {
        $filters = array();
        if ($directory === null) {
            $directory = dirname(__FILE__) . '/Holidays/Filter';
        }
        if (!file_exists($directory) || !is_dir($directory)) {
            return PEAR::raiseError(DATE_HOLIDAYS_ERROR_MISSING_FILTER_DIR, 'The filter directory "'.$directory.'" does not exist');
        }
        return Date_Holidays::_getModulesFromDir($directory);
    }
 
   /**
    * Fetch all modules from a directory and its subdirectories
    *
    * @static
    * @access protected
    * @param  string        directory
    * @param  string        prefix for the class names, will be used in recursive calls
    */
    function _getModulesFromDir($dir, $prefix = '')
    {
        $modules = array();
        $d = dir($dir);
        while (false !== $moduleFile = $d->read()) {
            if ($moduleFile === '.' || $moduleFile === '..' || $moduleFile === 'CVS') {
                continue;
            }
            if (is_dir($dir.'/'.$moduleFile)) {
                $modules = array_merge($modules, Date_Holidays::_getModulesFromDir($dir.'/'.$moduleFile, $prefix.$moduleFile.'_'));
                continue;
            }
            $matches = array();
            if (preg_match('/(.*)\.php$/', $moduleFile, $matches)) {
                array_push($modules, array('id' => $prefix.$matches[1], 'title' => $prefix.$matches[1]));
            }
        }
        return $modules;
    }
 
   /**
    * Returns the error-stack
    *
    * @static
    * @access   public
    * @return   object PEAR_ErrorStack  error-stack
    */
    function &getErrorStack()
    {
        return PEAR_ErrorStack::singleton('Date_Holidays', false, false, true);
    }
 
   /**
    * Pushes a new error on the error-stack and returns a PEAR_Error object
    *
    * @static
    * @access   public
    * @param    int     $code   error-code
    * @param    string  $msg    error-message
    * @return   object PEAR_Error 
    */
    function raiseError($code, $msg = null)
    {
        $errorStack = &Date_Holidays::getErrorStack();
        return $errorStack->push($code, 'error', array(), $msg, false, debug_backtrace());
    }
 
   /**
    * Checks a variable to determine whether it represnts an error object or not
    *
    * @static
    * @access   public
    * @param    mixed   $data   variable to test
    * @param    int     $code   if $data is an PEAR_Error object, return true
    *                            only if $code is a string and
    *                            $obj->getMessage() == $code or
    *                            $code is an integer and $obj->getCode() == $code
    * @return   boolean true if $subject is an error object
    */
    function isError($data, $code = null)
    {
        $errorClass = get_class($data);
        switch (strtolower($errorClass)) {
            case 'pear_error':
                return PEAR::isError($data, $code);
            case 'pear_errorstack':
                return $data->hasErrors();
        }
        return false;
    }
 
   /**
    * Checks whether errors occured
    *
    * @static
    * @access   public
    * @return   boolean true if errors occurred
    */
    function errorsOccurred()
    {
        $errorStack = &Date_Holidays::getErrorStack();
        return $errorStack->hasErrors();
    }
 
   /**
    * Returns the errors the error-stack contains
    *
    * @static
    * @access   public
    * @param    boolean $purge  true if the stall shall be purged
    * @return   array   errors
    */
    function getErrors($purge = false)
    {
        $errorStack = &Date_Holidays::getErrorStack();
        return $errorStack->getErrors($purge);
    }
 
   /**
    * Set a property for the Date_Holidays drivers
    *
    * Available properties:
    * <pre>
    * DIE_ON_MISSING_LOCALE = boolean
    *   false: if no localized holiday-title is found an error will be returned
    *   true: if no localized holiday-title is found the default translation (English) will be used
    * </pre>
    *
    * @static
    * @access   public
    * @param    string  $prop   property
    * @param    string  $value  property-value
    */
    function staticSetProperty($prop, $value)
    {
        if (! isset($GLOBALS['_DATE_HOLIDAYS'])) {
            $GLOBALS['_DATE_HOLIDAYS'] = array();
        }
 
        switch ($prop) {
            case 'DIE_ON_MISSING_LOCALE':
                if (is_bool($value)) {
                    $GLOBALS['_DATE_HOLIDAYS'][$prop] = $value;
                }
                break;
        }
    }
 
   /**
    * Returns an internal property value
    *
    * @static
    * @access   public
    * @param    string  $prop   property-name
    * @return   mixed   property value on success, otherwise null
    */
    function staticGetProperty($prop)
    {
        if (! isset($GLOBALS['_DATE_HOLIDAYS'])) {
            return null;
        }
 
        switch ($prop) {
            case 'DIE_ON_MISSING_LOCALE':
                if (isset($GLOBALS['_DATE_HOLIDAYS'][$prop])) {
                    return $GLOBALS['_DATE_HOLIDAYS'][$prop];
                }
        }
 
        return null;
    }
}
?>