DispatcherInterface.php
1.9 KB
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
115
116
117
118
<?php
namespace Phalcon {
/**
* Phalcon\DispatcherInterface initializer
*/
interface DispatcherInterface {
/**
* Sets the default action suffix
*
* @param string $actionSuffix
*/
public function setActionSuffix($actionSuffix);
/**
* Sets the default namespace
*
* @param string $namespace
*/
public function setDefaultNamespace($namespace);
/**
* Sets the default action name
*
* @param string $actionName
*/
public function setDefaultAction($actionName);
/**
* Sets the action name to be dispatched
*
* @param string $actionName
*/
public function setActionName($actionName);
/**
* Gets last dispatched action name
*
* @return string
*/
public function getActionName();
/**
* Sets action params to be dispatched
*
* @param array $params
*/
public function setParams($params);
/**
* Gets action params
*
* @return array
*/
public function getParams();
/**
* Set a param by its name or numeric index
*
* @param mixed $param
* @param mixed $value
*/
public function setParam($param, $value);
/**
* Gets a param by its name or numeric index
*
* @param mixed $param
* @param string|array $filters
* @return mixed
*/
public function getParam($param, $filters=null);
/**
* Checks if the dispatch loop is finished or has more pendent controllers/tasks to disptach
*
* @return boolean
*/
public function isFinished();
/**
* Returns value returned by the lastest dispatched action
*
* @return mixed
*/
public function getReturnedValue();
/**
* Dispatches a handle action taking into account the routing parameters
*
* @return object
*/
public function dispatch();
/**
* Forwards the execution flow to another controller/action
*
* @param array $forward
*/
public function forward($forward);
}
}