-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathBrookRouter.TBrookRoutes.html
220 lines (220 loc) · 12.3 KB
/
BrookRouter.TBrookRoutes.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
<!DOCTYPE html>
<html lang="en">
<head>
<title>BrookRouter: Class TBrookRoutes</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.15.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p><p><a href="GVUses.png" class="navigation">Unit dependency graph</a></p><p><a href="GVClasses.png" class="navigation">Classes hierarchy graph</a></p></td><td class="content">
<span id="TBrookRoutes"></span><h1 class="cio">Class TBrookRoutes</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">Fields</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="BrookRouter.html">BrookRouter</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TBrookRoutes = class(<a class="normal" href="BrookClasses.TBrookPersistent.html">TBrookPersistent</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Defines a list of routes.</p>
<span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TPersistent</li>
<li class="ancestor"><a class="normal" href="BrookClasses.TBrookPersistent.html">TBrookPersistent</a></li>
<li class="thisitem">TBrookRoutes</li></ul><h2 class="overview">Overview</h2>
<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="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a href="BrookRouter.TBrookRoutes.html#FreeRoutes">FreeRoutes</a></b>; virtual;</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>constructor <b><a href="BrookRouter.TBrookRoutes.html#Create">Create</a></b>; virtual;</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>destructor <b><a href="BrookRouter.TBrookRoutes.html#Destroy">Destroy</a></b>; 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>procedure <b><a href="BrookRouter.TBrookRoutes.html#Clear">Clear</a></b>;</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>function <b><a href="BrookRouter.TBrookRoutes.html#Count">Count</a></b>: Integer;</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>function <b><a href="BrookRouter.TBrookRoutes.html#Add">Add</a></b>(AActionClass: <a href="BrookAction.html#TBrookActionClass">TBrookActionClass</a>; const APattern: string; const AMethod: <a href="BrookUtils.html#TBrookRequestMethod">TBrookRequestMethod</a>; const ADefault: Boolean): Integer;</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 <b><a href="BrookRouter.TBrookRoutes.html#GetDefaultActionClass">GetDefaultActionClass</a></b>(out AClass: <a href="BrookAction.html#TBrookActionClass">TBrookActionClass</a>; out AIndex: Integer);</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>procedure <b><a href="BrookRouter.TBrookRoutes.html#GetEmptyPatternActionClass">GetEmptyPatternActionClass</a></b>(out AClass: <a href="BrookAction.html#TBrookActionClass">TBrookActionClass</a>; out AIndex: Integer);</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>function <b><a href="BrookRouter.TBrookRoutes.html#PatternByActionClass">PatternByActionClass</a></b>(AClass: <a href="BrookAction.html#TBrookActionClass">TBrookActionClass</a>): string;</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>function <b><a href="BrookRouter.TBrookRoutes.html#ActionClassByPattern">ActionClassByPattern</a></b>(const APattern: string): <a href="BrookAction.html#TBrookActionClass">TBrookActionClass</a>;</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>function <b><a href="BrookRouter.TBrookRoutes.html#ActionClassByClassName">ActionClassByClassName</a></b>(const AName: string): <a href="BrookAction.html#TBrookActionClass">TBrookActionClass</a>;</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="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>property <b><a href="BrookRouter.TBrookRoutes.html#List">List</a></b>: TFPList read FList;</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 <b><a href="BrookRouter.TBrookRoutes.html#Items">Items</a></b>[constAIndex:Integer]: <a href="BrookRouter.html#PBrookRoute">PBrookRoute</a> read GetItems
write SetItems;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="FreeRoutes"></span><code>procedure <b>FreeRoutes</b>; virtual;</code></td>
</tr>
<tr><td colspan="2">
</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="Create"></span><code>constructor <b>Create</b>; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Creates an instance of a <a class="normal" href="BrookRouter.TBrookRoutes.html">TBrookRoutes</a> class.</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="Destroy"></span><code>destructor <b>Destroy</b>; override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Frees an instance of <a class="normal" href="BrookRouter.TBrookRoutes.html">TBrookRoutes</a> class.</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="Clear"></span><code>procedure <b>Clear</b>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Clears all routes.</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="Count"></span><code>function <b>Count</b>: Integer;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns the number of registered routes.</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="Add"></span><code>function <b>Add</b>(AActionClass: <a href="BrookAction.html#TBrookActionClass">TBrookActionClass</a>; const APattern: string; const AMethod: <a href="BrookUtils.html#TBrookRequestMethod">TBrookRequestMethod</a>; const ADefault: Boolean): Integer;</code></td>
</tr>
<tr><td colspan="2">
<p>
Adds a route item.</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="GetDefaultActionClass"></span><code>procedure <b>GetDefaultActionClass</b>(out AClass: <a href="BrookAction.html#TBrookActionClass">TBrookActionClass</a>; out AIndex: Integer);</code></td>
</tr>
<tr><td colspan="2">
<p>
Get the default action class.</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="GetEmptyPatternActionClass"></span><code>procedure <b>GetEmptyPatternActionClass</b>(out AClass: <a href="BrookAction.html#TBrookActionClass">TBrookActionClass</a>; out AIndex: Integer);</code></td>
</tr>
<tr><td colspan="2">
<p>
Get the action class with empty pattern.</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="PatternByActionClass"></span><code>function <b>PatternByActionClass</b>(AClass: <a href="BrookAction.html#TBrookActionClass">TBrookActionClass</a>): string;</code></td>
</tr>
<tr><td colspan="2">
<p>
Get the registered pattern of a class.</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="ActionClassByPattern"></span><code>function <b>ActionClassByPattern</b>(const APattern: string): <a href="BrookAction.html#TBrookActionClass">TBrookActionClass</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Get the action class from a patter.</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="ActionClassByClassName"></span><code>function <b>ActionClassByClassName</b>(const AName: string): <a href="BrookAction.html#TBrookActionClass">TBrookActionClass</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Get an action class from its class name.</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="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><span id="List"></span><code>property <b>List</b>: TFPList read FList;</code></td>
</tr>
<tr><td colspan="2">
</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="Items"></span><code>property <b>Items</b>[constAIndex:Integer]: <a href="BrookRouter.html#PBrookRoute">PBrookRoute</a> read GetItems
write SetItems;</code></td>
</tr>
<tr><td colspan="2">
<p>
The list of routes.</p>
</td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://github.com/pasdoc/pasdoc/wiki">PasDoc 0.15.0</a>. </em>
</span>
</td></tr></table></body></html>