interface/modules/zend_modules/library/Zend/Config/Processor/Filter.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Config\Processor;
  11
  12 use Zend\Config\Config;
  13 use Zend\Config\Exception;
  14 use Zend\Filter\FilterInterface as ZendFilter;
  15
  16 class Filter implements ProcessorInterface
  17 {
  18     /**
  19      * @var ZendFilter
  20      */
  21     protected $filter;
  22
  23     /**
  24      * Filter all config values using the supplied Zend\Filter
  25      *
  26      * @param ZendFilter $filter
  27      */
  28     public function __construct(ZendFilter $filter)
  29     {
  30         $this->setFilter($filter);
  31     }
  32
  33     /**
  34      * @param  ZendFilter $filter
  35      * @return Filter
  36      */
  37     public function setFilter(ZendFilter $filter)
  38     {
  39         $this->filter = $filter;
  40         return $this;
  41     }
  42
  43     /**
  44      * @return ZendFilter
  45      */
  46     public function getFilter()
  47     {
  48         return $this->filter;
  49     }
  50
  51     /**
  52      * Process
  53      *
  54      * @param  Config $config
  55      * @return Config
  56      * @throws Exception\InvalidArgumentException
  57      */
  58     public function process(Config $config)
  59     {
  60         if ($config->isReadOnly()) {
  61             throw new Exception\InvalidArgumentException('Cannot process config because it is read-only');
  62         }
  63
  64         /**
  65          * Walk through config and replace values
  66          */
  67         foreach ($config as $key => $val) {
  68             if ($val instanceof Config) {
  69                 $this->process($val);
  70             } else {
  71                 $config->$key = $this->filter->filter($val);
  72             }
  73         }
  74
  75         return $config;
  76     }
  77
  78     /**
  79      * Process a single value
  80      *
  81      * @param  mixed $value
  82      * @return mixed
  83      */
  84     public function processValue($value)
  85     {
  86         return $this->filter->filter($value);
  87     }
  88 }