1. sfOutputEscaperGetterDecorator.class.php
  2. /**
 * Abstract output escaping decorator class for "getter" objects.
 *
 * @see        sfOutputEscaper
 * @package    symfony
 * @subpackage view
 * @author     Mike Squire 
 * @version    SVN: $Id: sfOutputEscaperGetterDecorator.class.php 9047 2008-05-19 08:43:05Z FabianLange $
 */
  3. abstract class sfOutputEscaperGetterDecorator extends sfOutputEscaper
  4. {
  5.   /**
  6.    * Returns the raw, unescaped value associated with the key supplied.
  7.    *
  8.    * The key might be an index into an array or a value to be passed to the 
  9.    * decorated object's get() method.
  10.    *
  11.    * @param  string $key  The key to retrieve
  12.    *
  13.    * @return mixed The value
  14.    */
  15.   public abstract function getRaw($key);
  17.   /**
  18.    * Returns the escaped value associated with the key supplied.
  19.    *
  20.    * Typically (using this implementation) the raw value is obtained using the
  21.    * {@link getRaw()} method, escaped and the result returned.
  22.    *
  23.    * @param  string $key             The key to retieve
  24.    * @param  string $escapingMethod  The escaping method (a PHP function) to use
  25.    *
  26.    * @return mixed The escaped value
  27.    */
  28.   public function get($key, $escapingMethod = null)
  29.   {
  30.     if (!$escapingMethod)
  31.     {
  32.       $escapingMethod = $this->escapingMethod;
  33.     }
  35.     return sfOutputEscaper::escape($escapingMethod, $this->getRaw($key));
  36.   }
  37. }
Debug toolbar