[WebApplication] element index

Package indexes

• framework-base
• Mail_Mailer
• UI
• KeyValueCoding

__construct

WFWebApplication::__construct() in WFWebApplication.php

Constructor

__construct

WFRequestController::__construct() in WFRequestController.php

__construct

WFRedirectRequestException::__construct() in WFRequestController.php

$__sharedInstances

WFModule::$__sharedInstances in WFModule.php

__construct

WFModuleInvocation::__construct() in WFModule.php

Constructor used to create a new WFModuleInvocation.

__construct

WFModule::__construct() in WFModule.php

Constructor.

addModulePath

WFWebApplication::addModulePath() in WFWebApplication.php

If you have installed modules outside of your project's modules directory, you can tell PHOCOA where to look for them with this function.

appDirPath

WFWebApplication::appDirPath() in WFWebApplication.php

Get the absolute path of one of the application directories.

autoload

WFWebApplication::autoload() in WFWebApplication.php

Autoload callback for WFWebApplication.

autoload

WFWebApplicationDelegate::autoload() in WFWebApplicationDelegate.php

Autoload callback.

addInstance

WFModule::addInstance() in WFModule.php

allPages

WFModule::allPages() in WFModule.php

Tell the phocoa infrastructure which "pages" your module implements.

checkSecurity

WFModule::checkSecurity() in WFModule.php

Callback to allow the module to determine security clearance of the user.

$delegate

WFWebApplication::$delegate in WFWebApplication.php

defaultInvocationPath

WFWebApplication::defaultInvocationPath() in WFWebApplication.php

Get the default invocationPath for this web application. The default module is the module that will be run if the web root is accessed.

defaultSkinDelegate

WFWebApplication::defaultSkinDelegate() in WFWebApplication.php

Get the default Skin delegate for the application.

delegate

WFWebApplication::delegate() in WFWebApplication.php

Get the delegate for the WFWebApplication.

DIR_CLASSES

WFWebApplication::DIR_CLASSES in WFWebApplication.php

DIR_LOG

WFWebApplication::DIR_LOG in WFWebApplication.php

DIR_MODULES

WFWebApplication::DIR_MODULES in WFWebApplication.php

DIR_RUNTIME

WFWebApplication::DIR_RUNTIME in WFWebApplication.php

DIR_SKINS

WFWebApplication::DIR_SKINS in WFWebApplication.php

DIR_SMARTY

WFWebApplication::DIR_SMARTY in WFWebApplication.php

DIR_WWW

WFWebApplication::DIR_WWW in WFWebApplication.php

defaultModule

WFWebApplicationDelegate::defaultModule() in WFWebApplicationDelegate.php

Retrieve the default module for the application.

defaultSkinDelegate

WFWebApplicationDelegate::defaultSkinDelegate() in WFWebApplicationDelegate.php

Retreive the default skin delegate to use for the application.

defaultPage

WFModule::defaultPage() in WFModule.php

Get the default page to use for the module if no page is specified.

execute

WFModuleInvocation::execute() in WFModule.php

Execute the module wrapped by this invocation.

factory

WFModule::factory() in WFModule.php

Get a module instance for the specified module path.

getRedirectURL

WFRedirectRequestException::getRedirectURL() in WFRequestController.php

handleException

WFRequestController::handleException() in WFRequestController.php

Exception handler for the WFRequestController.

handleHTTPRequest

WFRequestController::handleHTTPRequest() in WFRequestController.php

Run the web application for the current request.

handleUncaughtException

WFWebApplicationDelegate::handleUncaughtException() in WFWebApplicationDelegate.php

A callback function so that the application can handle uncaught exceptions (ie log to database, email, etc)

initialize

WFWebApplication::initialize() in WFWebApplication.php

Hook to call the initialize method fo the web application.

isAjax

WFRequestController::isAjax() in WFRequestController.php

Is the current request an XHR (XmlHTTPRequest)?

initialize

WFWebApplicationDelegate::initialize() in WFWebApplicationDelegate.php

A callback function that your application can use to set up application config.

$invocation

WFModule::$invocation in WFModule.php

$invocationParameters

WFModuleInvocation::$invocationParameters in WFModule.php

$invocationPath

WFModuleInvocation::$invocationPath in WFModule.php

init

WFModule::init() in WFModule.php

invocation

WFModule::invocation() in WFModule.php

Get the module invocation.

invocationPath

WFModuleInvocation::invocationPath() in WFModule.php

Get the invocationPath that was used to create this WFModuleInvocation.

isRootInvocation

WFModuleInvocation::isRootInvocation() in WFModule.php

Is this module the root invocation?

loadConfigPHP

WFModule::loadConfigPHP() in WFModule.php

Load the shared.config file for the module and process it.

$modulePaths

WFWebApplication::$modulePaths in WFWebApplication.php

modulePaths

WFWebApplication::modulePaths() in WFWebApplication.php

Get the list of extra modules activates for this webapp.

$module

WFModuleInvocation::$module in WFModule.php

$moduleName

WFModuleInvocation::$moduleName in WFModule.php

$modulePath

WFModuleInvocation::$modulePath in WFModule.php

$modulesDir

WFModuleInvocation::$modulesDir in WFModule.php

module

WFModuleInvocation::module() in WFModule.php

Get the module that this invocation wraps.

moduleName

WFModule::moduleName() in WFModule.php

Get the module's name

moduleName

WFModuleInvocation::moduleName() in WFModule.php

Get the name of the module that this invocation is wrapping.

modulePath

WFModuleInvocation::modulePath() in WFModule.php

Get the module path to the current module.

modulesDir

WFModuleInvocation::modulesDir() in WFModule.php

Get the "modules" directory used to access this module.

outlet

WFModule::outlet() in WFModule.php

$pageName

WFModuleInvocation::$pageName in WFModule.php

$parentInvocation

WFModuleInvocation::$parentInvocation in WFModule.php

pageName

WFModuleInvocation::pageName() in WFModule.php

Get the name of the page that this invocation will call in the module.

parameters

WFModuleInvocation::parameters() in WFModule.php

Get the parameters that were provided in the invocationPath.

parametersAsPathInfo

WFModuleInvocation::parametersAsPathInfo() in WFModule.php

Get the parameters that were provided in the invocationPath, as a '/'-separated string.

PARAMETER_NULL_VALUE

WFModuleInvocation::PARAMETER_NULL_VALUE in WFModule.php

parentInvocation

WFModuleInvocation::parentInvocation() in WFModule.php

Get the parent invocation.

pathToModule

WFModule::pathToModule() in WFModule.php

Get the path to the module.

pathToPage

WFModule::pathToPage() in WFModule.php

Get the path to the given page.

prepareSharedInstances

WFModule::prepareSharedInstances() in WFModule.php

Prepare any declared shared instances for the module.

quickModule

WFModuleInvocation::quickModule() in WFModule.php

Easily convert an invocation path into the resulting HTML.

$rootModuleInvocation

WFRequestController::$rootModuleInvocation in WFRequestController.php

rootModuleInvocation

WFRequestController::rootModuleInvocation() in WFRequestController.php

Get the root WFModuleInvocation used by the request controller.

runWebApplication

WFWebApplication::runWebApplication() in WFWebApplication.php

Bootstrap control of the application to the RequestController.

$redirectUrl

WFRedirectRequestException::$redirectUrl in WFRequestController.php

$requestPage

WFModule::$requestPage in WFModule.php

$respondsToForms

WFModuleInvocation::$respondsToForms in WFModule.php

$responsePage

WFModule::$responsePage in WFModule.php

requestPage

WFModule::requestPage() in WFModule.php

Get the requestPage for the module.

respondsToForms

WFModuleInvocation::respondsToForms() in WFModule.php

should this invocation of this module respond to forms?

responsePage

WFModule::responsePage() in WFModule.php

Get the responsePage for the module.

rootInvocation

WFModuleInvocation::rootInvocation() in WFModule.php

Get the root invocation for this invocation. This may be the current invocation.

rootSkin

WFModuleInvocation::rootSkin() in WFModule.php

Get the skin used by the ROOT module of this module hierarchy.

serializeURL

WFWebApplication::serializeURL() in WFWebApplication.php

Helper function for encoding URL's in a fashion suitable for passing around as an invocationPath parameter.

sessionDidStart

WFWebApplication::sessionDidStart() in WFWebApplication.php

Hook to provide opportunity for the web application to munge the session data after php's session_start() is called.

sessionWillStart

WFWebApplication::sessionWillStart() in WFWebApplication.php

Hook to provide opportunity for the web application to munge the session config before php's session_start() is called.

sharedRequestController

WFRequestController::sharedRequestController() in WFRequestController.php

Get a reference to the shared WFRequestController object.

sharedSkin

WFRequestController::sharedSkin() in WFRequestController.php

Get a reference to this WFRequestController's skin object.

sharedWebApplication

WFWebApplication::sharedWebApplication() in WFWebApplication.php

Get a reference to the shared application object.

sessionDidStart

WFWebApplicationDelegate::sessionDidStart() in WFWebApplicationDelegate.php

Called just after the session is started.

sessionWillStart

WFWebApplicationDelegate::sessionWillStart() in WFWebApplicationDelegate.php

Called just before the session is started.

$skin

WFModuleInvocation::$skin in WFModule.php

setModulesDir

WFModuleInvocation::setModulesDir() in WFModule.php

Set the "modules" directory used to access this module.

setRespondsToForms

WFModuleInvocation::setRespondsToForms() in WFModule.php

Set whether or not the module in this invocation should respond to forms.

setSkinDelegate

WFModuleInvocation::setSkinDelegate() in WFModule.php

set the skin delegate for this invocation.

setTargetRootModule

WFModuleInvocation::setTargetRootModule() in WFModule.php

Should this invocation target the root invocation's module, or the current module?

setupResponsePage

WFModule::setupResponsePage() in WFModule.php

Call this method if you want the ResponsePage to be the same as the RequestPage.

sharedInstancesDidLoad

WFModule::sharedInstancesDidLoad() in WFModule.php

Optional method for WFModule subclasses if they want to know when the shared instances have finished loading.

shouldProfile

WFModule::shouldProfile() in WFModule.php

Should APD profiling be enabled for this request? To enable profiling of your module, just add shouldProfile() to your WFModule and return TRUE.

skin

WFModuleInvocation::skin() in WFModule.php

Get the skin for this module invocation.

$targetRootModule

WFModuleInvocation::$targetRootModule in WFModule.php

targetRootModule

WFModuleInvocation::targetRootModule() in WFModule.php

Does this invocation target the root invocation's module, or the current module?

unserializeURL

WFWebApplication::unserializeURL() in WFWebApplication.php

Decode data encoded with serializeURL.

WFRequestController.php

WFRequestController.php in WFRequestController.php

WFWebApplication.php

WFWebApplication.php in WFWebApplication.php

webDirPath

WFWebApplication::webDirPath() in WFWebApplication.php

Get the www-absolute path of one of the application's public www directories.

WFRequestController

WFRequestController in WFRequestController.php

The RequestController object is a singleton controller for the entire request-act-respond cycle.

WFURL

WFRequestController::WFURL() in WFRequestController.php

Generate a "full" URL to the given module / page.

WFWebApplication

WFWebApplication in WFWebApplication.php

The WFWebApplication object is a singleton object that manages the running of the any Phocoa request, be it CLI or HTTP.

WFWebApplicationMain

WFWebApplicationMain() in WFWebApplication.php

BOOTSTRAP function used by the main web page to start our framework.

WWW_DIR_BASE

WFWebApplication::WWW_DIR_BASE in WFWebApplication.php

WWW_DIR_FRAMEWORK

WFWebApplication::WWW_DIR_FRAMEWORK in WFWebApplication.php

WFWebApplicationDelegate.php

WFWebApplicationDelegate.php in WFWebApplicationDelegate.php

WFWebApplicationDelegate

WFWebApplicationDelegate in WFWebApplicationDelegate.php

Delegate methods for WFWebApplication.

WFRedirectRequestException

WFRedirectRequestException in WFRequestController.php

Helper class to allow modules to easily redirect the client to a given URL.

WFRequestController_BadRequestException

WFRequestController_BadRequestException in WFRequestController.php

A helper class to easily throw named exceptions.

WFRequestController_InternalRedirectException

WFRequestController_InternalRedirectException in WFRequestController.php

Helper class to allow modules to easily redirect the client to a given URL.

WFRequestController_NotFoundException

WFRequestController_NotFoundException in WFRequestController.php

A helper class to easily throw named exceptions.

WFRequestController_RedirectException

WFRequestController_RedirectException in WFRequestController.php

Helper class to allow modules to easily redirect the client to a given URL.

WFModule.php

WFModule.php in WFModule.php

WFModule

WFModule in WFModule.php

The WFModule represents a single chunk of web application functionality.

WFModuleInvocation

WFModuleInvocation in WFModule.php

The WFModuleInvocation object is a wrapper around WFModule. This allows the modules to be nicely decoupled from the callers. Thus, the http handler can create a WFModuleInvocation based on the URL, while a WFModuleView can create one based on parameters set by a caller.

WFURL

WFModule::WFURL() in WFModule.php

Generate a "full" URL to the given module / page.

WFSession.php

WFSession.php in WFSession.php