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
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\AppFramework\Http\Attribute;
use Attribute;
/**
* This attribute can be used to define routes on controller methods.
*
* It works in addition to the traditional routes.php method and has the same parameters
* (except for the `name` parameter which is not needed).
*
* @since 29.0.0
*/
#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
class Route {
/**
* Corresponds to the `ocs` key in routes.php
*
* @see ApiRoute
* @since 29.0.0
*/
public const TYPE_API = 'ocs';
/**
* Corresponds to the `routes` key in routes.php
*
* @see FrontpageRoute
* @since 29.0.0
*/
public const TYPE_FRONTPAGE = 'routes';
/**
* @param string $type Either Route::TYPE_API or Route::TYPE_FRONTPAGE.
* @psalm-param Route::TYPE_* $type
* @param string $verb HTTP method of the route.
* @psalm-param 'GET'|'HEAD'|'POST'|'PUT'|'DELETE'|'OPTIONS'|'PATCH' $verb
* @param string $url The path of the route.
* @param ?array<string, string> $requirements Array of regexes mapped to the path parameters.
* @param ?array<string, mixed> $defaults Array of default values mapped to the path parameters.
* @param ?string $root Custom root. For OCS all apps are allowed, but for index.php only some can use it.
* @param ?string $postfix Postfix for the route name.
* @since 29.0.0
*/
public function __construct(
protected string $type,
protected string $verb,
protected string $url,
protected ?array $requirements = null,
protected ?array $defaults = null,
protected ?string $root = null,
protected ?string $postfix = null,
) {
}
/**
* @return array{
* verb: string,
* url: string,
* requirements?: array<string, string>,
* defaults?: array<string, mixed>,
* root?: string,
* postfix?: string,
* }
* @since 29.0.0
*/
public function toArray() {
$route = [
'verb' => $this->verb,
'url' => $this->url,
];
if ($this->requirements !== null) {
$route['requirements'] = $this->requirements;
}
if ($this->defaults !== null) {
$route['defaults'] = $this->defaults;
}
if ($this->root !== null) {
$route['root'] = $this->root;
}
if ($this->postfix !== null) {
$route['postfix'] = $this->postfix;
}
return $route;
}
/**
* @since 29.0.0
*/
public function getType(): string {
return $this->type;
}
/**
* @since 29.0.0
*/
public function getVerb(): string {
return $this->verb;
}
/**
* @since 29.0.0
*/
public function getUrl(): string {
return $this->url;
}
/**
* @since 29.0.0
*/
public function getRequirements(): ?array {
return $this->requirements;
}
/**
* @since 29.0.0
*/
public function getDefaults(): ?array {
return $this->defaults;
}
/**
* @since 29.0.0
*/
public function getRoot(): ?string {
return $this->root;
}
/**
* @since 29.0.0
*/
public function getPostfix(): ?string {
return $this->postfix;
}
}
|
