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
MachII_plugins_PearBenchmarkTimerPlugin Mach-II plugin for profiling using PEAR Benchmark
Method Summary
MachII_framework_Plugin MachII_framework_Plugin (MachII_framework_AppManager &$appManager, [array $parameters = array()])
void abortEvent ([string $message = ''])
void configure ()
mixed getParameter (string $name, [mixed $defaultValue = null])
array getParameters ()
void postEvent (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)
void setParameter (string $name, mixed $value)
void setParameters (array $parameters)
Variables
Methods
Constructor MachII_framework_Plugin (line 17)
MachII_framework_Plugin MachII_framework_Plugin (MachII_framework_AppManager &$appManager, [array $parameters = array()])
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:
getParameter (line 69)
mixed getParameter (string $name, [mixed $defaultValue = null])
  • string $name
  • mixed $defaultValue

Redefinition of:
MachII_framework_BaseObject::getParameter()
Gets a configuration parameter value, or a default value if not defined.
getParameters (line 88)
  • return: associative array of plugin parrameters.
array getParameters ()

Redefinition of:
MachII_framework_BaseObject::getParameters()
Gets the full set of configuration parameters for the component.
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 131)

Executes after each event.

Override to provide custom functionality.

void postEvent (MachII_framework_EventContext &$eventContext)

Redefined in descendants as:
postProcess (line 155)

Executes once after processing events.

Override to provide custom functionality.

void postProcess (MachII_framework_EventContext &$eventContext)

Redefined in descendants as:
postView (line 147)

Executes after each view.

Override to provide custom functionality.

void postView (MachII_framework_EventContext &$eventContext)

Redefined in descendants as:
preEvent (line 123)

Executes before each event.

void preEvent (MachII_framework_EventContext &$eventContext)

Redefined in descendants as:
preProcess (line 117)

Executes once before processing events.

Override to provide custom functionality.

void preProcess (MachII_framework_EventContext &$eventContext)

Redefined in descendants as:
preView (line 139)

Executes before each view.

Override to provide custom functionality.

void preView (MachII_framework_EventContext &$eventContext)

Redefined in descendants as:
setParameter (line 59)
void setParameter (string $name, mixed $value)
  • string $name
  • mixed $value

Redefinition of:
MachII_framework_BaseObject::setParameter()
Sets a configuration parameter.
setParameters (line 80)
void setParameters (array $parameters)
  • array $parameters: associative array of plugin parrameters will be merged with any existing parameters.

Redefinition of:
MachII_framework_BaseObject::setParameters()
Sets the full set of configuration parameters for the component.
_getAppManager (line 106)
  • access: protected
MachII_framework_AppManager &_getAppManager ()
_setAppManager (line 97)
  • access: private
void _setAppManager (MachII_framework_AppManager $appManager)

Inherited Methods

Inherited From MachII_framework_BaseObject

MachII_framework_BaseObject::MachII_framework_BaseObject()
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:05 -0800 by phpDocumentor 1.3.0RC3