-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathrequest.html
More file actions
318 lines (301 loc) · 8.49 KB
/
request.html
File metadata and controls
318 lines (301 loc) · 8.49 KB
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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Request Class - Fuel Documentation</title>
<link href="../assets/css/main.css" media="screen" rel="stylesheet" />
<script type="text/javascript" src="../assets/js/jquery-1.4.4.min.js"></script>
<script type="text/javascript" src="../assets/js/nav.js"></script>
<script type="text/javascript" src="../assets/js/highlight.pack.js"></script>
<script type="text/javascript">
$(function() {
show_nav('classes', '../');
});
hljs.tabReplace = ' ';
hljs.initHighlightingOnLoad();
</script>
</head>
<body>
<header>
<h1>Fuel Documentation</h1>
</header>
<div id="main-nav"></div>
<section id="content">
<h2>Request Class</h2>
<p>The Request class processes URI requests. It is used by Fuel in index.php to process the users URI request, and you need it to generate requests in an HMVC context.</p>
<article>
<h4 id="method_factory">factory($uri = null, $route = true)</h4>
<p>The <strong>factory</strong> method returns a new request object.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$uri</kbd></th>
<td><pre class="php"><code>null</code></pre></td>
<td>The URI being requested. If this parameter is not present, the URI class will be used to detect the URI.</td>
</tr>
<tr>
<th><kbd>$route</kbd></th>
<td><pre class="php"><code>true</code></pre></td>
<td>If true, the URI passed or detected will be processed by the routing class. If no route is present, a 404 will be generated. If you request a non-public URI, set this to <strong>false</strong>.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>Fuel\Core\Request Object</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>// create the request object for the admin controller, login method
$request = Request::factory('admin/login');
// note that this only creates the object, it does not execute the request!</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_execute">execute()</h4>
<p>The <strong>execute</strong> method executes a request, and stores the resulting response in the request object to be used later.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>No</td>
</tr>
<tr>
<th>Parameters</th>
<td>No</td>
</tr>
<tr>
<th>Returns</th>
<td>Fuel\Core\Request Object</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>// create and execute the request object for the admin controller, login method
$request = Request::factory('admin/login')->execute();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_response">response()</h4>
<p>The <strong>response</strong> method fetches the response object of the executed request.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>No</td>
</tr>
<tr>
<th>Parameters</th>
<td>No</td>
</tr>
<tr>
<th>Returns</th>
<td>Fuel\Core\Response Object</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>// execute the request, fetch the response, and display it
$response = Request::factory('admin/login')->execute()->response();
echo $response;
// The Request object contains a __toString() method as an alternative way to fetch the output
$output = Request::factory('admin/login')->execute();
echo $output;</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_show_404">show_404($return = false)</h4>
<p>The <strong>show_404</strong> method will display or return the application's 404 page. If none is configured in your config routes.php, the Fuel default 404 page will be used instead. If the configured 404 route is incorrect, an error will be thrown.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$return</kbd></th>
<td><pre class="php"><code>false</code></pre></td>
<td>If <strong>false</strong>, the result will be echoed out. If <strong>true</strong>, it will be returned.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td>If <strong>$return</strong> is false, the method will exit. If not, it will return the html of the 404 page configured.</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>Request::show_404();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_main">main()</h4>
<p>The <strong>main</strong> method returns the main Request instance (the one created by the initial page request).</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>No</td>
</tr>
<tr>
<th>Returns</th>
<td>Fuel\Core\Request Object, or false if no main request instance exists.</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$main = Request::main();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_active">active()</h4>
<p>The <strong>active</strong> method returns the currently active Request instance.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>Yes</td>
</tr>
<tr>
<th>Parameters</th>
<td>No</td>
</tr>
<tr>
<th>Returns</th>
<td>Fuel\Core\Request Object, or false if no active request instance exists.</td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>$active = Request::active();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_add_path">add_path($path, $prefix = false)</h4>
<p>The <strong>add_path</strong> method allows you to add a search path to the current request instance. The search paths are used by Fuel::find_file() to locate files within your application.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>No</td>
</tr>
<tr>
<th>Parameters</th>
<td>
<table class="parameters">
<tr>
<th>Param</th>
<th>Default</th>
<th class="description">Description</th>
</tr>
<tr>
<th><kbd>$path</kbd></th>
<td><i>required</i></td>
<td>Path to be added to the list of Request local search paths</td>
</tr>
<tr>
<th><kbd>$prefix</kbd></th>
<td><pre class="php"><code>false</code></pre></td>
<td>If <strong>false</strong>, the path will be appended to the search path. If <strong>true</strong>, it will be prepended.</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>Returns</th>
<td><i>void</i></td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>// add the applications myfiles folder to the search path of the active request instance
Request::active()->add_path(APPPATH.'myfiles'.DS);</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 id="method_get_paths">get_paths()</h4>
<p>The <strong>get_paths</strong> method returns the defined list of search paths.</p>
<table class="method">
<tbody>
<tr>
<th class="legend">Static</th>
<td>No</td>
</tr>
<tr>
<th>Parameters</th>
<td>No</td>
</tr>
<tr>
<th>Returns</th>
<td><i>void</i></td>
</tr>
<tr>
<th>Example</th>
<td>
<pre class="php"><code>// get the defined search paths of the active request instance
$paths = Request::active()->get_paths();</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
</section>
<section id="footer">
<p>
<a href="http://fuelphp.com">Fuel</a> is released under the MIT license.<br />
© 2010 - 2011 Fuel Development Team
</p>
</section>
</body>
</html>