|
1
|
|
|
<?php |
|
2
|
|
|
namespace Agavi\Routing; |
|
3
|
|
|
|
|
4
|
|
|
// +---------------------------------------------------------------------------+ |
|
5
|
|
|
// | This file is part of the Agavi package. | |
|
6
|
|
|
// | Copyright (c) 2005-2011 the Agavi Project. | |
|
7
|
|
|
// | | |
|
8
|
|
|
// | For the full copyright and license information, please view the LICENSE | |
|
9
|
|
|
// | file that was distributed with this source code. You can also view the | |
|
10
|
|
|
// | LICENSE file online at http://www.agavi.org/LICENSE.txt | |
|
11
|
|
|
// | vi: set noexpandtab: | |
|
12
|
|
|
// | Local Variables: | |
|
13
|
|
|
// | indent-tabs-mode: t | |
|
14
|
|
|
// | End: | |
|
15
|
|
|
// +---------------------------------------------------------------------------+ |
|
16
|
|
|
use Agavi\Core\Context; |
|
17
|
|
|
use Agavi\Dispatcher\ExecutionContainer; |
|
18
|
|
|
use Agavi\Util\ParameterHolder; |
|
19
|
|
|
|
|
20
|
|
|
/** |
|
21
|
|
|
* RoutingCallback allows you to provide callbacks into the routing |
|
22
|
|
|
* |
|
23
|
|
|
* @package agavi |
|
24
|
|
|
* @subpackage routing |
|
25
|
|
|
* |
|
26
|
|
|
* @author Dominik del Bondio <[email protected]> |
|
27
|
|
|
* @copyright Authors |
|
28
|
|
|
* @copyright The Agavi Project |
|
29
|
|
|
* |
|
30
|
|
|
* @since 0.11.0 |
|
31
|
|
|
* |
|
32
|
|
|
* @version $Id$ |
|
33
|
|
|
*/ |
|
34
|
|
|
abstract class RoutingCallback extends ParameterHolder |
|
35
|
|
|
{ |
|
36
|
|
|
/** |
|
37
|
|
|
* @var Context An Context instance. |
|
38
|
|
|
*/ |
|
39
|
|
|
protected $context = null; |
|
40
|
|
|
|
|
41
|
|
|
/** |
|
42
|
|
|
* @var array An array with information about the route. |
|
43
|
|
|
*/ |
|
44
|
|
|
protected $route = null; |
|
45
|
|
|
|
|
46
|
|
|
/** |
|
47
|
|
|
* Initialize the callback instance. |
|
48
|
|
|
* |
|
49
|
|
|
* @param Context $context A Context instance. |
|
50
|
|
|
* @param array $route An array with information about the route. |
|
51
|
|
|
* |
|
52
|
|
|
* @author Dominik del Bondio <[email protected]> |
|
53
|
|
|
* @since 0.11.0 |
|
54
|
|
|
*/ |
|
55
|
|
|
public function initialize(Context $context, array &$route) |
|
56
|
|
|
{ |
|
57
|
|
|
$this->context = $context; |
|
58
|
|
|
$this->route =& $route; |
|
59
|
|
|
} |
|
60
|
|
|
|
|
61
|
|
|
/** |
|
62
|
|
|
* Retrieve the current application context. |
|
63
|
|
|
* |
|
64
|
|
|
* @return Context An Context instance. |
|
65
|
|
|
* |
|
66
|
|
|
* @author Dominik del Bondio <[email protected]> |
|
67
|
|
|
* @since 0.11.0 |
|
68
|
|
|
*/ |
|
69
|
|
|
final public function getContext() |
|
70
|
|
|
{ |
|
71
|
|
|
return $this->context; |
|
72
|
|
|
} |
|
73
|
|
|
|
|
74
|
|
|
/** |
|
75
|
|
|
* Gets executed when the route of this callback route matched. |
|
76
|
|
|
* |
|
77
|
|
|
* @param array $parameters The parameters generated by this route. |
|
78
|
|
|
* @param ExecutionContainer $container The original execution container. |
|
79
|
|
|
* |
|
80
|
|
|
* @return bool Whether the routing should handle the route as matched. |
|
81
|
|
|
* |
|
82
|
|
|
* @author Dominik del Bondio <[email protected]> |
|
83
|
|
|
* @since 0.11.0 |
|
84
|
|
|
*/ |
|
85
|
|
|
public function onMatched(array &$parameters, ExecutionContainer $container) |
|
|
|
|
|
|
86
|
|
|
{ |
|
87
|
|
|
return true; |
|
88
|
|
|
} |
|
89
|
|
|
|
|
90
|
|
|
/** |
|
91
|
|
|
* Gets executed when the route of this callback route did not match. |
|
92
|
|
|
* |
|
93
|
|
|
* @param ExecutionContainer $container The original execution container. |
|
94
|
|
|
* |
|
95
|
|
|
* @author Dominik del Bondio <[email protected]> |
|
96
|
|
|
* @since 0.11.0 |
|
97
|
|
|
*/ |
|
98
|
|
|
public function onNotMatched(ExecutionContainer $container) |
|
|
|
|
|
|
99
|
|
|
{ |
|
100
|
|
|
return; |
|
101
|
|
|
} |
|
102
|
|
|
|
|
103
|
|
|
/** |
|
104
|
|
|
* Gets executed when the route of this callback is about to be reverse |
|
105
|
|
|
* generated into an URL. |
|
106
|
|
|
* |
|
107
|
|
|
* @param array $defaultParameters The default parameters stored in the route. |
|
108
|
|
|
* @param array $userParameters The parameters the user supplied to AgaviRouting::gen(). |
|
109
|
|
|
* @param array $userOptions The options the user supplied to AgaviRouting::gen(). |
|
110
|
|
|
* |
|
111
|
|
|
* @return bool Whether this route part should be generated. |
|
112
|
|
|
* |
|
113
|
|
|
* @author Dominik del Bondio <[email protected]> |
|
114
|
|
|
* @since 0.11.0 |
|
115
|
|
|
*/ |
|
116
|
|
|
public function onGenerate(array $defaultParameters, array &$userParameters, array &$userOptions) |
|
|
|
|
|
|
117
|
|
|
{ |
|
118
|
|
|
return true; |
|
119
|
|
|
} |
|
120
|
|
|
} |
|
121
|
|
|
|
horros /
agavi2
Loading history...
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.