* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ /** * 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 $ */ abstract class sfOutputEscaperGetterDecorator extends sfOutputEscaper { /** * Returns the raw, unescaped value associated with the key supplied. * * The key might be an index into an array or a value to be passed to the * decorated object's get() method. * * @param string $key The key to retrieve * * @return mixed The value */ public abstract function getRaw($key); /** * Returns the escaped value associated with the key supplied. * * Typically (using this implementation) the raw value is obtained using the * {@link getRaw()} method, escaped and the result returned. * * @param string $key The key to retieve * @param string $escapingMethod The escaping method (a PHP function) to use * * @return mixed The escaped value */ public function get($key, $escapingMethod = null) { if (!$escapingMethod) { $escapingMethod = $this->escapingMethod; } return sfOutputEscaper::escape($escapingMethod, $this->getRaw($key)); } }