Full index

Package indexes


a b c d e f g h i l m n o p q r s t v _
a
top
abortEvent
Aborts event processing
addCommand
Adds an event command to the event's command queue.
addFilter
addListener
addPath
Store the path.
addPlugin
announceEvent
Announce an Event
announceEvent
Announces a new event to the framework.
apiVersion
MachII::apiVersion() in MachII.php
Application programming interface version number
appLoader
MachII::appLoader() in MachII.php
Factory for creating a configured application loader.
AppFactory.php
AppFactory.php in AppFactory.php
AppLoader.php
AppLoader.php in AppLoader.php
AppManager.php
AppManager.php in AppManager.php
AnnounceCommand.php
AnnounceCommand.php in AnnounceCommand.php
b
top
BaseObject.php
BaseObject.php in BaseObject.php
BeanUtil.php
BeanUtil.php in BeanUtil.php
c
top
cache
MachII::cache() in MachII.php
Factory for creating a caching application loader.
clear
Unsets the array for the named application's session variable.
clear
clear
Clears the queue.
clear
Remove all items in application cache.
clearEventMappings
clearEventQueue
Clears the event queue.
configure
configure
Configure all of the listeners.
configure
configure
configure
Configure all of the plugins.
configure
Configure all of the filters
configure
Override to provide custom configuration logic.
configure
configure
Configure the property manager.
configure
configure
configure
Override to provide custom configuration logic.
configure
configure
Configure the component managers
createAppManager
Create an instance of the main application manager
createBean
Creates a bean.
createCache
Initialize the cache container.
createCache
Start a session.
createCache
Instantiate a new Cache_Lite object.
createEvent
createEventContext
createException
createRequestHandler
Cache.php
Cache.php in Cache.php
ClassLoader.php
ClassLoader.php in ClassLoader.php
d
top
describeBean
Returns an associative array of bean properties/values based on getters.
displayView
displayView
Display an event's views
e
top
execute
execute
execute
execute
execute
execute
execute
execute
executePluginPoint
EventArgsFilter.php
EventArgsFilter.php in EventArgsFilter.php
EventBeanFilter.php
EventBeanFilter.php in EventBeanFilter.php
EventArgCommand.php
EventArgCommand.php in EventArgCommand.php
EventBeanCommand.php
EventBeanCommand.php in EventBeanCommand.php
EventMappingCommand.php
EventMappingCommand.php in EventMappingCommand.php
EventCommand.php
EventCommand.php in EventCommand.php
EventContext.php
EventContext.php in EventContext.php
EventFilter.php
EventFilter.php in EventFilter.php
EventHandler.php
EventHandler.php in EventHandler.php
EventManager.php
EventManager.php in EventManager.php
Event.php
Event.php in Event.php
en.php
en.php in en.php
Exception.php
Exception.php in Exception.php
f
top
filterEvent
filterEvent
filterEvent
Override to provide event filtering logic.
filterEvent
filterEvent
FilterCommand.php
FilterCommand.php in FilterCommand.php
FilterManager.php
FilterManager.php in FilterManager.php
g
top
get
get
Retrieve a variable.
get
Dequeues and returns the next item in the queue.
get
Unserialize objects and return the variable from the session.
getAccess
getAppFactory
getAppManager
Application manager
getAppManager
getAppManager
getAppManager
getAppManager
getAppManager
getAppManager
getAppManager
getAppManager
getAppManager
getAppName
getArg
getArgs
getArgType
getBeanField
Returns the value of a field.
getCache
getClassName
Translate a dot notation classname to PEAR-style with underscores.
getConfigPath
getContext
getCurrentEvent
getDetail
Detail of the exception.
getErrorCode
The exception's error code.
getEventCount
Returns the number of events that have been processed for this context.
getEventHandler
getEventManager
getEventMapping
getExceptionEventName
getExtendedInfo
String representation of the backtrace.
getFilter
getFilterManager
getInvoker
getLastReloadDate
getListener
getListenerManager
getMaxEvents
getMaxSize
Returns the maximum size of the queue.
getName
getNextEvent
Peeks at the next event in the queue.
getOption
getOptions
getParameter
Gets a configuration parameter value, or a default value if not defined.
getParameter
getParameters
Gets the full set of configuration parameters for the component.
getPlugin
getPluginManager
getPreviousEvent
Returns the previous handled event.
getProperties
getProperty
Gets the specified property.
getProperty
getProperty
Gets the specified property.
getPropertyManager
getRequestHandler
getSize
Returns the size of the queue (number of elements).
getType
The exception class name.
getUserPermissions
getViewManager
getViewPath
getWebRoot
Attempt to discover the document root.
h
top
handleEvent
Executes the event's commands.
handleEventRequest
Handles the incoming event request.
handleException
Execute the registered exception event
handleException
Executes handleException() for each registered plugin.
handleException
Plugin point called when an exception occurs (before exception event is handled).
handleException
handleRequest
Entry point for handling an incoming request.
hasCurrentEvent
hasMoreEvents
Returns whether there is another event in the queue.
hasNextEvent
Returns whether there is another event in the queue.
hasParameter
Checks to see whether or not a configuration parameter is defined.
hasPreviousEvent
Returns whether or not getPreviousEvent() can be called to return an event.
hasProperty
i
top
invokeListener
invokeListener
invokeListener
isArgDefined
isBeanFieldsDefined
isEmpty
Returns whether or not the queue is empty.
isEventDefined
isEventPublic
isFilterDefined
isFull
Returns whether or not the queue is full.
isListenerDefined
isParameterDefined
Checks to see whether or not a configuration parameter is defined.
isViewPathDefined
index.php
index.php in index.php
l
top
load
Load a class file.
ListenerInvoker.php
ListenerInvoker.php in ListenerInvoker.php
ListenerManager.php
ListenerManager.php in ListenerManager.php
Listener.php
Listener.php in Listener.php
m
top
MachII
MachII in MachII.php
MachII provides a convenient interface to lower-level framework classes as well as some globally useful functions.
mach-ii.php
mach-ii.php in mach-ii.php
MachII.php
MachII.php in MachII.php
MachII_cache_PearCacheLite
MachII_cache_PearCacheLite in PearCacheLite.php
Mach-II cache facade for the file-based PEAR Cache_Lite.
MachII_cache_PhpSession
MachII_cache_PhpSession in PhpSession.php
A simple cache container that stores to PHP's native session variables.
MACHII_CONFIG_RELOAD_ALWAYS
Always Reload
MACHII_CONFIG_RELOAD_DYNAMIC
Dynamic Reload
MACHII_CONFIG_RELOAD_NEVER
Never Reload
MACHII_ERROR
MACHII_ERROR in Exception.php
Error Codes
MACHII_ERROR_ABORT_EVENT
MACHII_ERROR_ABORT_EVENT in Exception.php
Error Codes
MACHII_ERROR_ABORT_EVENT_EXCEPTION
Error Codes
MACHII_ERROR_CACHE_INIT
MACHII_ERROR_CACHE_INIT in Exception.php
Error Codes
MACHII_ERROR_CUSTOM
MACHII_ERROR_CUSTOM in Exception.php
Error Codes
MACHII_ERROR_EVENT_CONTEXT_NOT_SET
Error Codes
MACHII_ERROR_EVENT_FILTER
MACHII_ERROR_EVENT_FILTER in Exception.php
Error Codes
MACHII_ERROR_EVENT_FILTER_NOT_DEFINED
Error Codes
MACHII_ERROR_EVENT_HANDLER_NOT_DEFINED
Error Codes
MACHII_ERROR_EVENT_IS_PRIVATE
Error Codes
MACHII_ERROR_IS_PROCESSING_EVENTS
Error Codes
MACHII_ERROR_LISTENER_INVOKER_ARG_COUNT_MISMATCH
Error Codes
MACHII_ERROR_LISTENER_INVOKER_DISPATCH_MAP_NOT_DEFINED
Error Codes
MACHII_ERROR_LISTENER_NOT_DEFINED
Error Codes
MACHII_ERROR_MAX_EVENTS_EXCEEDED
Error Codes
MACHII_ERROR_PLUGIN
MACHII_ERROR_PLUGIN in Exception.php
Error Codes
MACHII_ERROR_VIEW_NOT_DEFINED
Error Codes
MACHII_EVENT_ACCESS_PRIVATE
MACHII_EVENT_ACCESS_PRIVATE in EventManager.php
Flag as an internal event, one that can only be called by Mach-II.
MACHII_EVENT_ACCESS_PUBLIC
MACHII_EVENT_ACCESS_PUBLIC in EventManager.php
Flag as a public event, one that may be called by a user.
MachII_filters_EventArgsFilter
MachII_filters_EventArgsFilter in EventArgsFilter.php
EventFilter class.
MachII_filters_EventBeanFilter
MachII_filters_EventBeanFilter in EventBeanFilter.php
EventFilter class.
MachII_filters_PermissionsFilter
MachII_filters_PermissionsFilter in PermissionsFilter.php
EventFilter class.
MachII_filters_RequiredFieldsFilter
MachII_filters_RequiredFieldsFilter in RequiredFieldsFilter.php
EventFilter class.
MachII_framework_AppFactory
MachII_framework_AppFactory in AppFactory.php
Factory class for creating instances of AppManager.
MachII_framework_AppLoader
Responsible for controlling loading/reloading of the AppManager.
MachII_framework_AppManager
MachII_framework_AppManager in AppManager.php
The main framework manager.
MachII_framework_BaseObject
MachII_framework_BaseObject in BaseObject.php
Mach-II Base Object
MachII_framework_Cache
Simple Cache Facade
MachII_framework_commands_AnnounceCommand
An EventCommand for announcing an event.
MachII_framework_commands_EventArgCommand
An EventCommand for putting an event arg into the current event.
MachII_framework_commands_EventBeanCommand
An EventCommand for creating and populating a bean in the current event.
MachII_framework_commands_EventMappingCommand
An EventCommand for setting up an event mapping for an event handler.
MachII_framework_commands_FilterCommand
An EventCommand for filtering events.
MachII_framework_commands_NotifyCommand
An EventCommand for processing an EventFilter.
MachII_framework_commands_ViewPageCommand
An EventCommand for processing an EventFilter.
MachII_framework_Event
Mach-II Event
MachII_framework_EventCommand
MachII_framework_EventCommand in EventCommand.php
EventCommand class.
MachII_framework_EventContext
MachII_framework_EventContext in EventContext.php
Controls the event queue and event processing mechanism for a request/event lifecycle.
MachII_framework_EventFilter
MachII_framework_EventFilter in EventFilter.php
EventFilter class.
MachII_framework_EventHandler
MachII_framework_EventHandler in EventHandler.php
Handles processing of EventCommands for an Event.
MachII_framework_EventManager
MachII_framework_EventManager in EventManager.php
Manages registered EventHandlers for the framework.
MachII_framework_FilterManager
MachII_framework_FilterManager in FilterManager.php
Manages registered MachII_framework_EventFilters.
MachII_framework_invokers_ObjectEvent
A MachII_framework_Invoker for calling a MachII_framework_Listener.
MachII_framework_invokers_ObjectEventArgs
A MachII_framework_Invoker for calling a MachII_framework_Listener.
MachII_framework_Listener
Listener.
MachII_framework_ListenerInvoker
MachII_framework_ListenerInvoker in ListenerInvoker.php
Listener invoker
MachII_framework_ListenerManager
MachII_framework_ListenerManager in ListenerManager.php
Manages registered listeners.
MachII_framework_Plugin
Plugin.
MachII_framework_PluginManager
MachII_framework_PluginManager in PluginManager.php
Manages registered plugins.
MachII_framework_PropertyManager
MachII_framework_PropertyManager in PropertyManager.php
Manages defined properties.
MachII_framework_RequestHandler
MachII_framework_RequestHandler in RequestHandler.php
Handles request to event conversion.
MachII_framework_ViewContext
MachII_framework_ViewContext in ViewContext.php
Handles view display for a MachII_framework_EventContext.
MachII_framework_ViewManager
MachII_framework_ViewManager in ViewManager.php
Manages registered views.
MachII_plugins_SimplePlugin
MachII_plugins_SimplePlugin in SimplePlugin.php
MachII_util_AbortEventException
MachII_util_BeanUtil
MachII_util_BeanUtil in BeanUtil.php
A utility class for working with bean components.
MachII_util_CacheException
MachII_util_CacheInitException
MachII_util_ClassLoader
MachII_util_ClassLoader in ClassLoader.php
Used for loading other classes.
MachII_util_EventContextNotSetException
MachII_util_EventException
MachII_util_EventFilterException
MachII_util_EventFilterNotDefinedException
MachII_util_EventHandlerNotDefinedException
MachII_util_EventIsPrivateException
MachII_util_Exception
MachII_util_Exception in Exception.php
Mach-II Exception
MachII_util_IsProcessingEventsException
MachII_util_ListenerException
MachII_util_ListenerInvokerArgCountMismatchException
MachII_util_ListenerInvokerDispatchMapNotDefinedException
MachII_util_ListenerInvokerException
MachII_util_ListenerNotDefinedException
MachII_util_MaxEventsExceededException
MachII_util_PluginException
MachII_util_Queue
MachII_util_Queue in Queue.php
MachII_util_SizedQueue
MachII_util_SizedQueue in SizedQueue.php
A specialization of Queue to limit size.
MachII_util_ViewException
MachII_util_ViewException in Exception.php
MachII_util_ViewNotDefinedException
makePath
Determine the absolute path of a classfile.
n
top
NotifyCommand.php
NotifyCommand.php in NotifyCommand.php
o
top
ObjectEventArgs.php
ObjectEventArgs.php in ObjectEventArgs.php
ObjectEvent.php
ObjectEvent.php in ObjectEvent.php
p
top
PearCacheLite.php
PearCacheLite.php in PearCacheLite.php
PhpSession.php
PhpSession.php in PhpSession.php
PermissionsFilter.php
PermissionsFilter.php in PermissionsFilter.php
PluginManager.php
PluginManager.php in PluginManager.php
Plugin.php
Plugin.php in Plugin.php
PropertyManager.php
PropertyManager.php in PropertyManager.php
peek
Peeks the next item in the queue without removing it.
postEvent
postEvent
Executes after each event.
postEvent
postProcess
postProcess
postProcess
Executes once after processing events.
postView
postView
postView
Executes after each view.
preEvent
preEvent
Executes before each event.
preEvent
preProcess
preProcess
Executes once before processing events.
preProcess
preView
preView
preView
Executes before each view.
processEvents
Process Event Queue
put
Queues the item.
put
Queues the item.
q
top
Queue.php
Queue.php in Queue.php
r
top
RequiredFieldsFilter.php
RequiredFieldsFilter.php in RequiredFieldsFilter.php
RequestHandler.php
RequestHandler.php in RequestHandler.php
reloadConfig
Create a new application manager
removeArg
restore
Load an array of class files.
s
top
SimplePlugin.php
SimplePlugin.php in SimplePlugin.php
SizedQueue.php
SizedQueue.php in SizedQueue.php
save
Store a variable.
save
save
Serialize objects and set the session variable.
setAccess
setAppFactory
setAppManager
setAppManager
setAppManager
setAppManager
setAppManager
setAppManager
setAppManager
setAppManager
setAppManager
setAppName
setArg
setArgs
setArgType
setBeanField
Sets the value of a field in a bean.
setBeanFields
Sets the values of fields in a bean.
setCache
setConfigPath
Set the path and filename of the configuration file
setCurrentEvent
setEventManager
setEventMapping
setExceptionEventName
setFilterManager
setInvoker
setLastReloadDate
setListenerManager
setMaxEvents
setMaxSize
Sets the maximum size of the queue.
setName
setOption
setOptions
setParameter
Sets a configuration parameter.
setParameter
setParameters
Sets the full set of configuration parameters for the component.
setParameters
setPluginManager
setProperty
Sets the specified property.
setProperty
Sets the specified property.
setProperty
setPropertyManager
setViewManager
shouldReloadConfig
Determine if the configuration file should be reloaded
singleton
The storage container.
t
top
throwUsageException
v
top
ViewPageCommand.php
ViewPageCommand.php in ViewPageCommand.php
ViewContext.php
ViewContext.php in ViewContext.php
ViewManager.php
ViewManager.php in ViewManager.php
validatePermissions
version
MachII::version() in MachII.php
Package version number
_
top
$_appLoader
MachII::$_appLoader in MachII.php
$_cache
MachII::$_cache in MachII.php
_cache
MachII::_cache() in MachII.php
Shutdown method for caching application loader.
_createEventCommand
Creates the appropriate event command from a raw event configuration.
_getAppend
_getAppManager
_getAppManager
_getAppRoot
_getArgName
_getArgValue
_getArgVariable
_getArgVariableValue
_getBeanFields
_getBeanName
_getBeanType
_getBeanUtil
_getBeanUtil
_getContentKey
_getCurrentEventHandler
_getEventName
_getEventName
_getEventName
_getEventQueue
_getFilter
_getFullPath
_getListener
_getMappingName
_getMethod
_getParamArgs
_getRequestEventArgs
Merges global arrays into an associative array according to the configured "parameterPrecedence".
_getRequestEventVariablesOrder
The order that global arrays should be merged into event arguments.
_getResultKey
_getViewContext
_getViewName
_handleEvent
Execute an event.
_handleNextEvent
Execute the next event in the queue
_hasContentKey
_hasResultKey
_incrementEventCount
_isArgValueDefined
_isArgVariableDefined
_isCopyEventArgs
_localizeErrorMessage
Retrieve the rendered error message from an error code and message or from an error object.
_setAppend
_setAppManager
_setAppManager
_setArgName
_setArgValue
_setArgVariable
_setBeanFields
_setBeanName
_setBeanType
_setBeanUtil
_setBeanUtil
_setContentKey
_setCopyEventArgs
_setCurrentEventHandler
_setEventName
_setEventName
_setEventQueue
_setFilter
_setListener
_setMappingName
_setMethod
_setParamArgs
_setPreviousEvent
_setResultKey
_setViewContext
_setViewName
_throwUsageException
_throwUsageException
__construct
MachII::__construct() in MachII.php
Since this is a static class, block instantiation.
__construct
__construct
__construct
__construct
Initializes the queue.
__construct
__construct
__construct
__construct
__construct
Constructor
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
Initalizes the event-context.
__construct
__construct
Constructor
__construct
__construct
Configure the application
__construct
Constructor
__construct
Since this is a static class, block instantiation.
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__construct
Constructor
__construct
__construct
__construct
__construct
__construct
__construct
__construct
__dispatch
a b c d e f g h i l m n o p q r s t v _