Geodesic Solutions Community Wiki

User Tools

Site Tools

You are here: Auction and Classified Software Support Home » Developers » Addons » Core Events
developers:addons:core_events

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
developers:addons:core_events [2009/01/05 21:16]
jonyo 		developers:addons:core_events [2014/09/25 16:55] (current)
Line 2: Line 2:
  
 A core event is a way for an addon to interact with the base software to change or add something, without needing to make any changes to the base code at all. A core event is a way for an addon to interact with the base software to change or add something, without needing to make any changes to the base code at all.
 +
 +Note that core events are synonymous with //software hooks// with respect to the Geo software((All Core Events are software hooks, but not all software hooks are core events.  8-O)), and we will use the terms "//core event//" and "//software hook//" interchangeably.
  
 ===== How it Works ===== ===== How it Works =====
  
-Core events use [[http://www.google.com/search?q=observer+design+pattern|observer design pattern]], also known as [[http://www.google.com/search?hl=en&q=publisher+subscriber+design+pattern|publisher/subscriber design pattern]].  The "observer" is be the **geoAddon** class, and the "subscriber" is each individual addon.+Core events use [[http://www.google.com/search?q=observer+design+pattern|observer design pattern]], also known as [[http://www.google.com/search?hl=en&q=publisher+subscriber+design+pattern|publisher/subscriber design pattern]].  The "observer" is the **geoAddon** class, and the "subscriber" is each individual addon.
  
-An addon will be **automatically subscribed** to a core event, if 2 things happen:+An addon will be **automatically subscribed** to a core event, if 3 things happen:
   * in **info.php**, the core event's name is found in the addon's **$core_events** var.   * in **info.php**, the core event's name is found in the addon's **$core_events** var.
-  * in the util.php file, the addon's util class has a matching method that is named the same as the core event name, prepended with "core_"((This is to keep things nice and tidy in the util class, so that it is clear which functions are called by the addon system as core events, and which are utility functioned called from somewhere in the addon itself.)).+  * in the util.php file, the addon's util class has a matching method that is named the same as the core event name, prepended with "core_"((This is to keep things nice and tidy in the util class, so that it is clear which functions are called by the addon system as core events, and which are utility functions called from somewhere in the addon itself.)). 
 +  * in the admin panel, at [[admin_menu/addons/manage_addons/start|Addons > Manage Addons]], the addon is installed and enabled.
  
 In the base code, to //trigger a core event//, it will look something like this: In the base code, to //trigger a core event//, it will look something like this:
Line 18: Line 21:
  
 **Breaking that call down:** **Breaking that call down:**
-  * trigger**Display**: triggerDisplay means that what the addon returns is important.  There is a sister function, **geoAddon::triggerUpdate()** which does not care what is returned, when that is used it is for //notification purposes only//, anything returned by the addon is ignored((although the addon can still affect things, for instance an addon might manipulate the template vars stored in the geoView class)).+  * trigger**Display**: triggerDisplay means that what the addon returns is important.  There is a sister function, **geoAddon::triggerUpdate()** which does not care what is returned.  When triggerUpdate is used it is for //notification purposes only//, anything returned by the addon is ignored.  When triggerUpdate is used, the addon can still affect things, for instance an addon might manipulate the template vars stored in the geoView class.
  
   * **event_name**:  This is the event name.  If the event is for a specific thing, it may start with the class name and function name it is being called from, to make it easier to identify where the event is used.   * **event_name**:  This is the event name.  If the event is for a specific thing, it may start with the class name and function name it is being called from, to make it easier to identify where the event is used.
Line 35: Line 38:
 | Notification  | N/A ((No class constant is passed during trigger, because this is the one and only type of core event that is triggered using geoAddon::triggerUpdate() which does not have a variable for event type.)) | notify_ | This is a notification to let the addon know that something is happening, so that the addon can do something it may need to do at that time.  This type is used when an addon might want to manipulate something more complex than a simple string.  For instance the event //notify_display_page//, happens at the top of geoSite->display_page() in order to allow an addon to manipulate the view class template vars, or to manipulate the geoSite class's variables.  It may also be used when it is desirable to do some type of logging.  | | Notification  | N/A ((No class constant is passed during trigger, because this is the one and only type of core event that is triggered using geoAddon::triggerUpdate() which does not have a variable for event type.)) | notify_ | This is a notification to let the addon know that something is happening, so that the addon can do something it may need to do at that time.  This type is used when an addon might want to manipulate something more complex than a simple string.  For instance the event //notify_display_page//, happens at the top of geoSite->display_page() in order to allow an addon to manipulate the view class template vars, or to manipulate the geoSite class's variables.  It may also be used when it is desirable to do some type of logging.  |
 | Filter  | geoAddon::FILTER | filter_ | A string is passed to the addon as the only variable.  The addon is expected to filter/manipulate the string, then return the filtered string (or return the string un-modified if the addon doesn't want to change it).  | | Filter  | geoAddon::FILTER | filter_ | A string is passed to the addon as the only variable.  The addon is expected to filter/manipulate the string, then return the filtered string (or return the string un-modified if the addon doesn't want to change it).  |
-| Overload  | geoAddon::OVERLOAD | overload_ then the class and method name being overloaded | This allows an addon to take over a specific function and do things its own way.  A overload event allows you to replace a function with your own, where a filter event would happen at the end of a function and allow you to modify what the function is about to return.  If the addon returns the constant geoAddon::NO_FILTER then the calling function keeps going on its merry way.  Otherwise, if anything else is returned, then the calling function will return that value, effectively skipping what would normally be done by that function.  The addon is responsible for returning the same stuff the original function would return, and for doing any input checking that might be needed, in other words it is responsible for doing everything the original function would have done.   |+| Overload  | geoAddon::OVERLOAD | overload_ then the class and method name being overloaded | This allows an addon to take over a specific function and do things its own way.  An overload event allows you to replace a function with your own, where a filter event would happen at the end of a function and allow you to modify what the function is about to return.  If the addon returns the constant geoAddon::NO_OVERLOAD then the calling function keeps going on its merry way.  Otherwise, if anything else is returned, then the calling function will return that value, effectively skipping what would normally be done by that function.  The addon is responsible for returning the same stuff the original function would return, and for doing any input checking that might be needed, in other words it is responsible for doing everything the original function would have done.   |
 | Return a String  | geoAddon::RETURN_STRING or geoAddon::ARRAY_STRING | it varies | Addon is expected to return a string (that will usually be used to display on the page).  In the case of geoAddon::RETURN_STRING: The results of each addon will be concatenated together, sometimes separated by some string that is passed as the optional 4th parameter to triggerDisplay().  In the case of geoAddon::ARRAY_STRING: the results of each addon are returned in an array, one array entry per addon.  | | Return a String  | geoAddon::RETURN_STRING or geoAddon::ARRAY_STRING | it varies | Addon is expected to return a string (that will usually be used to display on the page).  In the case of geoAddon::RETURN_STRING: The results of each addon will be concatenated together, sometimes separated by some string that is passed as the optional 4th parameter to triggerDisplay().  In the case of geoAddon::ARRAY_STRING: the results of each addon are returned in an array, one array entry per addon.  |
 | Return an Array  | geoAddon::ARRAY_ARRAY | it varies | The addon is expected to return an array, if it returns anything other than an array, the returned value is ignored.  | | Return an Array  | geoAddon::ARRAY_ARRAY | it varies | The addon is expected to return an array, if it returns anything other than an array, the returned value is ignored.  |
Line 53: Line 56:
  
 A lot of the filter events are used to filter the results of a particular function, in those cases the name of the event is usually **filter_[CLASS NAME]_[FUNCTION NAME]**. A lot of the filter events are used to filter the results of a particular function, in those cases the name of the event is usually **filter_[CLASS NAME]_[FUNCTION NAME]**.
 +
 +There is a special case where what is being filtered is another data type (like an array), this special case behavior was added in 4.1.0.  The majority of filter type core events are filtering a string.
  
 ==== overload ==== ==== overload ====
Line 78: Line 83:
 These core events are to deal with the user session or session data.  In all events so far, it is done in addition to, not instead of, the built in stuff.  It works kind of like a filter, except that the return values are ignored.  It is passed the session info, and that is it.  Events will be prepended with **session_**. These core events are to deal with the user session or session data.  In all events so far, it is done in addition to, not instead of, the built in stuff.  It works kind of like a filter, except that the return values are ignored.  It is passed the session info, and that is it.  Events will be prepended with **session_**.
  
-These are what the Bridge addon uses to do it's thing for syncing up login/logout with other installations.+These are what the Bridge addon uses to do its thing for syncing up login/logout with other installations.
  
 ==== user ==== ==== user ====
Line 88: Line 93:
 ==== errorhandle ==== ==== errorhandle ====
  
-This is a special case, this is the name of a core event that is it's own category.  It is triggered every time an error is triggered in the system (even notifications).+This is a special case, this is the name of a core event that is its own category.  It is triggered every time an error is triggered in the system (even notifications).
  
 In the software, we use trigger_error() as a debugging message tool, the message syntax will match: In the software, we use trigger_error() as a debugging message tool, the message syntax will match:
Line 100: Line 105:
 ==== app_bottom ==== ==== app_bottom ====
  
-This is another core event that is it's own category.  "Bottom" in this case, refers to the end of the page load, where the script is wrapping things up, not the physical location somewhere on a page.  This core event is used to allow you to do things right before the page is done, but after the page is already displayed.  In other words: It's closing time, you don't have to go home but you can't stay here.+This is another core event that is its own category.  "Bottom" in this case, refers to the end of the page load, where the script is wrapping things up, not the physical location somewhere on a page.  This core event is used to allow you to do things right before the page is done, but after the page is already displayed.  In other words: It's closing time, you don't have to go home but you can't stay here.
  
developers/addons/core_events.1231190216.txt.gz · Last modified: 2014/09/25 16:55 (external edit)

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
CC Attribution-Noncommercial-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki