[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Zend Framework (http://framework.zend.com/)
   4   *
   5   * @link      http://github.com/zendframework/zend-eventmanager for the canonical source repository
   6   * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
   7   * @license   https://github.com/zendframework/zend-eventmanager/blob/master/LICENSE.md
   8   */
   9  
  10  namespace Zend\EventManager\Filter;
  11  
  12  use Zend\EventManager\ResponseCollection;
  13  
  14  /**
  15   * Interface for intercepting filter chains
  16   */
  17  interface FilterInterface
  18  {
  19      /**
  20       * Execute the filter chain
  21       *
  22       * @param  string|object $context
  23       * @param  array $params
  24       * @return mixed
  25       */
  26      public function run($context, array $params = []);
  27  
  28      /**
  29       * Attach an intercepting filter
  30       *
  31       * @param  callable $callback
  32       */
  33      public function attach(callable $callback);
  34  
  35      /**
  36       * Detach an intercepting filter
  37       *
  38       * @param  callable $filter
  39       * @return bool
  40       */
  41      public function detach(callable $filter);
  42  
  43      /**
  44       * Get all intercepting filters
  45       *
  46       * @return array
  47       */
  48      public function getFilters();
  49  
  50      /**
  51       * Clear all filters
  52       *
  53       * @return void
  54       */
  55      public function clearFilters();
  56  
  57      /**
  58       * Get all filter responses
  59       *
  60       * @return ResponseCollection
  61       */
  62      public function getResponses();
  63  }