Skip to content

Commit 1a12605

Browse files
meet-alekseymeet-aleksey
committed
Added support of catch-all to route pattern.
1 parent 7fa0b66 commit 1a12605

File tree

5 files changed

+125
-31
lines changed

5 files changed

+125
-31
lines changed

‎src/Route.php‎

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,14 @@ class Route {
8484
* @param array $constraints An associative array containing regular expressions for checking the elements of the route.
8585
* For example, $template is {controller}/{action}/{id}
8686
* $constraints = array('id' => '\w+')
87+
* @param bool $ignore Indicates that this ignore rule. Default: false.
8788
*/
88-
public function __construct($name = null, $template = null, $defaults = null, $constraints = null) {
89+
public function __construct($name = null, $template = null, $defaults = null, $constraints = null, $ignore = false) {
8990
$this->name = $name;
9091
$this->template = $template;
9192
$this->defaults = $defaults;
9293
$this->constraints = $constraints;
94+
$this->ignore = ($ignore === true);
9395
}
9496

9597
/**
@@ -181,6 +183,7 @@ private function extractSegments($route, $template, &$required) {
181183
$prevGlued = false;
182184
$segmentPattern = '';
183185
$optional = false;
186+
$catchAll = false;
184187
$default = null;
185188

186189
// parse name
@@ -201,9 +204,32 @@ private function extractSegments($route, $template, &$required) {
201204
$name = $name[0];
202205
}
203206

207+
// is catch-all
208+
if (count($name = explode('*', $name)) > 1) {
209+
$catchAll = true;
210+
$name = $name[1];
211+
}
212+
else {
213+
$name = $name[0];
214+
}
215+
216+
if ($catchAll && $i != $count - 1) {
217+
throw new RouteParsingException(
218+
$this,
219+
'A catch-all parameter can only appear as the last segment of the route template. ' .
220+
'Please check the route parameter "' . $name . '" in the route "' . $this->name . '".'
221+
);
222+
}
223+
204224
// default value is allowed or not
205225
if (!empty($default) && !empty($route->defaults[$name])) {
206-
throw new \Exception('The route parameter "' . $name . '" has both an inline default value and an explicit default value specified. A route parameter must not contain an inline default value when a default value is specified explicitly. Consider removing one of them.');
226+
throw new RouteParsingException(
227+
$this,
228+
'The route parameter "' . $name . '" in the route "' . $this->name . '" ' .
229+
'has both an inline default value and an explicit default value specified. ' .
230+
'A route parameter must not contain an inline default value when a default value is specified explicitly. ' .
231+
'Consider removing one of them.'
232+
);
207233
}
208234
elseif (empty($default) && !empty($route->defaults[$name])) {
209235
$default = $route->defaults[$name];
@@ -265,12 +291,18 @@ private function extractSegments($route, $template, &$required) {
265291
}
266292
}
267293
else {
268-
if (!empty($default)) {
269-
$segmentPattern = '(?<' . $name . '>[^\/]*)';
294+
if ($catchAll === true) {
295+
$segmentPattern = '(?<' . $name . '>.*)';
270296
$optional = true;
271297
}
272298
else {
273-
$segmentPattern = '(?<' . $name . '>[^\/]+)';
299+
if (!empty($default)) {
300+
$segmentPattern = '(?<' . $name . '>[^\/]*)';
301+
$optional = true;
302+
}
303+
else {
304+
$segmentPattern = '(?<' . $name . '>[^\/]+)';
305+
}
274306
}
275307
}
276308

@@ -317,7 +349,11 @@ private function extractSegments($route, $template, &$required) {
317349
$this->setBounds($segments);
318350

319351
if ($this->ignore !== true && ((empty($namedSegments['controller']) && empty($this->defaults['controller'])) || (empty($namedSegments['action']) && empty($this->defaults['action'])))) {
320-
throw new RouteSegmentsRequiredException($this);
352+
throw new RouteParsingException(
353+
$this,
354+
'The route "' . $this->name . '" must contain {controller} and {action}. ' .
355+
'If these elements are not present in the route template, then the default values for them must be defined in the route.'
356+
);
321357
}
322358

323359
$this->segmentsNamed = $namedSegments;

‎src/RouteParsingException.php‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?php
2+
namespace PhpMvc;
3+
4+
/**
5+
* Occurs when errors are detected during route parsing.
6+
*/
7+
class RouteParsingException extends \Exception {
8+
9+
/**
10+
* Initializes a new instance of the RouteSegmentsRequiredException.
11+
*
12+
* @param Route $route The route.
13+
* @param string|null $message The error message.
14+
*/
15+
public function __construct($route, $message = null) {
16+
if (!empty($message)) {
17+
parent::__construct($message);
18+
}
19+
else {
20+
parent::__construct('One or more errors occurred while parsing the route "' . $route->name . '"');
21+
}
22+
}
23+
24+
}

‎src/RouteSegmentsRequiredException.php‎

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎tests/FilterTest.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ public function testExecute2(): void
156156
echo 'Request: ' . $httpContext->getRequest()->rawUrl();
157157

158158
ob_start();
159-
159+
160160
Make::magic('PhpMvcTest', $httpContext, $this->basePath);
161161

162162
$result = ob_get_clean();

‎tests/RouteCollectionTest.php‎

Lines changed: 58 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,24 @@ public function testAddNonUniqueNameException(): void
5555
}
5656

5757
public function testGetRoute(): void {
58-
// routes
5958
$routes = new RouteCollection();
59+
$ignoreRoutes = new RouteCollection();
60+
61+
$ignoreRoutes->add(new Route('ignore-favicon', 'favicon.ico', null, null, true));
62+
63+
$ignoreRoutes->add(new Route(
64+
'ignore-preview',
65+
'preview{extension}',
66+
array(),
67+
array('extension' => '\.(png|jpg)'),
68+
true
69+
));
70+
71+
$ignoreRoutes->add(new Route(
72+
'ignore-content',
73+
'content/{*file}',
74+
null, null, true
75+
));
6076

6177
$routes->add(new Route(
6278
'defaultControllerAndAction',
@@ -108,6 +124,45 @@ public function testGetRoute(): void {
108124

109125
// test requests
110126
$requests = array(
127+
array(
128+
'uri' => '/content/images/preview.png',
129+
'expectRoute' => 'ignore-content',
130+
'expectSegments' => array(
131+
'file' => 'images/preview.png'
132+
),
133+
),
134+
array(
135+
'uri' => '/content/styles/home.css',
136+
'expectRoute' => 'ignore-content',
137+
'expectSegments' => array(
138+
'file' => 'styles/home.css'
139+
),
140+
),
141+
array(
142+
'uri' => '/content/scripts.js',
143+
'expectRoute' => 'ignore-content',
144+
'expectSegments' => array(
145+
'file' => 'scripts.js'
146+
),
147+
),
148+
array(
149+
'uri' => '/favicon.ico',
150+
'expectRoute' => 'ignore-favicon',
151+
'expectSegments' => array(),
152+
),
153+
array(
154+
'uri' => '/preview.png',
155+
'expectRoute' => 'ignore-preview',
156+
'expectSegments' => array('extension' => '.png'),
157+
),
158+
array(
159+
'uri' => '/preview.bmp',
160+
'expectRoute' => 'default',
161+
'expectSegments' => array(
162+
'controller' => 'preview.bmp',
163+
'action' => 'index',
164+
),
165+
),
111166
array(
112167
'uri' => '/',
113168
'expectRoute' => 'default',
@@ -260,13 +315,13 @@ public function testGetRoute(): void {
260315

261316
$httpContext = new HttpContext(
262317
$routes,
263-
null,
318+
$ignoreRoutes,
264319
array(
265320
'REQUEST_URI' => $request['uri']
266321
)
267322
);
268323

269-
$route = $routes->getRoute($httpContext);
324+
$route = $httpContext->getRoute();
270325

271326
if ($request['expectRoute'] !== null) {
272327
$this->assertNotNull($route);

0 commit comments

Comments
 (0)