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
|
<?php
/**
* Klein (klein.php) - A fast & flexible router for PHP
*
* @author Chris O'Hara <cohara87@gmail.com>
* @author Trevor Suarez (Rican7) (contributor and v2 refactorer)
* @copyright (c) Chris O'Hara
* @link https://github.com/klein/klein.php
* @license MIT
*/
namespace Klein\DataCollection;
use Klein\Route;
/**
* RouteCollection
*
* A DataCollection for Routes
*/
class RouteCollection extends DataCollection
{
/**
* Methods
*/
/**
* Constructor
*
* @override (doesn't call our parent)
* @param array $routes The routes of this collection
*/
public function __construct(array $routes = array())
{
foreach ($routes as $value) {
$this->add($value);
}
}
/**
* Set a route
*
* {@inheritdoc}
*
* A value may either be a callable or a Route instance
* Callable values will be converted into a Route with
* the "name" of the route being set from the "key"
*
* A developer may add a named route to the collection
* by passing the name of the route as the "$key" and an
* instance of a Route as the "$value"
*
* @see DataCollection::set()
* @param string $key The name of the route to set
* @param Route|callable $value The value of the route to set
* @return RouteCollection
*/
public function set($key, $value)
{
if (!$value instanceof Route) {
$value = new Route($value);
}
return parent::set($key, $value);
}
/**
* Add a route instance to the collection
*
* This will auto-generate a name
*
* @param Route $route
* @return RouteCollection
*/
public function addRoute(Route $route)
{
/**
* Auto-generate a name from the object's hash
* This makes it so that we can autogenerate names
* that ensure duplicate route instances are overridden
*/
$name = spl_object_hash($route);
return $this->set($name, $route);
}
/**
* Add a route to the collection
*
* This allows a more generic form that
* will take a Route instance, string callable
* or any other Route class compatible callback
*
* @param Route|callable $route
* @return RouteCollection
*/
public function add($route)
{
if (!$route instanceof Route) {
$route = new Route($route);
}
return $this->addRoute($route);
}
/**
* Prepare the named routes in the collection
*
* This loops through every route to set the collection's
* key name for that route to equal the routes name, if
* its changed
*
* Thankfully, because routes are all objects, this doesn't
* take much memory as its simply moving references around
*
* @return RouteCollection
*/
public function prepareNamed()
{
// Create a new collection so we can keep our order
$prepared = new static();
foreach ($this as $key => $route) {
$route_name = $route->getName();
if (null !== $route_name) {
// Add the route to the new set with the new name
$prepared->set($route_name, $route);
} else {
$prepared->add($route);
}
}
// Replace our collection's items with our newly prepared collection's items
$this->replace($prepared->all());
return $this;
}
}
|