[Sommaire] [Imprimer]

   1  <?php
   2  
   3  /*
   4   *  $Id: BaseParamFilterReader.php 3076 2006-12-18 08:52:12Z fabien $
   5   *
   6   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   7   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   8   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   9   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  10   * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  11   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  12   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  13   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  14   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  15   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  16   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  17   *
  18   * This software consists of voluntary contributions made by many individuals
  19   * and is licensed under the LGPL. For more information please see
  20   * <http://phing.info>.
  21  */
  22  
  23  include_once 'phing/filters/BaseFilterReader.php';
  24  include_once 'phing/types/Parameterizable.php';
  25  include_once 'phing/types/Parameter.php';
  26  
  27  /**
  28   * Base class for core filter readers.
  29   *
  30   * @author <a href="mailto:yl@seasonfive.com">Yannick Lecaillez</a>
  31   * @copyright © 2003 seasonfive. All rights reserved
  32   * @version   $Revision: 1.5 $ $Date: 2005/02/27 20:52:08 $
  33   * @access    public
  34   * @see       FilterReader
  35   * @package   phing.filters
  36   */
  37  class BaseParamFilterReader extends BaseFilterReader implements Parameterizable {
  38      
  39      /** The passed in parameter array. */
  40      protected $_parameters = array();
  41      
  42      /*
  43       * Sets the parameters used by this filter, and sets
  44       * the filter to an uninitialized status.
  45       * 
  46       * @param array Array of parameters to be used by this filter.
  47       *              Should not be <code>null</code>.
  48      */
  49      function setParameters($parameters) {
  50          // type check, error must never occur, bad code of it does
  51          if ( !is_array($parameters) ) {
  52              throw new Exception("Expected parameters array got something else");            
  53          }
  54  
  55          $this->_parameters = $parameters;
  56          $this->setInitialized(false);
  57      }
  58  
  59      /*
  60       * Returns the parameters to be used by this filter.
  61       * 
  62       * @return the parameters to be used by this filter
  63      */
  64      function &getParameters() {
  65          return $this->_parameters;
  66      }
  67  }
  68  
  69  ?>