RouteInterface.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
<?php 
namespace Phalcon\Mvc\Router {
	/**
	 * Phalcon\Mvc\Router\RouteInterface initializer
	 */
	
	interface RouteInterface {
		/**
		 * \Phalcon\Mvc\Router\Route constructor
		 *
		 * @param string $pattern
		 * @param array $paths
		 * @param array|string $httpMethods
		 */
		public function __construct($pattern, $paths=null, $httpMethods=null);
		/**
		 * Replaces placeholders from pattern returning a valid PCRE regular expression
		 *
		 * @param string $pattern
		 * @return string
		 */
		public function compilePattern($pattern);
		/**
		 * Set one or more HTTP methods that constraint the matching of the route
		 *
		 * @param string|array $httpMethods
		 */
		public function via($httpMethods);
		/**
		 * Reconfigure the route adding a new pattern and a set of paths
		 *
		 * @param string $pattern
		 * @param array $paths
		 */
		public function reConfigure($pattern, $paths=null);
		/**
		 * Returns the route's name
		 *
		 * @return string
		 */
		public function getName();
		/**
		 * Sets the route's name
		 *
		 * @param string $name
		 */
		public function setName($name);
		/**
		 * Sets a set of HTTP methods that constraint the matching of the route
		 *
		 * @param string|array $httpMethods
		 */
		public function setHttpMethods($httpMethods);
		/**
		 * Returns the route's id
		 *
		 * @return string
		 */
		public function getRouteId();
		/**
		 * Returns the route's pattern
		 *
		 * @return string
		 */
		public function getPattern();
		/**
		 * Returns the route's pattern
		 *
		 * @return string
		 */
		public function getCompiledPattern();
		/**
		 * Returns the paths
		 *
		 * @return array
		 */
		public function getPaths();
		/**
		 * Returns the HTTP methods that constraint matching the route
		 *
		 * @return string|array
		 */
		public function getHttpMethods();
		/**
		 * Resets the internal route id generator
		 */
		public static function reset();
	}
}