1. sfOutputEscaperArrayDecorator.class.php
  2. /**
 * Output escaping decorator class for arrays.
 *
 * @see        sfOutputEscaper
 * @package    symfony
 * @subpackage view
 * @author     Mike Squire 
 * @version    SVN: $Id: sfOutputEscaperArrayDecorator.class.php 9158 2008-05-21 20:32:00Z FabianLange $
 */
  3. class sfOutputEscaperArrayDecorator extends sfOutputEscaperGetterDecorator implements Iterator, ArrayAccess, Countable
  4. {
  5.   /**
  6.    * Used by the iterator to know if the current element is valid.
  7.    *
  8.    * @var int
  9.    */
  10.   private $count;
  12.   /**
  13.    * Reset the array to the beginning (as required for the Iterator interface).
  14.    */
  15.   public function rewind()
  16.   {
  17.     reset($this->value);
  19.     $this->count = count($this->value);
  20.   }
  22.   /**
  23.    * Get the key associated with the current value (as required by the Iterator interface).
  24.    *
  25.    * @return string The key
  26.    */
  27.   public function key()
  28.   {
  29.     return key($this->value);
  30.   }
  32.   /**
  33.    * Escapes and return the current value (as required by the Iterator interface).
  34.    *
  35.    * This escapes the value using {@link sfOutputEscaper::escape()} with
  36.    * whatever escaping method is set for this instance.
  37.    *
  38.    * @return mixed The escaped value
  39.    */
  40.   public function current()
  41.   {
  42.     return sfOutputEscaper::escape($this->escapingMethod, current($this->value));
  43.   }
  45.   /**
  46.    * Moves to the next element (as required by the Iterator interface).
  47.    */
  48.   public function next()
  49.   {
  50.     next($this->value);
  52.     $this->count --;
  53.   }
  55.   /**
  56.    * Returns true if the current element is valid (as required by the Iterator interface).
  57.    *
  58.    * The current element will not be valid if {@link next()} has fallen off the
  59.    * end of the array or if there are no elements in the array and {@link
  60.    * rewind()} was called.
  61.    *
  62.    * @return bool The validity of the current element; true if it is valid
  63.    */
  64.   public function valid()
  65.   {
  66.     return $this->count > 0;
  67.   }
  69.   /**
  70.    * Returns true if the supplied offset isset in the array (as required by the ArrayAccess interface).
  71.    *
  72.    * @param  string $offset  The offset of the value to check existance of
  73.    *
  74.    * @return bool true if the offset isset; false otherwise
  75.    */
  76.   public function offsetExists($offset)
  77.   {
  78.     return isset($this->value[$offset]);
  79.   }
  81.   /**
  82.    * Returns the element associated with the offset supplied (as required by the ArrayAccess interface).
  83.    *
  84.    * @param  string $offset  The offset of the value to get
  85.    *
  86.    * @return mixed The escaped value
  87.    */
  88.   public function offsetGet($offset)
  89.   {
  90.     return sfOutputEscaper::escape($this->escapingMethod, $this->value[$offset]);
  91.   }
  93.   /**
  94.    * Throws an exception saying that values cannot be set (this method is
  95.    * required for the ArrayAccess interface).
  96.    *
  97.    * This (and the other sfOutputEscaper classes) are designed to be read only
  98.    * so this is an illegal operation.
  99.    *
  100.    * @param  string $offset  (ignored)
  101.    * @param  string $value   (ignored)
  102.    *
  103.    * @throws sfException
  104.    */
  105.   public function offsetSet($offset, $value)
  106.   {
  107.     throw new sfException('Cannot set values.');
  108.   }
  110.   /**
  111.    * Throws an exception saying that values cannot be unset (this method is
  112.    * required for the ArrayAccess interface).
  113.    *
  114.    * This (and the other sfOutputEscaper classes) are designed to be read only
  115.    * so this is an illegal operation.
  116.    *
  117.    * @param  string $offset  (ignored)
  118.    *
  119.    * @throws sfException
  120.    */
  121.   public function offsetUnset($offset)
  122.   {
  123.     throw new sfException('Cannot unset values.');
  124.   }
  126.   /**
  127.    * Returns the size of the array (are required by the Countable interface).
  128.    *
  129.    * @return int The size of the array
  130.    */
  131.   public function count()
  132.   {
  133.     return count($this->value);
  134.   }
  136.   /**
  137.    * Returns the (unescaped) value from the array associated with the key supplied.
  138.    *
  139.    * @param  string $key  The key into the array to use
  140.    *
  141.    * @return mixed The value
  142.    */
  143.   public function getRaw($key)
  144.   {
  145.     return $this->value[$key];
  146.   }
  147. }
Debug toolbar