Class MachII_framework_Plugin

Description

Plugin.

Located in /MachII/framework/Plugin.php (line 11)

MachII_framework_BaseObject
   |
   --MachII_framework_Plugin
Direct descendents
Class Description
MachII_plugins_SimplePlugin
Method Summary
MachII_framework_Plugin __construct (MachII_framework_AppManager $appManager, [array $parameters = array()])
void abortEvent ([string $message = ''])
void configure ()
void handleException (MachII_framework_EventContext $eventContext, MachII_util_Exception $exception)
void postEvent (MachII_framework_EventContext $eventContext)
void postProcess (MachII_framework_EventContext $eventContext)
void postView (MachII_framework_EventContext $eventContext)
void preEvent (MachII_framework_EventContext $eventContext)
void preProcess (MachII_framework_EventContext $eventContext)
void preView (MachII_framework_EventContext $eventContext)
Methods
Constructor __construct (line 17)
MachII_framework_Plugin __construct (MachII_framework_AppManager $appManager, [array $parameters = array()])

Redefinition of:
MachII_framework_BaseObject::__construct()
Constructor
abortEvent (line 48)

Aborts event processing

Call this function to abort processing of the current event. When called, a MachII_util AbortEventException exception is thrown, caught, and handled by the framework.

  • throws: MachII_util_AbortEventException
void abortEvent ([string $message = ''])
  • string $message
configure (line 27)

Override to provide custom configuration logic.

Called after constructor.

void configure ()

Redefinition of:
MachII_framework_BaseObject::configure()
Override to provide custom configuration logic.

Redefined in descendants as:
handleException (line 37)

Plugin point called when an exception occurs (before exception event is handled).

Override to provide custom functionality.

void handleException (MachII_framework_EventContext $eventContext, MachII_util_Exception $exception)

Redefined in descendants as:
postEvent (line 75)

Executes after each event.

Override to provide custom functionality.

void postEvent (MachII_framework_EventContext $eventContext)

Redefined in descendants as:
postProcess (line 99)

Executes once after processing events.

Override to provide custom functionality.

void postProcess (MachII_framework_EventContext $eventContext)

Redefined in descendants as:
postView (line 91)

Executes after each view.

Override to provide custom functionality.

void postView (MachII_framework_EventContext $eventContext)

Redefined in descendants as:
preEvent (line 67)

Executes before each event.

Override to provide custom functionality.

void preEvent (MachII_framework_EventContext $eventContext)

Redefined in descendants as:
preProcess (line 59)

Executes once before processing events.

Override to provide custom functionality.

void preProcess (MachII_framework_EventContext $eventContext)

Redefined in descendants as:
preView (line 83)

Executes before each view.

Override to provide custom functionality.

void preView (MachII_framework_EventContext $eventContext)

Redefined in descendants as:

Inherited Methods

Inherited From MachII_framework_BaseObject

MachII_framework_BaseObject::__construct()
MachII_framework_BaseObject::announceEvent()
MachII_framework_BaseObject::configure()
MachII_framework_BaseObject::getAppManager()
MachII_framework_BaseObject::getParameter()
MachII_framework_BaseObject::getParameters()
MachII_framework_BaseObject::getProperty()
MachII_framework_BaseObject::hasParameter()
MachII_framework_BaseObject::isParameterDefined()
MachII_framework_BaseObject::setAppManager()
MachII_framework_BaseObject::setParameter()
MachII_framework_BaseObject::setParameters()
MachII_framework_BaseObject::setProperty()

Documentation generated on Thu, 20 Jan 2005 10:47:36 -0800 by phpDocumentor 1.3.0RC3