mojavi
[ class tree: mojavi ] [ index: mojavi ] [ all elements ]

Index of all elements

[ a ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ w ]

a

Action
in file Action.class.php, class Action
    All Action implementations must extend this class. An Action implementation is used to execute business logic, which should be encapsulated in a model. A model is a class that provides methods to manipulate data that is linked to something, such as a database.
Action
in file Action.class.php, method Action::Action()
    Create a new Action instance.
ActionChain
in file ActionChain.class.php, method ActionChain::ActionChain()
    Create a new ActionChain instance.
ActionChain
in file ActionChain.class.php, class ActionChain
    An ActionChain implementation allows you to execute multiple actions and retrieve their results. This makes it a prime candidate for retrieving information from external Action implementations.
ActionChain.class.php
procedural page ActionChain.class.php
actionExists
in file Controller.class.php, method Controller::actionExists()
    Determine if an action exists.
Action.class.php
procedural page Action.class.php
addAppender
in file Logger.class.php, method Logger::addAppender()
    Add an appender.
addLogger
in file LogManager.class.php, method LogManager::addLogger()
    Add a logger.
addRequest
in file ExecutionChain.class.php, method ExecutionChain::addRequest()
    Add an action request to the chain.
Appender
in file Appender.class.php, class Appender
    Appender allows you to log messags to any location.
Appender
in file Appender.class.php, method Appender::Appender()
    Create a new Appender instance.
AUTH_DIR
in file Controller.class.php, constant AUTH_DIR
    Custom authentication handlers reside here.
Appender.class.php
procedural page Appender.class.php
top

c

cleanup
in file Appender.class.php, method Appender::cleanup()
    Cleanup appender resources if any exist.
cleanup
in file View.class.php, method View::cleanup()
    Cleanup temporary view data.
cleanup
in file Logger.class.php, method Logger::cleanup()
    Cleanup all appenders.
cleanup
in file LogManager.class.php, method LogManager::cleanup()
    Cleanup all loggers.
clearAll
in file User.class.php, method User::clearAll()
    Clear all user data.
clearAttributes
in file User.class.php, method User::clearAttributes()
    Clear all attribute namespaces and their associated attributes.
clearResult
in file Renderer.class.php, method Renderer::clearResult()
    Clear the rendered result.
Controller
in file Controller.class.php, class Controller
    Controller dispatches requests to the proper action and controls application flow.
Controller.class.php
procedural page Controller.class.php
top

d

$dir
in file Renderer.class.php, variable Renderer::$dir
    An absolute file-system path where a template can be found.
dispatch
in file Controller.class.php, method Controller::dispatch()
    Dispatch a request.
top

e

$engine
in file Renderer.class.php, variable Renderer::$engine
    The template engine instance.
execute
in file ExecutionFilter.class.php, method ExecutionFilter::execute()
    Execute this filter.
execute
in file Filter.class.php, method Filter::execute()
    Execute the filter.
execute
in file FilterChain.class.php, method FilterChain::execute()
    Execute the next filter in the chain.
execute
in file Action.class.php, method Action::execute()
    Execute all business logic.
execute
in file Renderer.class.php, method Renderer::execute()
    Render the view.
execute
in file ValidatorManager.class.php, method ValidatorManager::execute()
    Execute all validators.
execute
in file Validator.class.php, method Validator::execute()
    Execute the validator.
execute
in file View.class.php, method View::execute()
    Render the presentation.
execute
in file ActionChain.class.php, method ActionChain::execute()
    Execute all registered actions.
ExecutionChain
in file ExecutionChain.class.php, method ExecutionChain::ExecutionChain()
    Create a new ExecutionChain instance.
ExecutionChain
in file ExecutionChain.class.php, class ExecutionChain
    ExecutionChain allows you to view all executed actions for a single request.
ExecutionChain.class.php
procedural page ExecutionChain.class.php
ExecutionFilter
in file ExecutionFilter.class.php, method ExecutionFilter::ExecutionFilter()
    Create a new ExecutionFilter instance.
ExecutionFilter
in file ExecutionFilter.class.php, class ExecutionFilter
    ExecutionFilter is the main filter that does controls the validation, action execution and view rendering.
ExecutionFilter.class.php
procedural page ExecutionFilter.class.php
top

f

fetchResult
in file Renderer.class.php, method Renderer::fetchResult()
    Retrieve the rendered result when render mode is RENDER_VAR.
fetchResult
in file ActionChain.class.php, method ActionChain::fetchResult()
    Fetch the result of an executed action.
Filter
in file Filter.class.php, method Filter::Filter()
    Create a new Filter instance.
Filter
in file Filter.class.php, class Filter
    Filter allows you to intercept a request and handle pre-action execution or control the result of an action after it has been executed.
FilterChain
in file FilterChain.class.php, method FilterChain::FilterChain()
    Create a new FilterChain instance.
FilterChain
in file FilterChain.class.php, class FilterChain
    FilterChain controls filter execution.
FilterList
in file FilterList.class.php, method FilterList::FilterList()
    Create a new FilterList instance.
FilterList
in file FilterList.class.php, class FilterList
    FilterList allows you to register a list of filters in a specific order.
FILTER_DIR
in file Controller.class.php, constant FILTER_DIR
    Custom filters reside here.
FilterChain.class.php
procedural page FilterChain.class.php
FilterList.class.php
procedural page FilterList.class.php
Filter.class.php
procedural page Filter.class.php
format
in file Layout.class.php, method Layout::format()
    Format a message.
forward
in file Controller.class.php, method Controller::forward()
    Forward the request to an action.
top

g

genURL
in file Controller.class.php, method Controller::genURL()
    Generate a formatted Mojavi URL.
getAction
in file ExecutionChain.class.php, method ExecutionChain::getAction()
    Retrieve the Action instance at the given index.
getAction
in file Controller.class.php, method Controller::getAction()
    Retrieve an action implementation instance.
getActionName
in file ExecutionChain.class.php, method ExecutionChain::getActionName()
    Retrieve the action name associated with the request at the given index.
getAppender
in file Logger.class.php, method Logger::getAppender()
    Retrieve an appender.
getAttribute
in file User.class.php, method User::getAttribute()
    Retrieve an attribute.
getAttribute
in file Renderer.class.php, method Renderer::getAttribute()
    Retrieve an attribute.
getAttribute
in file Request.class.php, method Request::getAttribute()
    Retrieve an attribute.
getAttributeNames
in file User.class.php, method User::getAttributeNames()
    Retrieve an indexed array of attribute names.
getAttributeNames
in file Request.class.php, method Request::getAttributeNames()
    Retrieve an indexed array of attribute names.
getAttributeNamespaces
in file User.class.php, method User::getAttributeNamespaces()
    Retrieve an indexed array of attribute namespaces.
getAttributes
in file Request.class.php, method Request::getAttributes()
    Retrieve an associative array of all attributes.
getAttributes
in file User.class.php, method User::getAttributes()
    Retrieve an associative array of namespace attributes.
getAuthorizationHandler
in file Controller.class.php, method Controller::getAuthorizationHandler()
    Retrieve the developer supplied authorization handler.
getContainer
in file User.class.php, method User::getContainer()
    Retrieve the container.
getContentType
in file Controller.class.php, method Controller::getContentType()
    Retrieve the user supplied content type.
getControllerPath
in file Controller.class.php, method Controller::getControllerPath()
    Retrieve an absolute web path to the public controller file.
getCookie
in file Request.class.php, method Request::getCookie()
    Retrieve a cookie.
getCookieNames
in file Request.class.php, method Request::getCookieNames()
    Retrieve an indexed array of cookie names.
getCookies
in file Request.class.php, method Request::getCookies()
    Retrieve an associative array of cookies.
getCurrentAction
in file Controller.class.php, method Controller::getCurrentAction()
    Retrieve the name of the currently processing action.
getCurrentModule
in file Controller.class.php, method Controller::getCurrentModule()
    Retrieve the name of the currently processing module.
getDefaultLogger
in file LogManager.class.php, method LogManager::getDefaultLogger()
    Retrieve the default logger.
getDefaultView
in file Action.class.php, method Action::getDefaultView()
    Retrieve the default view.
getEngine
in file Renderer.class.php, method Renderer::getEngine()
    Retrieve the template engine instance.
getError
in file Request.class.php, method Request::getError()
    Retrieve an error message.
getErrorMessage
in file Validator.class.php, method Validator::getErrorMessage()
    Retrieve the default error message.
getErrors
in file Request.class.php, method Request::getErrors()
    Retrieve an associative array of errors.
getExecutionChain
in file Controller.class.php, method Controller::getExecutionChain()
    Retrieve the execution chain.
getExitPriority
in file Logger.class.php, method Logger::getExitPriority()
    Retrieve the priority level that must be met or exceeded in order for Mojavi to exit upon the logging of a message.
getInstance
in file LogManager.class.php, method LogManager::getInstance()
    Retrieve the single instance of LogManager.
getInstance
in file Controller.class.php, method Controller::getInstance()
    Retrieve the single instance of Controller.
getLayout
in file Appender.class.php, method Appender::getLayout()
    Retrieve the layout this appender is using.
getLogger
in file LogManager.class.php, method LogManager::getLogger()
    Retrieve a logger.
getLoggers
in file LogManager.class.php, method LogManager::getLoggers()
    Retrieve an associative array of loggers.
getMethod
in file Request.class.php, method Request::getMethod()
    Retrieve the request method used for this request.
getMode
in file Renderer.class.php, method Renderer::getMode()
    Retrieve the render mode, which is one of the following:
getModuleDir
in file Controller.class.php, method Controller::getModuleDir()
    Retrieve an absolute file-system path home directory of the currently processing module.
getModuleName
in file ExecutionChain.class.php, method ExecutionChain::getModuleName()
    Retrieve the module name associated with the request at the given index.
getMojavi
in file Controller.class.php, method Controller::getMojavi()
    Retrieve the Mojavi associative array.
getParameter
in file Message.class.php, method Message::getParameter()
    Retrieve a parameter.
getParameter
in file Validator.class.php, method Validator::getParameter()
    Retrieve a parameter.
getParameter
in file Request.class.php, method Request::getParameter()
    Retrieve a user submitted parameter.
getParameterNames
in file Request.class.php, method Request::getParameterNames()
    Retrieve an indexed array of user submitted parameter names.
getParameters
in file Request.class.php, method Request::getParameters()
    Retrieve an associative array of user submitted parameters.
getPriority
in file Logger.class.php, method Logger::getPriority()
    Retrieve the priority level that must be met or exceeded in order for this logger to log a message.
getPrivilege
in file Action.class.php, method Action::getPrivilege()
    Retrieve the privilege required to access this action.
getRenderMode
in file Controller.class.php, method Controller::getRenderMode()
    Retrieve the global render mode.
getRequest
in file ExecutionChain.class.php, method ExecutionChain::getRequest()
    Retrieve a request and its associated data.
getRequest
in file Controller.class.php, method Controller::getRequest()
    Retrieve the request instance.
getRequestAction
in file Controller.class.php, method Controller::getRequestAction()
    Retrieve the name of the originally requested action.
getRequestMethods
in file Action.class.php, method Action::getRequestMethods()
    Retrieve the HTTP request method(s) this action will serve.
getRequestModule
in file Controller.class.php, method Controller::getRequestModule()
    Retrieve the name of the originally requested module.
getRequests
in file ExecutionChain.class.php, method ExecutionChain::getRequests()
    Retrieve all requests and their associated data.
getSessionHandler
in file Controller.class.php, method Controller::getSessionHandler()
    Retrieve the developer supplied session handler.
getSize
in file ExecutionChain.class.php, method ExecutionChain::getSize()
    Retrieve the size of the chain.
getTemplateDir
in file Renderer.class.php, method Renderer::getTemplateDir()
    Retrieve an absolute file-system path to the template directory.
getUser
in file Controller.class.php, method Controller::getUser()
    Retrieve the currently requesting user.
getView
in file Controller.class.php, method Controller::getView()
    Retrieve a view implementation instance.
GET_FORMAT
in file Controller.class.php, constant GET_FORMAT
    Format URL's in the typical GET style.
top

h

handleError
in file Action.class.php, method Action::handleError()
    Handle a validation error.
hasAttribute
in file User.class.php, method User::hasAttribute()
    Determine if the user has an attribute.
hasAttribute
in file Request.class.php, method Request::hasAttribute()
    Determine if an attribute exists.
hasCookie
in file Request.class.php, method Request::hasCookie()
    Determine if a cookie exists.
hasError
in file Request.class.php, method Request::hasError()
    Determine if an error has been set.
hasErrors
in file Request.class.php, method Request::hasErrors()
    Determine if any error has been set.
hasLogger
in file LogManager.class.php, method LogManager::hasLogger()
    Determine if a logger exists.
hasParameter
in file Request.class.php, method Request::hasParameter()
    Determine if the request has a parameter.
hasParameter
in file Message.class.php, method Message::hasParameter()
    Determine if a parameter was set.
top

i

initialize
in file Validator.class.php, method Validator::initialize()
    Initialize the validator.
initialize
in file Action.class.php, method Action::initialize()
    Execute action initialization procedure.
initialize
in file Filter.class.php, method Filter::initialize()
    Initialize the filter.
isAuthenticated
in file User.class.php, method User::isAuthenticated()
    Determine the authenticated status of the user.
isPathAbsolute
in file Renderer.class.php, method Renderer::isPathAbsolute()
    Determine if a file-system path is absolute.
isSecure
in file Action.class.php, method Action::isSecure()
    Determine if this action requires authentication.
top

l

Layout
in file Layout.class.php, class Layout
    Layout provides a customizable way to format data for an appender.
Layout
in file Layout.class.php, method Layout::Layout()
    Create a new Layout instance.
LEVEL_DEBUG
in file Logger.class.php, constant LEVEL_DEBUG
    Debugging priority level.
LEVEL_ERROR
in file Logger.class.php, constant LEVEL_ERROR
    Error priority level.
LEVEL_FATAL
in file Logger.class.php, constant LEVEL_FATAL
    Fatal priority level.
LEVEL_INFO
in file Logger.class.php, constant LEVEL_INFO
    Info priority level.
LEVEL_WARN
in file Logger.class.php, constant LEVEL_WARN
    Warning priority level.
LIB_DIR
in file Controller.class.php, constant LIB_DIR
    Globally available library files reside here.
load
in file User.class.php, method User::load()
    Load data from the container.
log
in file Logger.class.php, method Logger::log()
    Log a message.
Logger
in file Logger.class.php, method Logger::Logger()
    Create a new Logger instance.
Logger
in file Logger.class.php, class Logger
    Logger provides an interface for logging messages to multiple appenders.
LOGGING_DIR
in file Controller.class.php, constant LOGGING_DIR
    Custom logging utilities reside here.
Layout.class.php
procedural page Layout.class.php
Logger.class.php
procedural page Logger.class.php
LogManager.class.php
procedural page LogManager.class.php
LogManager
in file LogManager.class.php, class LogManager
    LogManager manages all loggers.
top

m

Message.class.php
procedural page Message.class.php
mergeAttributes
in file User.class.php, method User::mergeAttributes()
    Merge a new set of attributes with the existing set.
Message
in file Message.class.php, method Message::Message()
    Create a new Message instance.
Message
in file Message.class.php, class Message
    Message contains information about a log message.
MODULE_DIR
in file Controller.class.php, constant MODULE_DIR
    Modules reside here.
top

p

$params
in file Validator.class.php, variable Validator::$params
    An associative array of initialization parameters.
$params
in file Filter.class.php, variable Filter::$params
    An associative array of initialization parameters.
PATH_FORMAT
in file Controller.class.php, constant PATH_FORMAT
    Format URL's in a search engine friendly style.
top

r

$result
in file Renderer.class.php, variable Renderer::$result
    The result of a render when render mode is RENDER_VAR.
redirect
in file Controller.class.php, method Controller::redirect()
    Redirect the request to another location.
register
in file ActionChain.class.php, method ActionChain::register()
    Register an action with the chain.
register
in file FilterChain.class.php, method FilterChain::register()
    Register a filter.
register
in file ValidatorManager.class.php, method ValidatorManager::register()
    Register a validator.
registerFilters
in file FilterList.class.php, method FilterList::registerFilters()
    Register filters.
registerValidators
in file Action.class.php, method Action::registerValidators()
    Register individual parameter validators.
removeAppender
in file Logger.class.php, method Logger::removeAppender()
    Remove an appender.
removeAttribute
in file Renderer.class.php, method Renderer::removeAttribute()
    Remove an attribute.
removeAttribute
in file User.class.php, method User::removeAttribute()
    Remove an attribute.
removeAttribute
in file Request.class.php, method Request::removeAttribute()
    Remove an attribute.
removeAttributes
in file User.class.php, method User::removeAttributes()
    Remove an attribute namespace and all associated attributes.
removeLogger
in file LogManager.class.php, method LogManager::removeLogger()
    Remove a logger.
removeParameter
in file Request.class.php, method Request::removeParameter()
    Remove a parameter.
Renderer
in file Renderer.class.php, class Renderer
    Renderer renders a PHP template file.
Renderer
in file Renderer.class.php, method Renderer::Renderer()
    Create a new Renderer instance.
Renderer.class.php
procedural page Renderer.class.php
RENDERER_DIR
in file Controller.class.php, constant RENDERER_DIR
    Custom renderers reside here.
RENDER_CLIENT
in file Renderer.class.php, constant RENDER_CLIENT
    Render the view to the client.
RENDER_VAR
in file Renderer.class.php, constant RENDER_VAR
    Render the view to a variable.
Request
in file Request.class.php, class Request
    Request encapsulates a request into a class, which provides easy-to-manage methods for directly accessing request information.
Request
in file Request.class.php, method Request::Request()
    Create a new Request instance.
Request.class.php
procedural page Request.class.php
REQ_GET
in file Request.class.php, constant REQ_GET
    Validate and execute only on GET requests.
REQ_NONE
in file Request.class.php, constant REQ_NONE
    Do not validate or execute the action on any request method.
REQ_POST
in file Request.class.php, constant REQ_POST
    Validate and execute only on POST requests.
top

s

SESSION_DIR
in file Controller.class.php, constant SESSION_DIR
    Custom session handlers reside here.
setArray
in file Renderer.class.php, method Renderer::setArray()
    Set multiple attributes by using an associative array.
setArrayByRef
in file Renderer.class.php, method Renderer::setArrayByRef()
    Set multiple attributes by using a reference to an associative array.
setAttribute
in file User.class.php, method User::setAttribute()
    Set an attribute.
setAttribute
in file Renderer.class.php, method Renderer::setAttribute()
    Set an attribute.
setAttribute
in file Request.class.php, method Request::setAttribute()
    Set an attribute.
setAttributeByRef
in file User.class.php, method User::setAttributeByRef()
    Set an attribute by reference.
setAttributeByRef
in file Request.class.php, method Request::setAttributeByRef()
    Set an attribute by reference.
setAttributeByRef
in file Renderer.class.php, method Renderer::setAttributeByRef()
    Set an attribute by reference.
setAuthenticated
in file User.class.php, method User::setAuthenticated()
    Set the authenticated status of the user.
setAuthorizationHandler
in file Controller.class.php, method Controller::setAuthorizationHandler()
    Set the developer supplied authorization handler.
setContainer
in file User.class.php, method User::setContainer()
    Set the container.
setContentType
in file Controller.class.php, method Controller::setContentType()
    Set the content type.
setError
in file Request.class.php, method Request::setError()
    Set an error message.
setErrorMessage
in file Validator.class.php, method Validator::setErrorMessage()
    Set the default error message for any occuring error.
setErrors
in file Request.class.php, method Request::setErrors()
    Set multiple error messages.
setExitPriority
in file Logger.class.php, method Logger::setExitPriority()
    Set the priority level that must be met or exceeded in order for Mojavi to exit upon the logging of a message.
setLayout
in file Appender.class.php, method Appender::setLayout()
    Set the layout this appender will use.
setMethod
in file Request.class.php, method Request::setMethod()
    Set the request method.
setMode
in file Renderer.class.php, method Renderer::setMode()
    Set the render mode, which is one of the following:
setParameter
in file Request.class.php, method Request::setParameter()
    Manually set a parameter.
setParameter
in file Message.class.php, method Message::setParameter()
    Set a parameter.
setParameter
in file Validator.class.php, method Validator::setParameter()
    Set a validator parameter.
setParameterByRef
in file Request.class.php, method Request::setParameterByRef()
    Manually set a parameter by reference.
setParameterByRef
in file Message.class.php, method Message::setParameterByRef()
    Set a parameter by reference.
setParameterByRef
in file Validator.class.php, method Validator::setParameterByRef()
    Set a validator parameter by reference.
setPreserve
in file ActionChain.class.php, method ActionChain::setPreserve()
    Set the parameter preservation status.
setPriority
in file Logger.class.php, method Logger::setPriority()
    Set the priority level that must be met or exceeded in order for this logger to log a message.
setRenderMode
in file Controller.class.php, method Controller::setRenderMode()
    Set the global render mode.
setRequired
in file ValidatorManager.class.php, method ValidatorManager::setRequired()
    Set the required status of a parameter.
setSessionHandler
in file Controller.class.php, method Controller::setSessionHandler()
    Set the session handler.
setTemplate
in file Renderer.class.php, method Renderer::setTemplate()
    Set the template.
setTemplateDir
in file Renderer.class.php, method Renderer::setTemplateDir()
    Set the template directory.
setUser
in file Controller.class.php, method Controller::setUser()
    Set the user type.
SQL_DIR
in file Controller.class.php, constant SQL_DIR
    SQL utilities reside here.
store
in file User.class.php, method User::store()
    Store data in the container.
top

t

$template
in file Renderer.class.php, variable Renderer::$template
    A relative or absolute file-system path to a template.
templateExists
in file Renderer.class.php, method Renderer::templateExists()
    Determine if a template exists.
TEMPLATE_DIR
in file Controller.class.php, constant TEMPLATE_DIR
    Globally available templates reside here.
top

u

User
in file User.class.php, method User::User()
    Create a new User instance.
User
in file User.class.php, class User
    User provides a clean interface to a single user, which allows for easy manipulation of attributes and security related data.
User.class.php
procedural page User.class.php
USER_DIR
in file Controller.class.php, constant USER_DIR
    Custom user persistence and security resides here.
UTIL_DIR
in file Controller.class.php, constant UTIL_DIR
    Utility classes reside here.
top

v

validate
in file Action.class.php, method Action::validate()
    Validate the request as a whole.
Validator
in file Validator.class.php, class Validator
    Validator is a guaranteed way to make sure user submitted parameters are valid. Validator can also modify values, providing a parameter filter system.
Validator
in file Validator.class.php, method Validator::Validator()
    Create a new Validator instance.
ValidatorManager
in file ValidatorManager.class.php, class ValidatorManager
    ValidatorManager automates the parameter validation process.
ValidatorManager
in file ValidatorManager.class.php, method ValidatorManager::ValidatorManager()
    Create a new ValidatorManager instance.
ValidatorManager.class.php
procedural page ValidatorManager.class.php
Validator.class.php
procedural page Validator.class.php
VALIDATOR_DIR
in file Controller.class.php, constant VALIDATOR_DIR
    Custom validators reside here.
View
in file View.class.php, class View
    View represents a presentation layer for an action.
View
in file View.class.php, method View::View()
    Create a new View instance.
viewExists
in file Controller.class.php, method Controller::viewExists()
    Determine if a view exists.
VIEW_ALERT
in file View.class.php, constant VIEW_ALERT
    Render an alert view.
View.class.php
procedural page View.class.php
VIEW_ERROR
in file View.class.php, constant VIEW_ERROR
    Render an error view.
VIEW_INDEX
in file View.class.php, constant VIEW_INDEX
    Render an index view.
VIEW_INPUT
in file View.class.php, constant VIEW_INPUT
    Render an input view.
VIEW_NONE
in file View.class.php, constant VIEW_NONE
    Do not render a view.
VIEW_SUCCESS
in file View.class.php, constant VIEW_SUCCESS
    Render a success view.
top

w

write
in file Appender.class.php, method Appender::write()
    Write to this appender.
top

Documentation generated on Wed, 15 Jun 2005 11:43:13 +0900 by phpDocumentor 1.2.3