Plugin APIG2 - Revision history

Vinny at 03:37, 23 January 2005

2005-01-23T03:37:38Z

Show changes

Vinny: /* The Plugin Interface Class */

2005-01-23T03:33:40Z

‎The Plugin Interface Class

Vinny: /* The Plugin Interface Class */

2005-01-23T03:32:38Z

‎The Plugin Interface Class

Vinny: /* The Plugin Interface Class */

2005-01-23T03:32:00Z

‎The Plugin Interface Class

Vinny: /* Plugin Overview */

2005-01-23T03:30:44Z

‎Plugin Overview

Vinny: /* Events */

2005-01-23T03:29:58Z

‎Events

Vinny: /* Action Manager Class */

2005-01-23T03:27:00Z

‎Action Manager Class

Vinny: /* Event Manager Class */

2005-01-23T03:25:59Z

‎Event Manager Class

Vinny: /* Event Manager Class */

2004-12-17T21:05:37Z

‎Event Manager Class

Vinny: /* The Plugin Interface Class */

2004-12-17T21:03:22Z

‎The Plugin Interface Class

@@ Line 70: / Line 70: @@
+      *
       * @access public
-      * @param  string   name of event that requires action
+      * @param  string   name of action that requires handling
       * @param  mixed    variable type (and existence) dependent on event
       * @return mixed    return type depends on event
       */
-     public function handleAction( $event, $var = '');
+     public function handleAction( $action, $var = '');
      /**

@@ Line 64: / Line 64: @@
      /**
-      * Event handler
+      * Action handler
+      *
       * Executes functionality based on action passed to the function by the

@@ Line 22: / Line 22: @@
+      *
       * Handles the creation of data structures, security setup, and
-      * registers for events.
+      * registers for actions.
+      *
       * @access public
@@ Line 33: / Line 33: @@
+      *
       * Handles the removal of data structures, security setup, and
-      * deregisters events.
+      * deregisters actions.
+      *
       * @access public
@@ Line 44: / Line 44: @@
+      *
       * Handles the update of data structures, security setup, and
-      * alters the registered for events as needed.
+      * alters the registered for actions as needed.
+      *
       * @access public
@@ Line 66: / Line 66: @@
       * Event handler
+      *
-      * Executes actions based on events passed to the function by the
+      * Executes functionality based on action passed to the function by the
       * GL2 kernel.
+      *
@@ Line 74: / Line 74: @@
       * @return mixed    return type depends on event
       */
-     public function handleEvent( $event, $var = '');
+     public function handleAction( $event, $var = '');
      /**

@@ Line 9: / Line 9: @@
 === Plugin Overview ===
-The GL2 plugin architecture will be event based. Each plugin will register to listen for events that are generated by the GL2 kernel and other plugins. The GL2 kernel will act as a router for these events. When an event occurs, the GL2 kernel will call all the plugins that have registered for that event.
+The GL2 plugin architecture will be action based. Each plugin will register to listen for actions that are generated by the GL2 kernel and other plugins. The GL2 kernel will act as a router for these actions. When an action occurs, the GL2 kernel will call all the plugins that have registered for that action.
 == The Plugin Interface Class ==

@@ Line 192: / Line 192: @@
 </pre>
-== Events ==
+== Actions ==
-=== Registering for Events ===
+=== Registering for Actions ===
-When a plugin's install() function is called it is expected to register for all the events it will need to handle. This is accomplished using the function registerListener() of the glEventManager class. Similarly within the uninstall() function, the function unregisterListener() of the glEventManager class should be used to deregister event watches.
+When a plugin's install() function is called it is expected to register for all the actions it will need to handle. This is accomplished using the function registerListener() of the Geeklog_ActionManager class. Similarly within the uninstall() function, the function unregisterListener() of the Geeklog_ActionManager class should be used to deregister event watches.
-A plugin should never register for its own events as this has the potential to create infinite loops (as such the glEventManager class will prevent such registrations). In any case such a feature should not be needed, as a plugin can execute any required tasks when an event is triggered.
+A plugin should never register for its own events as this has the potential to create infinite loops (as such the Geeklog_ActionManager class will prevent such registrations). In any case such a feature should not be needed, as a plugin can execute any required tasks when an event is triggered.
-=== Handling Events ===
+=== Handling Actions ===
-When an event is triggered, either by the GL2 kernel or by a plugin, the handleEvent() function is called on all plugins registered for that event. At that point it is the responsiblitiy of the plugin to do any required processing and to return an appropriate value.
+When an action is triggered, either by the GL2 kernel or by a plugin, the handleAction() function is called on all plugins registered for that event. At that point it is the responsiblitiy of the plugin to do any required processing and to return an appropriate value.
-Each plugin will be responsible for preventing infinite loops caused by handling an event in such a way that the handled event is triggered. Infinite loops can avoided in many cases simply by not triggering any events inside the event handler (if possible).
+Each plugin will be responsible for preventing infinite loops caused by handling an action in such a way that the handled action is triggered. Infinite loops can avoided in many cases simply by not triggering any events inside the event handler (if possible).
-=== Triggering Events ===
+=== Triggering Actions ===
-When a plugin requires input or believes other plugins may benefit from knowing that a given event has occured, the notify() function of the glEventManager class should be called.
+When a plugin requires input or believes other plugins may benefit from knowing that a given action has occured, the notify() function of the Geeklog_ActionManager class should be called.
-=== Event Naming Scheme ===
+=== Action Naming Scheme ===
-Event names should be prefixed with the plugin name. The actual event name should be descriptive and may contain subnames seperated by a period ('.'). The word 'core' cannot be used as the plugin name as it is resevered for events triggered by the GL2 kernel.
+Action names should be prefixed with the plugin name. The actual action name should be descriptive and may contain subnames seperated by a period ('.'). The word 'core' cannot be used as the plugin name as it is resevered for actions triggered by the GL2 kernel.
 Some example event names:

@@ Line 105: / Line 105: @@
      /**
-     * PluginEventHandler Constructor
+     * Geeklog_ActionManager Constructor
+     *
      * @author Vincent Furia <vfuria@gmail.com>

@@ Line 91: / Line 91: @@
 </pre>
-== Event Manager Class ==
+== Action Manager Class ==
 An instance of the class described below will be created globally by the GL2 core.  It will be available to all plugins and is responsible for handling plugin event registration and notification.
 <pre>
-class Geeklog_EventManager {
+class Geeklog_ActionManager {
      /**
      * Array containing event keys and listener (arrays as) values

@@ Line 16: / Line 16: @@
 <pre>
-class glPluginInterface {
+class Geeklog_PluginInterface {
      /**