Documentation

Setting the Status Header

The status header is treated as a "special" header in Fuel. You do not set it as you would other headers. The status header is set as follows in the controller:

$response = new Response($body, 404);

Setting the Status Header and other headers

$headers = array (
    'Cache-Control'     => 'no-cache, no-store, max-age=0, must-revalidate',
    'Expires'           => 'Mon, 26 Jul 1997 05:00:00 GMT',
    'Pragma'            => 'no-cache',
);
$response = new Response($body, 404, $headers);

forge($body = null, $status = 200, array $headers = array())

The forge method creates a new instance of the Response class.

null

200

array()

// create a response object, use a View as body, and a 404 NOT FOUND status code
return Response::forge(View::forge('errors/404page'), 404);

redirect($url = '', $method = 'location', $redirect_code = 302)

The redirect method offers different methods of redirecting to a new URL.

''

'location'

302

// use a URL
Response::redirect('http://example.com/home', 'refresh');

// or use a relative URI
Response::redirect('site/about');

This method supports wildcard replacement in the URL. See Uri::segment_replace() for more information. You can disable this by setting response.redirect_with_wildcards to false in your applications config.php.

redirect_back($url = '', $method = 'location', $redirect_code = 302)

The redirect_back method allows you to redirect back to the page you came from, and offers different methods of redirecting to a new URL. If the previous page is not part of your application (i.e. the user came from another website), or no URL is given, it will redirect to the application homepage.

''

'location'

302

// redirect back. If there is no 'back', go to the dashboard page
Response::redirect_back('/dashboard', 'refresh');

This method supports wildcard replacement in the URL. See Uri::segment_replace() for more information. You can disable this by setting response.redirect_with_wildcards to false in your applications config.php.

set_status($status = 200)

The set_status method allows you to update the HTTP status code set on a Response object.

200

$response = new Response();

// This will be a NOT FOUND response
$response->set_status(404);

set_header($name, $value, $replace)

The set_header method allows set custom HTTP headers.

true

$response = new Response();

// We'll be outputting a PDF
$response->set_header('Content-Type', 'application/pdf');

// It will be called downloaded.pdf
$response->set_header('Content-Disposition', 'attachment; filename="downloaded.pdf"');

// Set no cache
$response->set_header('Cache-Control', 'no-cache, no-store, max-age=0, must-revalidate');
$response->set_header('Expires', 'Mon, 26 Jul 1997 05:00:00 GMT');
$response->set_header('Pragma', 'no-cache');

// More examples
$response->set_header('Content-Language', 'en');
$response->set_header('Content-Type', 'text/html; charset=utf-8');

return $response;

Note that names are unique, and will overwrite each other if an existing name is used.

set_headers($headers, $replace)

The set_headers method allows set multiple custom HTTP headers at once.

true

$response = new Response();

// We'll be outputting a PDF called downloaded.pdf with no caching
$response->set_headers(array
	'Content-Type' => 'application/pdf',
	'Content-Disposition' => 'attachment; filename="downloaded.pdf"',
	'Cache-Control' => 'no-cache, no-store, max-age=0, must-revalidate',
	'Expires' => 'Mon, 26 Jul 1997 05:00:00 GMT');
	'Pragma' => 'no-cache',
));

return $response;

Note that names are unique, and will overwrite each other if an existing name is used.

get_header($name = null)

The get_header method allows you to retrieve a custom HTTP headers set previously.

$response = new Response();
$response->set_header('Pragma', 'no-cache');

// returns 'no-cache'
$header = $response->get_header('Pragma');

// returns array('Pragma' => 'no-cache')
$header = $response->get_header();

body($value = false)

The body method allows get the current response body, or set a new one.

$response = new Response();
$response->body('This is the response body');

// returns 'This is the response body'
$body = $response->body();

send_headers()

The send_headers method sends the set headers out to the browser, including the HTTP status of the request.

$response->send_headers();

Note that you normally don't have to call this method manually. Fuel will take care of this as part of processing the request.

send($send_headers = false)

The send method sends the response body to the output buffer (i.e. it is echo'd out).

// echo whatever the response body is
$response->send();

Note that you normally don't have to call this method manually. Fuel will take care of this as part of processing the request.