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=newController_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 $requestlink to thisRequest that created the controller
NULL
Response $responselink to thisThe 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 void
publicfunction__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.
void
publicfunctionafter(){// Nothing by default}
Automatically executed before the controller action. Can be used to set class properties, do authorization checks, and execute other custom code.
void
publicfunctionbefore(){// 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.
Response
publicfunctionexecute(){// 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 404if(!method_exists($this,$action)) {throwHTTP_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 responsereturn$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
publicstaticfunctionredirect($uri='',$code= 302){returnHTTP::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 Response
protectedfunctioncheck_cache($etag= null){returnHTTP::check_cache($this->request,$this->response,$etag);}