CollectionInterface.php
3.06 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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<?php
namespace Phalcon\Mvc\Micro {
/**
* Phalcon\Mvc\Micro\CollectionInterface initializer
*/
interface CollectionInterface {
/**
* Sets a prefix for all routes added to the collection
*
* @param string $prefix
* @return \Phalcon\Mvc\Micro\Collection
*/
public function setPrefix($prefix);
/**
* Returns the collection prefix if any
*
* @return string
*/
public function getPrefix();
/**
* Returns the registered handlers
*
* @return array
*/
public function getHandlers();
/**
* Sets the main handler
*
* @param mixed $handler
* @param boolean $lazy
* @return \Phalcon\Mvc\Micro\Collection
*/
public function setHandler($handler, $lazy=null);
/**
* Sets if the main handler must be lazy loaded
*
* @param boolean $lazy
* @return \Phalcon\Mvc\Micro\Collection
*/
public function setLazy($lazy);
/**
* Returns if the main handler must be lazy loaded
*
* @return boolean
*/
public function isLazy();
/**
* Returns the main handler
*
* @return mixed
*/
public function getHandler();
/**
* Maps a route to a handler
*
* @param string $routePattern
* @param callable $handler
* @return \Phalcon\Mvc\Router\RouteInterface
*/
public function map($routePattern, $handler);
/**
* Maps a route to a handler that only matches if the HTTP method is GET
*
* @param string $routePattern
* @param callable $handler
* @return \Phalcon\Mvc\Router\RouteInterface
*/
public function get($routePattern, $handler);
/**
* Maps a route to a handler that only matches if the HTTP method is POST
*
* @param string $routePattern
* @param callable $handler
* @return \Phalcon\Mvc\Router\RouteInterface
*/
public function post($routePattern, $handler);
/**
* Maps a route to a handler that only matches if the HTTP method is PUT
*
* @param string $routePattern
* @param callable $handler
* @return \Phalcon\Mvc\Router\RouteInterface
*/
public function put($routePattern, $handler);
/**
* Maps a route to a handler that only matches if the HTTP method is PATCH
*
* @param string $routePattern
* @param callable $handler
* @return \Phalcon\Mvc\Router\RouteInterface
*/
public function patch($routePattern, $handler);
/**
* Maps a route to a handler that only matches if the HTTP method is HEAD
*
* @param string $routePattern
* @param callable $handler
* @return \Phalcon\Mvc\Router\RouteInterface
*/
public function head($routePattern, $handler);
/**
* Maps a route to a handler that only matches if the HTTP method is DELETE
*
* @param string $routePattern
* @param callable $handler
* @return \Phalcon\Mvc\Router\RouteInterface
*/
public function delete($routePattern, $handler);
/**
* Maps a route to a handler that only matches if the HTTP method is OPTIONS
*
* @param string $routePattern
* @param callable $handler
* @return \Phalcon\Mvc\Router\RouteInterface
*/
public function options($routePattern, $handler);
}
}