[controller] element index

Package indexes

All elements
a b c d e f h i k l m n o p r s t u v w _
_
top
Variable $_action_method
Controller_Base::$_action_method in Base.php
Variable $_cache_actions
Controller_Base::$_cache_actions in Base.php
Variable $_cache_headers
Controller_Base::$_cache_headers in Base.php
Variable $_is_error
Controller_Base::$_is_error in Base.php
Variable $_routing
Controller_Base::$_routing in Base.php
Variable $_runtime_variables
Controller_Base::$_runtime_variables in Base.php
Variable $_will_cache_action
Controller_Base::$_will_cache_action in Base.php
Method __construct
Controller_Base_EventListener::__construct() in Base.php
Method __construct
Controller_Base_CachedActionInfo::__construct() in Base.php
Method __construct
Controller_Routing_DynamicSegment::__construct() in DynamicSegment.php
Constructor
Method __construct
Controller_Routing_RegExSegment::__construct() in RegExSegment.php
Constructor
Method __construct
Controller_Routing_Builder::__construct() in Builder.php
Constructor
Method __construct
Controller_Routing::__construct() in Routing.php
Constructor
Method __construct
Controller_Base::__construct() in Base.php
Constructor
Method __construct
Controller_Routing_Route::__construct() in Route.php
Constructor
Method __construct
Controller_Routing_Segment::__construct() in Segment.php
Constructor
Method __construct
Controller_Routing_StaticSegment::__construct() in StaticSegment.php
Constructor
Method __get
Controller_Base::__get() in Base.php
Invoked when an attempt is made to retrieve the value of an undeclared instance variable
Method __isset
Controller_Base::__isset() in Base.php
Invoked when an attempt is made to call isset or empty for an undeclared instance variable
Method __set
Controller_Base::__set() in Base.php
Invoked when an attempt is made to set an undeclared instance variable
Method __unset
Controller_Base::__unset() in Base.php
Invoked when an attempt is made to unset an undeclared instance variable
a
top
Variable $action
Controller_Base::$action in Base.php
Variable $action
Controller_Base_CachedActionInfo::$action in Base.php
Method action
Controller_Base::action() in Base.php
Accessor for this controller's action name
Method add_configured_routes
Controller_Routing::add_configured_routes() in Routing.php
Loads configured routing information.
Method add_event_listener
Controller_Base::add_event_listener() in Base.php
Add an event listener to this class.
Method add_legacy_configured_routes
Controller_Routing::add_legacy_configured_routes() in Routing.php
Add any route information specified through legacy configuration
Method add_legacy_default_routes
Controller_Routing::add_legacy_default_routes() in Routing.php
Add the default routes that were previously assumed
Method add_route
Controller_Routing::add_route() in Routing.php
Add a route
Method after_filter
Controller_Base::after_filter() in Base.php
Register a method on this class to be called before any request is processed.
Method allowed_action
Controller_Base::allowed_action() in Base.php
Determine if an method can allowably be invoked as an action
Method assign_template_vars
Controller_Base::assign_template_vars() in Base.php
Assigns all public properties of the class as local variables in the template
Method authenticity_token
Controller_ForgeryProtection::authenticity_token() in ForgeryProtection.php
Return the current session's request token
b
top
Method before_filter
Controller_Base::before_filter() in Base.php
Register a method on this class to be called before any request is processed. If the method that is called returns false, all processing of the request is stopped.
Method build_regex
Controller_Routing_DynamicSegment::build_regex() in DynamicSegment.php
Build the regular expression for matching URLs
Page Base.php
Base.php in Base.php
Page Builder.php
Builder.php in Builder.php
c
top
Variable $callback
Controller_Base_EventListener::$callback in Base.php
Variable $constraints
Controller_Routing_Route::$constraints in Route.php
Method caches_action
Controller_Base::caches_action() in Base.php
Enable caching for one or more actions on this controller. Accepts one or more action names as parameters or an array of action names.
Method cache_options
Controller_Base::cache_options() in Base.php
Return the cache options to use when caching an action
Method can_call
Controller_Base_EventListener::can_call() in Base.php
Method compare
Controller_Routing_DynamicSegment::compare() in DynamicSegment.php
Compares this segment to another segment.
Method compare
Controller_Routing_RegExSegment::compare() in RegExSegment.php
Compares this segment to another segment.
Method compare
Controller_Routing_ControllerSegment::compare() in ControllerSegment.php
Compares this segment to another segment.
Method compare
Controller_Routing_Segment::compare() in Segment.php
Compares this segment to another segment.
Method compare
Controller_Routing_StaticSegment::compare() in StaticSegment.php
Compares this segment to another segment.
Method constraints
Controller_Routing_Route::constraints() in Route.php
Return this route's constraints
Page ControllerSegment.php
ControllerSegment.php in ControllerSegment.php
Class Controller_Base
Controller_Base in Base.php
Controller_Base is an abstract base class for implementing controllers.
Class Controller_Base_CachedActionInfo
Controller_Base_CachedActionInfo in Base.php
Class for cached action configuration
Class Controller_Base_EventListener
Controller_Base_EventListener in Base.php
Class for event listener information
Method controller_class
Controller_Routing::controller_class() in Routing.php
Convert a controller parameter value to a class name
Method controller_for
Controller_Routing::controller_for() in Routing.php
Return the controller for a given URL
Class Controller_ForgeryProtection
Controller_ForgeryProtection in ForgeryProtection.php
Utilities for protection against cross site request forgeries.
Class Controller_Hook_ProjectInstall
Controller_Hook_ProjectInstall in ProjectInstall.php
Custom install tasks for the controller package
Method controller_name
Controller_Base::controller_name() in Base.php
Returns the name of the controller. For ExampleController this returns 'example'.
Method controller_name
Controller_Routing::controller_name() in Routing.php
Convert a class name to a controller parameter value
Class Controller_Routing
Controller_Routing in Routing.php
Handles simple routing rules for dispatching requests to controllers.
Class Controller_Routing_Builder
Controller_Routing_Builder in Builder.php
Controller_Routing_Builder is used as a convenient way to add routes to the system.
Class Controller_Routing_ControllerSegment
Controller_Routing_ControllerSegment in ControllerSegment.php
A routing segment that matches a controller name in the URL.
Class Controller_Routing_DynamicSegment
Controller_Routing_DynamicSegment in DynamicSegment.php
A routing segment that matches a URL based on a simple pattern with embedded parameter names.
Class Controller_Routing_RegExSegment
Controller_Routing_RegExSegment in RegExSegment.php
A routing segment that matches a URL based on a regular expression.
Class Controller_Routing_Route
Controller_Routing_Route in Route.php
Represents a complete route in the system. A route is comprised of one or more segments.
Class Controller_Routing_Segment
Controller_Routing_Segment in Segment.php
Represents a segment of a route. A segment is a list of rules for matching a portion of a route. A collection of one or more segments comprise a route.
Class Controller_Routing_StaticSegment
Controller_Routing_StaticSegment in StaticSegment.php
A routing segment that matches a URL based on straight string comparison.
d
top
Variable $defaults
Controller_Routing_Route::$defaults in Route.php
Page DynamicSegment.php
DynamicSegment.php in DynamicSegment.php
Method defaults
Controller_Routing_Route::defaults() in Route.php
Return this route's default parameters
Method deliver_mail
Controller_Base::deliver_mail() in Base.php
Deliver a multipart/alternative email
e
top
Variable $event
Controller_Base_EventListener::$event in Base.php
Variable $event_listeners
Controller_Base::$event_listeners in Base.php
Variable $except
Controller_Base_EventListener::$except in Base.php
Method error_route
Controller_Routing::error_route() in Routing.php
Returns the controller to be used for a given error status code. If no controller can be found for the request, it forcibly exits.
Method expire_action
Controller_Base::expire_action() in Base.php
Expire a cached action. Defaults to the current action.
Method expire_fragment
Controller_Base::expire_fragment() in Base.php
Expire a cached fragment. Defaults to the current action and a null fragment name.
f
top
Variable $flash
Controller_Base::$flash in Base.php
Page ForgeryProtection.php
ForgeryProtection.php in ForgeryProtection.php
Page function.url_for.php
function.url_for.php in function.url_for.php
Method fire_event
Controller_Base::fire_event() in Base.php
Notifies any registered event listeners
Method first_segment
Controller_Routing_Route::first_segment() in Route.php
Return this route's first segment
Method flash
Controller_Base::flash() in Base.php
Return a flash message
Method form_authenticity_token
Controller_Base::form_authenticity_token() in Base.php
Returns the current authenticity token to use in forms in conjunction with the protect_from_forgery() filter.
h
top
Variable $hidden_actions
Controller_Base::$hidden_actions in Base.php
Method handle_request
Controller_Base::handle_request() in Base.php
Process an incoming HTTP request
Method headers_for_cache
Controller_Base::headers_for_cache() in Base.php
Returns the list of headers which have been output that should be cached (or an empty list if none).
Method hidden_actions
Controller_Base::hidden_actions() in Base.php
Return a list of all public methods which have been protected from use as an action.
Method hide_action
Controller_Base::hide_action() in Base.php
Accepts the names of one or more public methods which are protected from invocation as an action.
i
top
Variable $if_callback
Controller_Base_CachedActionInfo::$if_callback in Base.php
Method install
Controller_Hook_ProjectInstall::install() in ProjectInstall.php
Invoked when the package is installed in a project
Method is_request_verified
Controller_ForgeryProtection::is_request_verified() in ForgeryProtection.php
Test the current request for authenticity. Returns true if the request has been verified as authentic or does not require verification (i.e. GET requests).
k
top
Class Constant KEY
Controller_ForgeryProtection::KEY in ForgeryProtection.php
l
top
Variable $layout
Controller_Base::$layout in Base.php
Variable $logger
Controller_Base::$logger in Base.php
Variable $logger
Controller_Routing::$logger in Routing.php
Method layout
Controller_Base::layout() in Base.php
Accessor for this controller's layout name
Method logger
Controller_Routing::logger() in Routing.php
Return this class's logger
Method logger
Controller_Base::logger() in Base.php
Return a logger instance for the class
m
top
Method match
Controller_Routing_Route::match() in Route.php
Determine if this route matches the given URL
Method match
Controller_Routing_Segment::match() in Segment.php
Test a portion of a URL against this segment. Returns true if this segment matches, false otherwise.
Method match
Controller_Routing_StaticSegment::match() in StaticSegment.php
Test a portion of a URL against this segment. Returns true if this segment matches, false otherwise.
Method match
Controller_Routing_RegExSegment::match() in RegExSegment.php
Test a portion of a URL against this segment. Returns true if this segment matches, false otherwise.
Method match
Controller_Routing_DynamicSegment::match() in DynamicSegment.php
Test a portion of a URL against this segment. Returns true if this segment matches, false otherwise.
Method match
Controller_Routing_Builder::match() in Builder.php
The match method adds a route based on matching a URL string with optional embedded parameters.
Method match
Controller_Routing_ControllerSegment::match() in ControllerSegment.php
Test a portion of a URL against this segment. Returns true if this segment matches, false otherwise.
Method model
Controller_Base::model() in Base.php
A convenience method that calls Support_Util::model()
n
top
Variable $name
Controller_Routing_Route::$name in Route.php
Variable $next
Controller_Routing_Segment::$next in Segment.php
Method name
Controller_Routing_Route::name() in Route.php
Return this route's name
Method next
Controller_Routing_Segment::next() in Segment.php
Return the next segment in the route
Method next_url_token
Controller_Routing_Segment::next_url_token() in Segment.php
Breaks a URL into a next token and remaining segment
Method normalize
Controller_Routing::normalize() in Routing.php
Normalize a URL to a request path
Method not_found
Controller_Base::not_found() in Base.php
Return a 404 not found message back.
o
top
Variable $only
Controller_Base_EventListener::$only in Base.php
Method on_exception
Controller_Base::on_exception() in Base.php
Handle an exception thrown in an action.
p
top
Variable $pattern
Controller_Routing_DynamicSegment::$pattern in DynamicSegment.php
Variable $pattern
Controller_Routing_StaticSegment::$pattern in StaticSegment.php
Variable $pattern
Controller_Routing_RegExSegment::$pattern in RegExSegment.php
Variable $postion
Controller_Routing_Route::$postion in Route.php
Page ProjectInstall.php
ProjectInstall.php in ProjectInstall.php
Class Constant PARAMETER
Controller_ForgeryProtection::PARAMETER in ForgeryProtection.php
Method passes_method_constraints
Controller_Routing_Route::passes_method_constraints() in Route.php
Tests if a request method matches any constraints set on this route
Method passes_parameter_constraints
Controller_Routing_Route::passes_parameter_constraints() in Route.php
Tests if a request method matches any parameter constraints set on this route
Method perform_action
Controller_Base::perform_action() in Base.php
Perform the current action. This method is intended only for use by handle_request().
Method position
Controller_Routing_Route::position() in Route.php
Return this route's position
Method prepare_for_render
Controller_Base::prepare_for_render() in Base.php
Prepare template and layout for rendering.
Method protect_from_forgery
Controller_Base::protect_from_forgery() in Base.php
If the request is not a GET request and does not contain the
r
top
Variable $regex
Controller_Routing_DynamicSegment::$regex in DynamicSegment.php
Variable $rendered
Controller_Base::$rendered in Base.php
Variable $routes
Controller_Routing::$routes in Routing.php
Variable $routing
Controller_Routing_Builder::$routing in Builder.php
Page RegExSegment.php
RegExSegment.php in RegExSegment.php
Page Route.php
Route.php in Route.php
Page Routing.php
Routing.php in Routing.php
Method random_bytes
Controller_ForgeryProtection::random_bytes() in ForgeryProtection.php
Return a string of random bytes
Method redirect_to
Controller_Base::redirect_to() in Base.php
Output a redirect header to the browser
Method regex
Controller_Routing_DynamicSegment::regex() in DynamicSegment.php
Return the regular expression used to match this segment
Method regex
Controller_Routing_Builder::regex() in Builder.php
The regex method adds a route based on regular expression to be evaluated against the complete URL.
Method regex_replace_var
Controller_Routing_DynamicSegment::regex_replace_var() in DynamicSegment.php
Callback for build_regex replacements
Method remove_event_listener
Controller_Base::remove_event_listener() in Base.php
Remove an event listener from this class.
Method rendered
Controller_Base::rendered() in Base.php
Accessor for this controller's rendered flag
Method render_action
Controller_Base::render_action() in Base.php
Render the template for the action
Method render_error
Controller_Base::render_error() in Base.php
Render an error document
Method render_to_string
Controller_Base::render_to_string() in Base.php
Render the template as a string.
Method require_https
Controller_Base::require_https() in Base.php
If HTTPS is not the current protocol, outputs a redirect header to this URL using HTTPS and returns false, otherwise returns true. Convenient for use as a before filter on pages requiring HTTPS.
Method require_post
Controller_Base::require_post() in Base.php
If the current request method is not POST, outputs a 405 Method Not Allowed error and returns false, otherwise returns true. This is convenient for use in a conditional before filter to limit some actions to post only.
Method root
Controller_Routing_Builder::root() in Builder.php
The root method adds a route that matches the site root URL.
s
top
Variable $segmentsHead
Controller_Routing_Route::$segmentsHead in Route.php
Page Segment.php
Segment.php in Segment.php
Page StaticSegment.php
StaticSegment.php in StaticSegment.php
Method set_action
Controller_Base::set_action() in Base.php
This method sets the controller's action
Method set_constraints
Controller_Routing_Route::set_constraints() in Route.php
Set this route's constraints
Method set_defaults
Controller_Routing_Route::set_defaults() in Route.php
Set this route's default parameters
Method set_error
Controller_Base::set_error() in Base.php
Set the error flag for the controller
Method set_first_segment
Controller_Routing_Route::set_first_segment() in Route.php
Set this route's first segment
Method set_flash
Controller_Base::set_flash() in Base.php
Set a flash message
Method set_layout
Controller_Base::set_layout() in Base.php
This method sets the path to the layout to be used.
Method set_name
Controller_Routing_Route::set_name() in Route.php
Set this route's name
Method set_next
Controller_Routing_Segment::set_next() in Segment.php
Set the next segment in the route
Method set_position
Controller_Routing_Route::set_position() in Route.php
Set this route's position
Method set_rendered
Controller_Base::set_rendered() in Base.php
This method sets the controller's rendered flag
Method set_routing
Controller_Base::set_routing() in Base.php
Set the routing instance currently in use
Method set_template_defaults
Controller_Base::set_template_defaults() in Base.php
Set various template variables if they have not been set explicitly.
Function smarty_function_url_for
smarty_function_url_for() in function.url_for.php
url_for Smarty function
t
top
Method template_cache_id
Controller_Base::template_cache_id() in Base.php
Returns the current template cache ID, in case you want to vary the cached output based on some condition.
Method template_compile_id
Controller_Base::template_compile_id() in Base.php
Returns the current template compile ID, in case this controller changes the template directory.
u
top
Method url_for
Controller_Routing::url_for() in Routing.php
The opposite of controller_for, determines the URL for a given set of parameters. If no URL can be constructed from the parameters, this method throws an exception.
Method url_for
Controller_Routing_Segment::url_for() in Segment.php
Essentially the reverse of match(), this method assembles a URL segment from a set of parameters. If this segment cannot construct a URL chunk for the parameters, it returns false. Note that upon completion, $params contains only unconsumed parameters.
Method url_for
Controller_Routing_StaticSegment::url_for() in StaticSegment.php
Essentially the reverse of match(), this method assembles a URL segment from a set of parameters. If this segment cannot construct a URL chunk for the parameters, it returns false. Note that upon completion, $params contains only unconsumed parameters.
Method url_for
Controller_Routing_Route::url_for() in Route.php
Essentially the opposite of match(), this attempts to build a URL from a set of parameters. It returns the constructed URL on success, or false on failure.
Method url_for
Controller_Routing_RegExSegment::url_for() in RegExSegment.php
Essentially the reverse of match(), this method assembles a URL segment from a set of parameters. Note that a RegExSegment is never capable of constructing a URL and so will return false.
Method url_for
Controller_Routing_ControllerSegment::url_for() in ControllerSegment.php
Essentially the reverse of match(), this method assembles a URL segment from a set of parameters. If this segment cannot construct a URL chunk for the parameters, it returns false. Note that upon completion, $params contains only unconsumed parameters.
Method url_for
Controller_Routing_DynamicSegment::url_for() in DynamicSegment.php
Essentially the reverse of match(), this method assembles a URL segment from a set of parameters. If this segment cannot construct a URL chunk for the parameters, it returns false. Note that upon completion, $params contains only unconsumed parameters.
Method url_for
Controller_Base::url_for() in Base.php
Return the URL for a given set of parameters.
v
top
Variable $vars
Controller_Routing_DynamicSegment::$vars in DynamicSegment.php
Method value
Controller_Routing_StaticSegment::value() in StaticSegment.php
Return the value of this segment in human readable form.
Method value
Controller_Routing_Segment::value() in Segment.php
Return the value of this segment in human readable form.
Method value
Controller_Routing_DynamicSegment::value() in DynamicSegment.php
Return the value of this segment in human readable form.
Method value
Controller_Routing_ControllerSegment::value() in ControllerSegment.php
Return the value of this segment in human readable form.
Method value
Controller_Routing_RegExSegment::value() in RegExSegment.php
Return the value of this segment in human readable form.
w
top
Method will_cache
Controller_Base::will_cache() in Base.php
Returns true if the given action name will be cached
a b c d e f h i k l m n o p r s t u v w _