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

Source for file Filter.php

Documentation is available at Filter.php

  1. <?php
  2. /* vim: set expandtab tabstop=4 shiftwidth=4: */
  3. /**
  4.  * Filter.php
  5.  *
  6.  * PHP Version 5
  7.  *
  8.  * Copyright (c) 1997-2008 The PHP Group
  9.  *
  10.  * This source file is subject to version 2.0 of the PHP license,
  11.  * that is bundled with this package in the file LICENSE, and is
  12.  * available at through the world-wide-web at
  13.  * http://www.php.net/license/2_02.txt.
  14.  * If you did not receive a copy of the PHP license and are unable to
  15.  * obtain it through the world-wide-web, please send a note to
  16.  * license@php.net so we can mail you a copy immediately.
  17.  *
  18.  * @category Date
  19.  * @package  Date_Holidays
  20.  * @author   Carsten Lucke <luckec@tool-garage.de>
  21.  * @license  http://www.php.net/license/3_01.txt PHP License 3.0.1
  22.  * @version  CVS: $Id$
  23.  * @link     http://pear.php.net/package/Date_Holidays
  24.  */
  25.  
  26. /**
  27.  * Baseclass for a holiday-filter.
  28.  *
  29.  * @abstract
  30.  * @category Date
  31.  * @package  Date_Holidays
  32.  * @author   Carsten Lucke <luckec@tool-garage.de>
  33.  * @license  http://www.php.net/license/3_01.txt PHP License 3.0.1
  34.  * @version  CVS: $Id$
  35.  * @link     http://pear.php.net/package/Date_Holidays
  36.  */
  37. {
  38.     /**
  39.      * Internal names of holidays that are subject to the filter.
  40.      *
  41.      * @access   private
  42.      * @var      array 
  43.      */
  44.     var $_internalNames = array();
  45.  
  46.     /**
  47.      * Constructor.
  48.      *
  49.      * Creates a new filter that knows, which holidays the
  50.      * calculating driver shall be restricted to.
  51.      *
  52.      * @param array $holidays numerical array that contains internal
  53.      *                           names of holidays
  54.      */
  55.     function __construct($holidays)
  56.     {
  57.         if (is_array($holidays)) {
  58.             $holidays = array();
  59.         }
  60.  
  61.         $this->_internalNames $holidays;
  62.     }
  63.  
  64.     /**
  65.      * Constructor.
  66.      *
  67.      * Creates a new filter that knows, which holidays the
  68.      * calculating driver shall be restricted to.
  69.      *
  70.      * @param array $holidays numerical array that contains internal
  71.      *                           names of holidays
  72.      */
  73.     function Date_Holidays_Filter($holidays)
  74.     {
  75.         $this->__construct($holidays);
  76.     }
  77.  
  78.     /**
  79.      * Returns the internal names of holidays that are subject to the filter.
  80.      *
  81.      * @return array 
  82.      */
  83.     function getFilteredHolidays()
  84.     {
  85.         return $this->_internalNames;
  86.     }
  87.  
  88.     /**
  89.      * Sets the internal names of holidays that are subject to the filter.
  90.      *
  91.      * @param array $holidays internal holiday-names
  92.      *
  93.      * @return void 
  94.      */
  95.     function setFilteredHolidays($holidays)
  96.     {
  97.         if (is_array($holidays)) {
  98.             $holidays = array();
  99.         }
  100.  
  101.         $this->_internalNames $holidays;
  102.     }
  103.  
  104.     /**
  105.      * Lets the filter decide whether a holiday shall be processed or not.
  106.      *
  107.      * @param string $internalName a holidays' internal name
  108.      *
  109.      * @abstract
  110.      * @return   boolean true, if a holidays shall be processed, false otherwise
  111.      */
  112.     function accept($internalName)
  113.     {
  114.     }
  115. }
  116. ?>

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