Abstract controller class. Controllers should only be created using a Request.
Controllers methods will be automatically called in the following order by the request:
$controller = new Controller_Foo($request);
$controller->before();
$controller->action_bar();
$controller->after();
The controller action should add the output it creates to
$this->response->body($output), typically in the form of a View, during the
"action" part of execution.
Class declared in SYSPATH/classes/Controller.php on line 3.
Request $requestRequest that created the controller
NULL
Response $responseThe response that will be returned from controller
NULL
Creates a new controller instance. Each controller must be constructed with the request object that created it.
Request
$request
required - Request that created the controller Response
$response
required - The request's response voidpublic function __construct(Request $request, Response $response)
{
// Assign the request to the controller
$this->request = $request;
// Assign a response to the controller
$this->response = $response;
}Automatically executed after the controller action. Can be used to apply transformation to the response, add extra output, and execute other custom code.
voidpublic function after()
{
// Nothing by default
}Automatically executed before the controller action. Can be used to set class properties, do authorization checks, and execute other custom code.
voidpublic function before()
{
// Nothing by default
}Executes the given action and calls the Controller::before and Controller::after methods.
Can also be used to catch exceptions from actions in a single place.
Responsepublic function execute()
{
// Execute the "before action" method
$this->before();
// Determine the action to use
$action = 'action_' . $this->request->action();
// If the action doesn't exist, it's a 404
if (!method_exists($this, $action)) {
throw HTTP_Exception::factory(404, 'The requested URL :uri was not found on this server.', [':uri' => $this->request->uri()])->request($this->request);
}
// Execute the action itself
$this->{$action}();
// Execute the "after action" method
$this->after();
// Return the response
return $this->response;
}Issues a HTTP redirect.
Proxies to the HTTP::redirect method.
string
$uri
= string(0) "" - URI to redirect to int
$code
= integer 302 - HTTP Status code to use for the redirect public static function redirect($uri = '', $code = 302)
{
return HTTP::redirect((string) $uri, $code);
}Checks the browser cache to see the response needs to be returned, execution will halt and a 304 Not Modified will be sent if the browser cache is up to date.
$this->check_cache(sha1($content));
string
$etag
= NULL - Resource Etag Responseprotected function check_cache($etag = null)
{
return HTTP::check_cache($this->request, $this->response, $etag);
}