1. sfFilter.class.php
  2. /**
 * sfFilter provides a way for you to intercept incoming requests or outgoing responses.
 *
 * @package    symfony
 * @subpackage filter
 * @author     Fabien Potencier 
 * @author     Sean Kerr 
 * @version    SVN: $Id: sfFilter.class.php 23810 2009-11-12 11:07:44Z Kris.Wallsmith $
 */
  3. abstract class sfFilter
  4. {
  5.   protected
  6.     $parameterHolder = null,
  7.     $context         = null;
  9.   public static
  10.     $filterCalled    = array();
  12.   /**
  13.    * Class constructor.
  14.    *
  15.    * @see initialize()
  16.    */
  17.   public function __construct($context, $parameters = array())
  18.   {
  19.     $this->initialize($context, $parameters);
  20.   }
  22.   /**
  23.    * Initializes this Filter.
  24.    *
  25.    * @param sfContext $context    The current application context
  26.    * @param array     $parameters An associative array of initialization parameters
  27.    *
  28.    * @return boolean true
  29.    */
  30.   public function initialize($context, $parameters = array())
  31.   {
  32.     $this->context = $context;
  34.     $this->parameterHolder = new sfParameterHolder();
  35.     $this->parameterHolder->add($parameters);
  37.     return true;
  38.   }
  40.   /**
  41.    * Returns true if this is the first call to the sfFilter instance.
  42.    *
  43.    * @return boolean true if this is the first call to the sfFilter instance, false otherwise
  44.    */
  45.   protected function isFirstCall()
  46.   {
  47.     $class = get_class($this);
  48.     if (isset(self::$filterCalled[$class]))
  49.     {
  50.       return false;
  51.     }
  52.     else
  53.     {
  54.       self::$filterCalled[$class] = true;
  56.       return true;
  57.     }
  58.   }
  60.   /**
  61.    * Retrieves the current application context.
  62.    *
  63.    * @return sfContext The current sfContext instance
  64.    */
  65.   public final function getContext()
  66.   {
  67.     return $this->context;
  68.   }
  70.   /**
  71.    * Gets the parameter holder for this object.
  72.    *
  73.    * @return sfParameterHolder A sfParameterHolder instance
  74.    */
  75.   public function getParameterHolder()
  76.   {
  77.     return $this->parameterHolder;
  78.   }
  80.   /**
  81.    * Gets the parameter associated with the given key.
  82.    *
  83.    * This is a shortcut for:
  84.    *
  85.    * <code>$this->getParameterHolder()->get()</code>
  86.    *
  87.    * @param string $name    The key name
  88.    * @param string $default The default value
  89.    *
  90.    * @return string The value associated with the key
  91.    *
  92.    * @see sfParameterHolder
  93.    */
  94.   public function getParameter($name, $default = null)
  95.   {
  96.     return $this->parameterHolder->get($name, $default);
  97.   }
  99.   /**
  100.    * Returns true if the given key exists in the parameter holder.
  101.    *
  102.    * This is a shortcut for:
  103.    *
  104.    * <code>$this->getParameterHolder()->has()</code>
  105.    *
  106.    * @param string $name The key name
  107.    *
  108.    * @return boolean true if the given key exists, false otherwise
  109.    *
  110.    * @see sfParameterHolder
  111.    */
  112.   public function hasParameter($name)
  113.   {
  114.     return $this->parameterHolder->has($name);
  115.   }
  117.   /**
  118.    * Sets the value for the given key.
  119.    *
  120.    * This is a shortcut for:
  121.    *
  122.    * <code>$this->getParameterHolder()->set()</code>
  123.    *
  124.    * @param string $name  The key name
  125.    * @param string $value The value
  126.    *
  127.    * @see sfParameterHolder
  128.    */
  129.   public function setParameter($name, $value)
  130.   {
  131.     return $this->parameterHolder->set($name, $value);
  132.   }
  133. }
Debug toolbar