1. sfOutputEscaperIteratorDecorator.class.php
  2. /**
 * Output escaping iterator decorator.
 *
 * This takes an object that implements the Traversable interface and turns it
 * into an iterator with each value escaped.
 *
 * Note: Prior to PHP 5.1, the IteratorIterator class was not implemented in the
 * core of PHP. This means that although it will still work with classes that
 * implement Iterator or IteratorAggregate, internal PHP classes that only
 * implement the Traversable interface will cause the constructor to throw an
 * exception.
 *
 * @see        sfOutputEscaper
 * @package    symfony
 * @subpackage view
 * @author     Mike Squire 
 * @version    SVN: $Id: sfOutputEscaperIteratorDecorator.class.php 23436 2009-10-29 16:10:39Z fabien $
 */
  3. class sfOutputEscaperIteratorDecorator extends sfOutputEscaperObjectDecorator implements Iterator, ArrayAccess
  4. {
  5.   /**
  6.    * The iterator to be used.
  7.    *
  8.    * @var IteratorIterator
  9.    */
  10.   private $iterator;
  12.   /**
  13.    * Constructs a new escaping iteratoror using the escaping method and value supplied.
  14.    *
  15.    * @param string      $escapingMethod  The escaping method to use
  16.    * @param Traversable $value           The iterator to escape
  17.    */
  18.   public function __construct($escapingMethod, Traversable $value)
  19.   {
  20.     // Set the original value for __call(). Set our own iterator because passing
  21.     // it to IteratorIterator will lose any other method calls.
  23.     parent::__construct($escapingMethod, $value);
  25.     $this->iterator = new IteratorIterator($value);
  26.   }
  28.   /**
  29.    * Resets the iterator (as required by the Iterator interface).
  30.    *
  31.    * @return bool true, if the iterator rewinds successfully otherwise false
  32.    */
  33.   public function rewind()
  34.   {
  35.     return $this->iterator->rewind();
  36.   }
  38.   /**
  39.    * Escapes and gets the current element (as required by the Iterator interface).
  40.    *
  41.    * @return mixed The escaped value
  42.    */
  43.   public function current()
  44.   {
  45.     return sfOutputEscaper::escape($this->escapingMethod, $this->iterator->current());
  46.   }
  48.   /**
  49.    * Gets the current key (as required by the Iterator interface).
  50.    *
  51.    * @return string Iterator key
  52.    */
  53.   public function key()
  54.   {
  55.     return $this->iterator->key();
  56.   }
  58.   /**
  59.    * Moves to the next element in the iterator (as required by the Iterator interface).
  60.    */
  61.   public function next()
  62.   {
  63.     return $this->iterator->next();
  64.   }
  66.   /**
  67.    * Returns whether the current element is valid or not (as required by the
  68.    * Iterator interface).
  69.    *
  70.    * @return bool true if the current element is valid; false otherwise
  71.    */
  72.   public function valid()
  73.   {
  74.     return $this->iterator->valid();
  75.   }
  77.   /**
  78.    * Returns true if the supplied offset isset in the array (as required by the ArrayAccess interface).
  79.    *
  80.    * @param  string $offset  The offset of the value to check existance of
  81.    *
  82.    * @return bool true if the offset isset; false otherwise
  83.    */
  84.   public function offsetExists($offset)
  85.   {
  86.     return isset($this->value[$offset]);
  87.   }
  89.   /**
  90.    * Returns the element associated with the offset supplied (as required by the ArrayAccess interface).
  91.    *
  92.    * @param  string $offset  The offset of the value to get
  93.    *
  94.    * @return mixed The escaped value
  95.    */
  96.   public function offsetGet($offset)
  97.   {
  98.     return sfOutputEscaper::escape($this->escapingMethod, $this->value[$offset]);
  99.   }
  101.   /**
  102.    * Throws an exception saying that values cannot be set (this method is
  103.    * required for the ArrayAccess interface).
  104.    *
  105.    * This (and the other sfOutputEscaper classes) are designed to be read only
  106.    * so this is an illegal operation.
  107.    *
  108.    * @param  string $offset  (ignored)
  109.    * @param  string $value   (ignored)
  110.    *
  111.    * @throws sfException
  112.    */
  113.   public function offsetSet($offset, $value)
  114.   {
  115.     throw new sfException('Cannot set values.');
  116.   }
  118.   /**
  119.    * Throws an exception saying that values cannot be unset (this method is
  120.    * required for the ArrayAccess interface).
  121.    *
  122.    * This (and the other sfOutputEscaper classes) are designed to be read only
  123.    * so this is an illegal operation.
  124.    *
  125.    * @param  string $offset  (ignored)
  126.    *
  127.    * @throws sfException
  128.    */
  129.   public function offsetUnset($offset)
  130.   {
  131.     throw new sfException('Cannot unset values.');
  132.   }
  133. }
Debug toolbar