Blame view

Slim/Middleware.php 3.02 KB
219b8036   luigser   DEEP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
  <?php
  /**
   * Slim - a micro PHP 5 framework
   *
   * @author      Josh Lockhart <info@slimframework.com>
   * @copyright   2011 Josh Lockhart
   * @link        http://www.slimframework.com
   * @license     http://www.slimframework.com/license
   * @version     2.6.1
   * @package     Slim
   *
   * MIT LICENSE
   *
   * Permission is hereby granted, free of charge, to any person obtaining
   * a copy of this software and associated documentation files (the
   * "Software"), to deal in the Software without restriction, including
   * without limitation the rights to use, copy, modify, merge, publish,
   * distribute, sublicense, and/or sell copies of the Software, and to
   * permit persons to whom the Software is furnished to do so, subject to
   * the following conditions:
   *
   * The above copyright notice and this permission notice shall be
   * included in all copies or substantial portions of the Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
   * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
   * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
   * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
   * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
   * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
   */
  namespace Slim;
  
  /**
   * Middleware
   *
   * @package Slim
   * @author  Josh Lockhart
   * @since   1.6.0
   */
  abstract class Middleware
  {
      /**
       * @var \Slim\Slim Reference to the primary application instance
       */
      protected $app;
  
      /**
       * @var mixed Reference to the next downstream middleware
       */
      protected $next;
  
      /**
       * Set application
       *
       * This method injects the primary Slim application instance into
       * this middleware.
       *
       * @param  \Slim\Slim $application
       */
      final public function setApplication($application)
      {
          $this->app = $application;
      }
  
      /**
       * Get application
       *
       * This method retrieves the application previously injected
       * into this middleware.
       *
       * @return \Slim\Slim
       */
      final public function getApplication()
      {
          return $this->app;
      }
  
      /**
       * Set next middleware
       *
       * This method injects the next downstream middleware into
       * this middleware so that it may optionally be called
       * when appropriate.
       *
       * @param \Slim|\Slim\Middleware
       */
      final public function setNextMiddleware($nextMiddleware)
      {
          $this->next = $nextMiddleware;
      }
  
      /**
       * Get next middleware
       *
       * This method retrieves the next downstream middleware
       * previously injected into this middleware.
       *
       * @return \Slim\Slim|\Slim\Middleware
       */
      final public function getNextMiddleware()
      {
          return $this->next;
      }
  
      /**
       * Call
       *
       * Perform actions specific to this middleware and optionally
       * call the next downstream middleware.
       */
      abstract public function call();
  }