-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
EntityRoute.php
82 lines (75 loc) · 2.64 KB
/
EntityRoute.php
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
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.6.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Routing\Route;
use ArrayAccess;
use Cake\Core\Exception\CakeException;
/**
* Matches entities to routes
*
* This route will match by entity and map its fields to the URL pattern by
* comparing the field names with the template vars. This makes it easy and
* convenient to change routes globally.
*/
class EntityRoute extends Route
{
/**
* Match by entity and map its fields to the URL pattern by comparing the
* field names with the template vars.
*
* If a routing key is defined in both `$url` and the entity, the value defined
* in `$url` will be preferred.
*
* @param array $url Array of parameters to convert to a string.
* @param array $context An array of the current request context.
* Contains information such as the current host, scheme, port, and base
* directory.
* @return string|null Either a string URL or null.
*/
public function match(array $url, array $context = []): ?string
{
if (!$this->_compiledRoute) {
$this->compile();
}
if (isset($url['_entity'])) {
$entity = $url['_entity'];
$this->_checkEntity($entity);
foreach ($this->keys as $field) {
if (!isset($url[$field]) && isset($entity[$field])) {
$url[$field] = $entity[$field];
}
}
}
return parent::match($url, $context);
}
/**
* Checks that we really deal with an entity object
*
* @throws \RuntimeException
* @param mixed $entity Entity value from the URL options
* @return void
*/
protected function _checkEntity(mixed $entity): void
{
if (!$entity instanceof ArrayAccess && !is_array($entity)) {
throw new CakeException(sprintf(
'Route `%s` expects the URL option `_entity` to be an array or object implementing \ArrayAccess, '
. 'but `%s` passed.',
$this->template,
get_debug_type($entity)
));
}
}
}