-
Notifications
You must be signed in to change notification settings - Fork 1
/
BrookURLRouter.TBrookURLRoute.html
287 lines (286 loc) · 16.9 KB
/
BrookURLRouter.TBrookURLRoute.html
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
<!DOCTYPE html>
<html lang="en">
<head>
<title>Brook Tardigrade: BrookURLRouter: Class TBrookURLRoute</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.16.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<div class="container"><div class="navigation">
<h2><a href="index.html">Brook Tardigrade</a></h2><ul><li><a href="AllUnits.html">Units</a></li><li><a href="ClassHierarchy.html">Class Hierarchy</a></li><li><a href="AllClasses.html">Classes, Interfaces, Objects and Records</a></li><li><a href="AllTypes.html">Types</a></li><li><a href="AllVariables.html">Variables</a></li><li><a href="AllConstants.html">Constants</a></li><li><a href="AllFunctions.html">Functions and Procedures</a></li><li><a href="AllIdentifiers.html">Identifiers</a></li><li><form class="search-form" action="tipue_results.html"><div class="search-input"><input type="text" name="q" id="tipue_search_input" pattern=".{3,}" title="At least 3 characters" required><div class="search-button"><input type="button" id="tipue_search_button" onclick="this.form.submit();"></div></div></form>
<div style="clear: both"></div>
</li></ul></div><div class="content">
<span id="TBrookURLRoute"></span><h1 class="cio">Class TBrookURLRoute</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section"><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></div><div class="one_section"><a class="section" href="#PasDoc-Fields">Fields</a></div><div class="one_section"><a class="section" href="#PasDoc-Methods">Methods</a></div><div class="one_section"><a class="section" href="#PasDoc-Properties">Properties</a></div></div>
<span id="PasDoc-Description"></span><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="BrookURLRouter.html">BrookURLRouter</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TBrookURLRoute = class(<a class="normal" href="BrookHandledClasses.TBrookHandledCollectionItem.html">TBrookHandledCollectionItem</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Class to represent a URL route item.</p>
<span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="ancestor">TPersistent</li>
<li class="ancestor">TCollectionItem</li>
<li class="ancestor"><a class="normal" href="BrookHandledClasses.TBrookHandledCollectionItem.html">TBrookHandledCollectionItem</a></li>
<li class="thisitem">TBrookURLRoute</li></ul><h2 class="overview">Overview</h2>
<span id="PasDoc-Fields"></span><h3 class="summary">Fields</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>nested const <strong><a href="BrookURLRouter.TBrookURLRoute.html#DefaultReqMethods">DefaultReqMethods</a></strong> = [<a href="BrookUtility.html#rmGET">rmGET</a>, <a href="BrookUtility.html#rmPOST">rmPOST</a>];</code></td>
</tr>
</table>
<span id="PasDoc-Methods"></span><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <strong><a href="BrookURLRouter.TBrookURLRoute.html#Create">Create</a></strong>(ACollection: TCollection); override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>destructor <strong><a href="BrookURLRouter.TBrookURLRoute.html#Destroy">Destroy</a></strong>; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <strong><a href="BrookURLRouter.TBrookURLRoute.html#Validate">Validate</a></strong>; inline;</code></td>
</tr>
</table>
<span id="PasDoc-Properties"></span><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLRouter.TBrookURLRoute.html#PCRE2Handle">PCRE2Handle</a></strong>: Pointer read GetPCRE2Handle;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLRouter.TBrookURLRoute.html#Segments">Segments</a></strong>: TArray<string> read GetSegments;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLRouter.TBrookURLRoute.html#Variables">Variables</a></strong>: <a href="BrookStringMap.TBrookStringMap.html">TBrookStringMap</a> read GetVariables;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLRouter.TBrookURLRoute.html#RawPattern">RawPattern</a></strong>: string read GetRawPattern;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLRouter.TBrookURLRoute.html#Path">Path</a></strong>: string read GetPath;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLRouter.TBrookURLRoute.html#UserData">UserData</a></strong>: Pointer read GetUserData;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLRouter.TBrookURLRoute.html#Default">Default</a></strong>: Boolean read FDefault write SetDefault
stored IsDefaultStored <a href="BrookURLRouter.TBrookURLRoute.html#Default">default</a> False;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLRouter.TBrookURLRoute.html#Pattern">Pattern</a></strong>: string read GetPattern write SetPattern;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLRouter.TBrookURLRoute.html#Methods">Methods</a></strong>: <a href="BrookUtility.html#TBrookHTTPRequestMethods">TBrookHTTPRequestMethods</a> read FMethods write FMethods
stored IsMethodsStored <a href="BrookURLRouter.TBrookURLRoute.html#Default">default</a> <a href="BrookURLRouter.TBrookURLRoute.html#DefaultReqMethods">DefaultReqMethods</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLRouter.TBrookURLRoute.html#OnMath">OnMath</a></strong>: <a href="BrookURLRouter.html#TBrookURLRouteMatchEvent">TBrookURLRouteMatchEvent</a> read FOnMath write FOnMath;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLRouter.TBrookURLRoute.html#OnRequestMethod">OnRequestMethod</a></strong>: <a href="BrookURLRouter.html#TBrookURLRouteRequestMethodEvent">TBrookURLRouteRequestMethodEvent</a>
read FOnRequestMethod write FOnRequestMethod;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><code>property <strong><a href="BrookURLRouter.TBrookURLRoute.html#OnRequest">OnRequest</a></strong>: <a href="BrookURLRouter.html#TBrookURLRouteRequestEvent">TBrookURLRouteRequestEvent</a> read FOnRequest
write FOnRequest;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Fields</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="DefaultReqMethods"></span><code>nested const <strong>DefaultReqMethods</strong> = [<a href="BrookUtility.html#rmGET">rmGET</a>, <a href="BrookUtility.html#rmPOST">rmPOST</a>];</code></td>
</tr>
<tr><td colspan="2">
<p>
<a class="normal" href="BrookURLRouter.TBrookURLRoute.html#Default">Default</a> route HTTP <a class="normal" href="BrookURLRouter.TBrookURLRoute.html#Methods">methods</a>.</p>
</td></tr>
</table>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Create"></span><code>constructor <strong>Create</strong>(ACollection: TCollection); override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Creates an instance of <code><a class="normal" href="BrookURLRouter.TBrookURLRoute.html">TBrookURLRoute</a></code>. </p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>ACollection[in]</dt>
<dd>Routes list.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Destroy"></span><code>destructor <strong>Destroy</strong>; override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Frees an instance of <code><a class="normal" href="BrookURLRouter.TBrookURLRoute.html">TBrookURLRoute</a></code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Validate"></span><code>procedure <strong>Validate</strong>; inline;</code></td>
</tr>
<tr><td colspan="2">
<p>
Checks if the route <a class="normal" href="BrookURLRouter.TBrookURLRoute.html#Pattern">pattern</a> is valid.</p>
</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="PCRE2Handle"></span><code>property <strong>PCRE2Handle</strong>: Pointer read GetPCRE2Handle;</code></td>
</tr>
<tr><td colspan="2">
<p>
Contains the PCRE2 instance.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Segments"></span><code>property <strong>Segments</strong>: TArray<string> read GetSegments;</code></td>
</tr>
<tr><td colspan="2">
<p>
Contains all <a class="normal" href="BrookURLRouter.TBrookURLRoute.html#Path">path</a> <code>segments</code> (a.k.a. <a class="normal" href="BrookURLRouter.TBrookURLRoute.html#Path">path</a> levels).</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Variables"></span><code>property <strong>Variables</strong>: <a href="BrookStringMap.TBrookStringMap.html">TBrookStringMap</a> read GetVariables;</code></td>
</tr>
<tr><td colspan="2">
<p>
Contains all <a class="normal" href="BrookURLRouter.TBrookURLRoute.html#Path">path</a> <code>variables</code> (a.k.a. query-string parameters).</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="RawPattern"></span><code>property <strong>RawPattern</strong>: string read GetRawPattern;</code></td>
</tr>
<tr><td colspan="2">
<p>
Contains the raw route <a class="normal" href="BrookURLRouter.TBrookURLRoute.html#Pattern">pattern</a>. For example, given a <a class="normal" href="BrookURLRouter.TBrookURLRoute.html#Pattern">pattern</a> <code>/foo</code>, the raw <a class="normal" href="BrookURLRouter.TBrookURLRoute.html#Pattern">pattern</a> is <code>ˆ/foo$</code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="Path"></span><code>property <strong>Path</strong>: string read GetPath;</code></td>
</tr>
<tr><td colspan="2">
<p>
Contains the route <code>path</code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="UserData"></span><code>property <strong>UserData</strong>: Pointer read GetUserData;</code></td>
</tr>
<tr><td colspan="2">
<p>
User-defined data to be stored temporarily in the route object.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="Default"></span><code>property <strong>Default</strong>: Boolean read FDefault write SetDefault
stored IsDefaultStored <a href="BrookURLRouter.TBrookURLRoute.html#Default">default</a> False;</code></td>
</tr>
<tr><td colspan="2">
<p>
<code>Default</code> route called if URL does not match any registered route.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="Pattern"></span><code>property <strong>Pattern</strong>: string read GetPattern write SetPattern;</code></td>
</tr>
<tr><td colspan="2">
<p>
<code>Pattern</code> to find the route. It must be a valid regular expression in PCRE2 syntax.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="Methods"></span><code>property <strong>Methods</strong>: <a href="BrookUtility.html#TBrookHTTPRequestMethods">TBrookHTTPRequestMethods</a> read FMethods write FMethods
stored IsMethodsStored <a href="BrookURLRouter.TBrookURLRoute.html#Default">default</a> <a href="BrookURLRouter.TBrookURLRoute.html#DefaultReqMethods">DefaultReqMethods</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Allowed <code>methods</code> to find the route.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="OnMath"></span><code>property <strong>OnMath</strong>: <a href="BrookURLRouter.html#TBrookURLRouteMatchEvent">TBrookURLRouteMatchEvent</a> read FOnMath write FOnMath;</code></td>
</tr>
<tr><td colspan="2">
<p>
Event triggered when the <a class="normal" href="BrookURLRouter.TBrookURLRoute.html#Path">path</a> matches the route <a class="normal" href="BrookURLRouter.TBrookURLRoute.html#Pattern">pattern</a>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="OnRequestMethod"></span><code>property <strong>OnRequestMethod</strong>: <a href="BrookURLRouter.html#TBrookURLRouteRequestMethodEvent">TBrookURLRouteRequestMethodEvent</a>
read FOnRequestMethod write FOnRequestMethod;</code></td>
</tr>
<tr><td colspan="2">
<p>
Event triggered when the HTTP method matches a route allowed method.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
<td class="itemcode"><span id="OnRequest"></span><code>property <strong>OnRequest</strong>: <a href="BrookURLRouter.html#TBrookURLRouteRequestEvent">TBrookURLRouteRequestEvent</a> read FOnRequest
write FOnRequest;</code></td>
</tr>
<tr><td colspan="2">
<p>
Event triggered when a client requests the route.</p>
</td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0</a>. </em>
</span>
</div></div></body></html>