[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
Variable $_cache_actions
Variable $_cache_headers
Variable $_is_error
Variable $_routing
Variable $_runtime_variables
Variable $_will_cache_action
Method __construct
Method __construct
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Constructor
Method __construct
Constructor
Method __get
Invoked when an attempt is made to retrieve the value of an undeclared instance variable
Method __isset
Invoked when an attempt is made to call isset or empty for an undeclared instance variable
Method __set
Invoked when an attempt is made to set an undeclared instance variable
Method __unset
Invoked when an attempt is made to unset an undeclared instance variable
a
top
Variable $action
Variable $action
Method action
Accessor for this controller's action name
Method add_configured_routes
Loads configured routing information.
Method add_event_listener
Add an event listener to this class.
Method add_legacy_configured_routes
Add any route information specified through legacy configuration
Method add_legacy_default_routes
Add the default routes that were previously assumed
Method add_route
Add a route
Method after_filter
Register a method on this class to be called before any request is processed.
Method allowed_action
Determine if an method can allowably be invoked as an action
Method assign_template_vars
Assigns all public properties of the class as local variables in the template
Method authenticity_token
Return the current session's request token
b
top
Method before_filter
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
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
Variable $constraints
Method caches_action
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
Return the cache options to use when caching an action
Method can_call
Method compare
Compares this segment to another segment.
Method compare
Compares this segment to another segment.
Method compare
Compares this segment to another segment.
Method compare
Compares this segment to another segment.
Method compare
Compares this segment to another segment.
Method constraints
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
Class for cached action configuration
Class Controller_Base_EventListener
Class for event listener information
Method controller_class
Convert a controller parameter value to a class name
Method controller_for
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
Returns the name of the controller. For ExampleController this returns 'example'.
Method controller_name
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 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
A routing segment that matches a URL based on a regular expression.
Class Controller_Routing_Route
Represents a complete route in the system. A route is comprised of one or more segments.
Class Controller_Routing_Segment
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
A routing segment that matches a URL based on straight string comparison.
d
top
Variable $defaults
Page DynamicSegment.php
DynamicSegment.php in DynamicSegment.php
Method defaults
Return this route's default parameters
Method deliver_mail
Deliver a multipart/alternative email
e
top
Variable $event
Variable $event_listeners
Variable $except
Method error_route
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
Expire a cached action. Defaults to the current action.
Method expire_fragment
Expire a cached fragment. Defaults to the current action and a null fragment name.
f
top
Variable $flash
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
Notifies any registered event listeners
Method first_segment
Return this route's first segment
Method flash
Return a flash message
Method form_authenticity_token
Returns the current authenticity token to use in forms in conjunction with the protect_from_forgery() filter.
h
top
Variable $hidden_actions
Method handle_request
Process an incoming HTTP request
Method headers_for_cache
Returns the list of headers which have been output that should be cached (or an empty list if none).
Method hidden_actions
Return a list of all public methods which have been protected from use as an action.
Method hide_action
Accepts the names of one or more public methods which are protected from invocation as an action.
i
top
Variable $if_callback
Method install
Invoked when the package is installed in a project
Method is_request_verified
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
Variable $logger
Variable $logger
Method layout
Accessor for this controller's layout name
Method logger
Return this class's logger
Method logger
Return a logger instance for the class
m
top
Method match
Determine if this route matches the given URL
Method match
Test a portion of a URL against this segment. Returns true if this segment matches, false otherwise.
Method match
Test a portion of a URL against this segment. Returns true if this segment matches, false otherwise.
Method match
Test a portion of a URL against this segment. Returns true if this segment matches, false otherwise.
Method match
Test a portion of a URL against this segment. Returns true if this segment matches, false otherwise.
Method match
The match method adds a route based on matching a URL string with optional embedded parameters.
Method match
Test a portion of a URL against this segment. Returns true if this segment matches, false otherwise.
Method model
A convenience method that calls Support_Util::model()
n
top
Variable $name
Variable $next
Method name
Return this route's name
Method next
Return the next segment in the route
Method next_url_token
Breaks a URL into a next token and remaining segment
Method normalize
Normalize a URL to a request path
Method not_found
Return a 404 not found message back.
o
top
Variable $only
Method on_exception
Handle an exception thrown in an action.
p
top
Variable $pattern
Variable $pattern
Variable $pattern
Variable $postion
Page ProjectInstall.php
ProjectInstall.php in ProjectInstall.php
Class Constant PARAMETER
Method passes_method_constraints
Tests if a request method matches any constraints set on this route
Method passes_parameter_constraints
Tests if a request method matches any parameter constraints set on this route
Method perform_action
Perform the current action. This method is intended only for use by handle_request().
Method position
Return this route's position
Method prepare_for_render
Prepare template and layout for rendering.
Method protect_from_forgery
If the request is not a GET request and does not contain the
r
top
Variable $regex
Variable $rendered
Variable $routes
Variable $routing
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
Return a string of random bytes
Method redirect_to
Output a redirect header to the browser
Method regex
Return the regular expression used to match this segment
Method regex
The regex method adds a route based on regular expression to be evaluated against the complete URL.
Method regex_replace_var
Callback for build_regex replacements
Method remove_event_listener
Remove an event listener from this class.
Method rendered
Accessor for this controller's rendered flag
Method render_action
Render the template for the action
Method render_error
Render an error document
Method render_to_string
Render the template as a string.
Method require_https
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
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
The root method adds a route that matches the site root URL.
s
top
Variable $segmentsHead
Page Segment.php
Segment.php in Segment.php
Page StaticSegment.php
StaticSegment.php in StaticSegment.php
Method set_action
This method sets the controller's action
Method set_constraints
Set this route's constraints
Method set_defaults
Set this route's default parameters
Method set_error
Set the error flag for the controller
Method set_first_segment
Set this route's first segment
Method set_flash
Set a flash message
Method set_layout
This method sets the path to the layout to be used.
Method set_name
Set this route's name
Method set_next
Set the next segment in the route
Method set_position
Set this route's position
Method set_rendered
This method sets the controller's rendered flag
Method set_routing
Set the routing instance currently in use
Method set_template_defaults
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
Returns the current template cache ID, in case you want to vary the cached output based on some condition.
Method template_compile_id
Returns the current template compile ID, in case this controller changes the template directory.
u
top
Method url_for
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
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
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
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
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
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
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
Return the URL for a given set of parameters.
v
top
Variable $vars
Method value
Return the value of this segment in human readable form.
Method value
Return the value of this segment in human readable form.
Method value
Return the value of this segment in human readable form.
Method value
Return the value of this segment in human readable form.
Method value
Return the value of this segment in human readable form.
w
top
Method will_cache
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 _