[Summary view] [Print] [Text view]

   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-2015 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\Stdlib\Hydrator;
  11  
  12  use Zend\Stdlib\Hydrator\Filter\FilterInterface;
  13  use Zend\Stdlib\Hydrator\Filter\FilterComposite;
  14  use Zend\Stdlib\Hydrator\Filter\FilterProviderInterface;
  15  
  16  interface FilterEnabledInterface extends FilterProviderInterface
  17  {
  18      /**
  19       * Add a new filter to take care of what needs to be hydrated.
  20       * To exclude e.g. the method getServiceLocator:
  21       *
  22       * <code>
  23       * $composite->addFilter(
  24       *     "servicelocator",
  25       *     function ($property) {
  26       *         list($class, $method) = explode('::', $property);
  27       *         if ($method === 'getServiceLocator') {
  28       *             return false;
  29       *         }
  30       *         return true;
  31       *     },
  32       *     FilterComposite::CONDITION_AND
  33       * );
  34       * </code>
  35       *
  36       * @param string $name Index in the composite
  37       * @param callable|FilterInterface $filter
  38       * @param int $condition
  39       * @return FilterComposite
  40       */
  41      public function addFilter($name, $filter, $condition = FilterComposite::CONDITION_OR);
  42  
  43      /**
  44       * Check whether a specific filter exists at key $name or not
  45       *
  46       * @param string $name Index in the composite
  47       * @return bool
  48       */
  49      public function hasFilter($name);
  50  
  51      /**
  52       * Remove a filter from the composition.
  53       * To not extract "has" methods, you simply need to unregister it
  54       *
  55       * <code>
  56       * $filterComposite->removeFilter('has');
  57       * </code>
  58       *
  59       * @param $name
  60       * @return FilterComposite
  61       */
  62      public function removeFilter($name);
  63  }