[phruts-action] element index

Package indexes

• phruts-connector
• phruts-config
• phruts-exception
• phruts
• phruts-plugins
• phruts-plugins-smarty
• phruts-util

__construct

PHRUTS_RequestProcessor::__construct() in PHRUTS_RequestProcessor.php

__construct

PHRUTS_ServiceContext::__construct() in PHRUTS_ServiceContext.php

__construct

PHRUTS_Action::__construct() in PHRUTS_Action.php

__construct

PHRUTS_ActionService::__construct() in PHRUTS_ActionService.php

__construct

PHRUTS_ActionErrorItem::__construct() in PHRUTS_ActionErrors.php

__construct

PHRUTS_ActionError::__construct() in PHRUTS_ActionError.php

Construct an action message with the specified replacement values.

__wakeup

PHRUTS_Action::__wakeup() in PHRUTS_Action.php

__wakeup

PHRUTS_RequestProcessor::__wakeup() in PHRUTS_RequestProcessor.php

__wakeup

PHRUTS_ActionService::__wakeup() in PHRUTS_ActionService.php

$actions

PHRUTS_RequestProcessor::$actions in PHRUTS_RequestProcessor.php

The set of PHRUTS_Action instances that have been created and initialized, keyed by the fully qualified PHP class name of the PHRUTS_Action class.

$attributes

PHRUTS_ServiceContext::$attributes in PHRUTS_ServiceContext.php

The context attributes.

add

PHRUTS_ActionErrors::add() in PHRUTS_ActionErrors.php

Add an error message to the set of errors for the specified property.

$basePath

PHRUTS_ServiceContext::$basePath in PHRUTS_ServiceContext.php

Base path of the web application.

$config

PHRUTS_ActionService::$config in PHRUTS_ActionService.php

Comma-separated list of context-relative path(s) to our configuration resource(s) for the default module.

$configDigester

PHRUTS_ActionService::$configDigester in PHRUTS_ActionService.php

The digester used to produce PHRUTS_ModuleConfig object from a PHruts configuration file.

clear

PHRUTS_ActionErrors::clear() in PHRUTS_ActionErrors.php

Clear all errors recorded by this object.

$dataSourceFactories

PHRUTS_ActionService::$dataSourceFactories in PHRUTS_ActionService.php

The factories data sources that has been configured for this module, if any.

$defaultLocale

PHRUTS_Action::$defaultLocale in PHRUTS_Action.php

The system default PHRUTS_Locale.

destroy

PHRUTS_PlugIn::destroy() in PHRUTS_PlugIn.php

Receive notification that our owning module is being shut down.

doForward

PHRUTS_RequestProcessor::doForward() in PHRUTS_RequestProcessor.php

Do a forward to specified uri using request dispatcher.

doInclude

PHRUTS_RequestProcessor::doInclude() in PHRUTS_RequestProcessor.php

Do an include of specified uri using request dispatcher.

$errors

PHRUTS_ActionErrors::$errors in PHRUTS_ActionErrors.php

The accumulated set of PHRUTS_ActionError objects for each property, keyed by property name.

execute

PHRUTS_Action::execute() in PHRUTS_Action.php

Process the specified HTTP request, and create the corresponding HTTP response (or forward to another web component that will create it), with provision for handling exceptions thrown by the business logic.

get

PHRUTS_ActionErrors::get() in PHRUTS_ActionErrors.php

Return the set of errors related to a specific property or the set of all recorded errors (property = "") without distinction by which property the errors are associated with.

getAttribute

PHRUTS_ServiceContext::getAttribute() in PHRUTS_ServiceContext.php

Returns the attribute with the given name, or null if there is no attribute by that name.

getAttributeNames

PHRUTS_ServiceContext::getAttributeNames() in PHRUTS_ServiceContext.php

Returns an array containing the attribute names available within this context.

getDataSource

PHRUTS_Action::getDataSource() in PHRUTS_Action.php

Return the specified data source for the current module.

getDataSource

PHRUTS_ActionService::getDataSource() in PHRUTS_ActionService.php

Return the specified data source for the current module.

getInitParameter

PHRUTS_ServiceContext::getInitParameter() in PHRUTS_ServiceContext.php

Returns a string containing the value of the named initialization parameter, or null if the parameter does not exist.

getInitParameterNames

PHRUTS_ServiceContext::getInitParameterNames() in PHRUTS_ServiceContext.php

Returns the names of the service's initialization parameters.

getInternal

PHRUTS_RequestProcessor::getInternal() in PHRUTS_RequestProcessor.php

Return the PHRUTS_MessageResources instance containing our internal message strings.

getInternal

PHRUTS_ActionService::getInternal() in PHRUTS_ActionService.php

Return the PHRUTS_MessageResources instance containing our internal message strings.

getKey

PHRUTS_ActionError::getKey() in PHRUTS_ActionError.php

Get the message key for this message.

getList

PHRUTS_ActionErrorItem::getList() in PHRUTS_ActionErrors.php

getLocale

PHRUTS_Action::getLocale() in PHRUTS_Action.php

Return the user's currently selected Locale.

getModuleConfig

PHRUTS_ActionService::getModuleConfig() in PHRUTS_ActionService.php

Return the module configuration object for the currently selected module.

getOrder

PHRUTS_ActionErrorItem::getOrder() in PHRUTS_ActionErrors.php

getRealPath

PHRUTS_ServiceContext::getRealPath() in PHRUTS_ServiceContext.php

Returns the real path for a given virtual path.

getRequestDispatcher

PHRUTS_ServiceContext::getRequestDispatcher() in PHRUTS_ServiceContext.php

Returns a PHRUTS_RequestDispatcher object that acts as a wrapper for the resource located at the given path.

getRequestProcessor

PHRUTS_ActionService::getRequestProcessor() in PHRUTS_ActionService.php

Look up and return the PHRUTS_RequestProcessor responsible for the specified module, creating a new one if necessary.

getResources

PHRUTS_Action::getResources() in PHRUTS_Action.php

Return the specified or default (key = "") message resources for the current module.

getService

PHRUTS_ActionForm::getService() in PHRUTS_ActionForm.php

Return the controller service instance to which we are attached.

getService

PHRUTS_Action::getService() in PHRUTS_Action.php

Return the controller service instance to which we are attached.

getServiceConfig

PHRUTS_ServiceContext::getServiceConfig() in PHRUTS_ServiceContext.php

Get the service configuration object associated with this context.

getServiceContext

PHRUTS_ActionService::getServiceContext() in PHRUTS_ActionService.php

getValues

PHRUTS_ActionError::getValues() in PHRUTS_ActionError.php

Get the replacement values for this message.

GLOBAL_ERROR

PHRUTS_ActionErrors::GLOBAL_ERROR in PHRUTS_ActionErrors.php

The "property name" marker to use for global errors, as opposed to those related to a specific property.

$iCount

PHRUTS_ActionErrors::$iCount in PHRUTS_ActionErrors.php

The current number of the property/key being added. This is used to maintain the order errors are added.

$internal

PHRUTS_ActionService::$internal in PHRUTS_ActionService.php

The resources object for our internal resources.

$internalName

PHRUTS_ActionService::$internalName in PHRUTS_ActionService.php

The PHP base name of our internal resources.

$iOrder

PHRUTS_ActionErrorItem::$iOrder in PHRUTS_ActionErrors.php

The position in the list of errors.

init

PHRUTS_ActionService::init() in PHRUTS_ActionService.php

Initialize this service.

init

PHRUTS_RequestProcessor::init() in PHRUTS_RequestProcessor.php

Initialize this request processor instance.

init

PHRUTS_PlugIn::init() in PHRUTS_PlugIn.php

Receive notification that the specified module is being started up.

initConfigDigester

PHRUTS_ActionService::initConfigDigester() in PHRUTS_ActionService.php

Create (if needed) and return a new PHIGEST_Digester instance that has been initialized to process PHruts module configuration file and configure a corresponding PHRUTS_ModuleConfig object (which must be pushed on to the evaluation stack before parsing begins).

initInternal

PHRUTS_ActionService::initInternal() in PHRUTS_ActionService.php

Initialize our internal message resources bundle.

initModuleConfig

PHRUTS_ActionService::initModuleConfig() in PHRUTS_ActionService.php

Initialize the application configuration information for the specified module.

initModuleDataSources

PHRUTS_ActionService::initModuleDataSources() in PHRUTS_ActionService.php

Initialize the data sources for the specified module.

initModuleMessageResources

PHRUTS_ActionService::initModuleMessageResources() in PHRUTS_ActionService.php

Initialize the application message resources for the specified module.

initModulePlugIns

PHRUTS_ActionService::initModulePlugIns() in PHRUTS_ActionService.php

Initialize the plug ins for the specified module.

initService

PHRUTS_ActionService::initService() in PHRUTS_ActionService.php

Initialize global characteristics of the controller service.

isCancelled

PHRUTS_Action::isCancelled() in PHRUTS_Action.php

Returns true if the current form's cancel button was pressed.

isEmpty

PHRUTS_ActionErrors::isEmpty() in PHRUTS_ActionErrors.php

Return true if there are no errors recorded in this collection, or false otherwise.

$key

PHRUTS_ActionError::$key in PHRUTS_ActionError.php

The message key for this message.

$list

PHRUTS_ActionErrorItem::$list in PHRUTS_ActionErrors.php

The list of PHRUTS_ActionError.

$log

PHRUTS_RequestProcessor::$log in PHRUTS_RequestProcessor.php

Commons Logging instance.

$log

PHRUTS_ActionService::$log in PHRUTS_ActionService.php

Logging instance.

$moduleConfig

PHRUTS_RequestProcessor::$moduleConfig in PHRUTS_RequestProcessor.php

The PHRUTS_ModuleConfiguration we are associated with.

$processor

PHRUTS_ActionService::$processor in PHRUTS_ActionService.php

The PHRUTS_RequestProcessor instance we will use to process all incoming requests.

PHRUTS_Action.php

PHRUTS_Action.php in PHRUTS_Action.php

PHRUTS_ActionError.php

PHRUTS_ActionError.php in PHRUTS_ActionError.php

PHRUTS_ActionErrors.php

PHRUTS_ActionErrors.php in PHRUTS_ActionErrors.php

PHRUTS_ActionForm.php

PHRUTS_ActionForm.php in PHRUTS_ActionForm.php

PHRUTS_ActionService.php

PHRUTS_ActionService.php in PHRUTS_ActionService.php

PHRUTS_PlugIn.php

PHRUTS_PlugIn.php in PHRUTS_PlugIn.php

PHRUTS_RequestProcessor.php

PHRUTS_RequestProcessor.php in PHRUTS_RequestProcessor.php

PHRUTS_ServiceContext.php

PHRUTS_ServiceContext.php in PHRUTS_ServiceContext.php

PHRUTS_Action

PHRUTS_Action in PHRUTS_Action.php

A PHRUTS_Action is an adapter between the contents of an incoming HTTP request and the corresponding business logic that should be executed to process this request.

PHRUTS_ActionError

PHRUTS_ActionError in PHRUTS_ActionError.php

An encapsulation of an individual error message returned by the validate() method of an PHRUTS_ActionForm.

PHRUTS_ActionErrorItem

PHRUTS_ActionErrorItem in PHRUTS_ActionErrors.php

This class is used to store a set of errors associated with a property/key and the position it was initially added to list.

PHRUTS_ActionErrors

PHRUTS_ActionErrors in PHRUTS_ActionErrors.php

A class that encapsulates the error messages being reported by the validate() method of a PHRUTS_ActionForm.

PHRUTS_ActionForm

PHRUTS_ActionForm in PHRUTS_ActionForm.php

A PHRUTS_ActionForm is a PHPBean optionally associated with one or more PHRUTS_ActionConfig.

PHRUTS_ActionService

PHRUTS_ActionService in PHRUTS_ActionService.php

PHRUTS_ActionService represents the "controller" in the Model-View-Controller (MVC) design pattern for web applications that is commonly known as "Model 2".

PHRUTS_PlugIn

PHRUTS_PlugIn in PHRUTS_PlugIn.php

A PHRUTS_PlugIn is a configuration wrapper for a module-specific resource or service that needs to be notified about application startup and application shutdown events (corresponding to calls init() and destroy() on the corresponding PHRUTS_ActionService instance).

PHRUTS_RequestProcessor

PHRUTS_RequestProcessor in PHRUTS_RequestProcessor.php

PHRUTS_RequestProcessor contains the processing logic that the PHruts controller service performs as it receives each service request.

PHRUTS_ServiceContext

PHRUTS_ServiceContext in PHRUTS_ServiceContext.php

Defines a set of methods that a controller service uses to get initialization parameters and store glogal attributes.

process

PHRUTS_ActionService::process() in PHRUTS_ActionService.php

Perform the standard request processing for this request, and create the corresponding response.

process

PHRUTS_RequestProcessor::process() in PHRUTS_RequestProcessor.php

Process a PHRUTS_HttpServiceRequest and create the corresponding PHRUTS_HttpServiceResponse.

processActionCreate

PHRUTS_RequestProcessor::processActionCreate() in PHRUTS_RequestProcessor.php

Return a PHRUTS_Action instance that will be used to process the current request, creating a new one if necessary.

processActionForm

PHRUTS_RequestProcessor::processActionForm() in PHRUTS_RequestProcessor.php

Retrieve and return the PHRUTS_ActionForm bean associated with this mapping, creating and stashing one if necessary.

processActionPerform

PHRUTS_RequestProcessor::processActionPerform() in PHRUTS_RequestProcessor.php

Ask the specified PHRUTS_Action instance to handle this request.

processContent

PHRUTS_RequestProcessor::processContent() in PHRUTS_RequestProcessor.php

Set the default content type (with optional character encoding) for all responses if requested.

processForward

PHRUTS_RequestProcessor::processForward() in PHRUTS_RequestProcessor.php

Process a forward requested by this mapping (if any).

processForwardConfig

PHRUTS_RequestProcessor::processForwardConfig() in PHRUTS_RequestProcessor.php

Forward or redirect to the specified destination, by the specified mechanism.

processInclude

PHRUTS_RequestProcessor::processInclude() in PHRUTS_RequestProcessor.php

Process an include requested by this mapping (if any).

processLocale

PHRUTS_RequestProcessor::processLocale() in PHRUTS_RequestProcessor.php

Automatically select a PHRUTS_Locale for the current user, if requested.

processMapping

PHRUTS_RequestProcessor::processMapping() in PHRUTS_RequestProcessor.php

Select the mapping used to process the selection path for this request.

processNoCache

PHRUTS_RequestProcessor::processNoCache() in PHRUTS_RequestProcessor.php

Set the no-cache headers for all responses, if requested.

processPath

PHRUTS_RequestProcessor::processPath() in PHRUTS_RequestProcessor.php

Identify and return the path component (from the request URI) that we will use to select a PHRUTS_ActionConfig to dispatch with.

processPopulate

PHRUTS_RequestProcessor::processPopulate() in PHRUTS_RequestProcessor.php

Populate the properties of the specified PHRUTS_ActionForm instance from the request parameters included with this request.

processPreprocess

PHRUTS_RequestProcessor::processPreprocess() in PHRUTS_RequestProcessor.php

General-purpose preprocessing hook that can be overridden as required by subclasses.

processRoles

PHRUTS_RequestProcessor::processRoles() in PHRUTS_RequestProcessor.php

If this action is protected by security roles, make sure that the current user possesses at least one of them.

processValidate

PHRUTS_RequestProcessor::processValidate() in PHRUTS_RequestProcessor.php

If this request was not cancelled, and the request's PHRUTS_ActionConfig has not disabled validation, call the validate method of the specified PHRUTS_ActionForm, and forward back to the input form if there were any errors.

properties

PHRUTS_ActionErrors::properties() in PHRUTS_ActionErrors.php

Return the set of property names for which at least one message has been recorded.

$requestDispatcher

PHRUTS_ServiceContext::$requestDispatcher in PHRUTS_ServiceContext.php

The request dispatcher object associated with this context.

removeAttribute

PHRUTS_ServiceContext::removeAttribute() in PHRUTS_ServiceContext.php

Removes the attribute with the given name from the context.

reset

PHRUTS_ActionForm::reset() in PHRUTS_ActionForm.php

Reset all bean properties to their default state.

$service

PHRUTS_RequestProcessor::$service in PHRUTS_RequestProcessor.php

The controller service we are associated with.

$service

PHRUTS_ActionForm::$service in PHRUTS_ActionForm.php

The controller service instance to which we are attached.

$service

PHRUTS_Action::$service in PHRUTS_Action.php

The controller service to which we are attached.

$serviceConfig

PHRUTS_ServiceContext::$serviceConfig in PHRUTS_ServiceContext.php

The service configuration object associated with this context.

$serviceContext

PHRUTS_ActionService::$serviceContext in PHRUTS_ActionService.php

Service context.

saveErrors

PHRUTS_Action::saveErrors() in PHRUTS_Action.php

Save the specified error messages keys into the appropriate request attribute, if any messages are required.

setAttribute

PHRUTS_ServiceContext::setAttribute() in PHRUTS_ServiceContext.php

Binds an object to a given attribute name in this context.

setList

PHRUTS_ActionErrorItem::setList() in PHRUTS_ActionErrors.php

setLocale

PHRUTS_Action::setLocale() in PHRUTS_Action.php

Set the user's currently selected PHRUTS_Locale.

setOrder

PHRUTS_ActionErrorItem::setOrder() in PHRUTS_ActionErrors.php

setRequestDispatcher

PHRUTS_ServiceContext::setRequestDispatcher() in PHRUTS_ServiceContext.php

Set the request dispatcher object associated with this context.

setService

PHRUTS_Action::setService() in PHRUTS_Action.php

Set the controller service instance to which we are attached (if service is non-null), or release any allocated resources (if service is null).

setService

PHRUTS_ActionForm::setService() in PHRUTS_ActionForm.php

Set the controller service instance to which we are attached (if service is non-null), or release any allocated resources (if service is null).

size

PHRUTS_ActionErrors::size() in PHRUTS_ActionErrors.php

Return the number of errors associated with the specified property or for all properties (including global errors) if property is empty.

$values

PHRUTS_ActionError::$values in PHRUTS_ActionError.php

The replacement values for this message.

validate

PHRUTS_ActionForm::validate() in PHRUTS_ActionForm.php

Validate the properties that have been set for this HTTP request, and return a PHRUTS_ActionErrors object that encapsulates any validation errors that have been found.