[ Index ]
 

Code source de CMS made simple 1.0.5

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/lib/classes/ -> class.events.inc.php (sommaire)

(pas de description)

Poids: 511 lignes (15 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

Events:: (11 méthodes):
  CreateEvent()
  RemoveEvent()
  SendEvent()
  ListEventHandlers()
  ListEvents()
  AddEventHandler()
  RemoveEventHandler()
  RemoveAllEventHandlers()
  GetEventHelp()
  GetEventDescription()
  SetupCoreEvents()


Classe: Events  - X-Ref

Events class for admin

CreateEvent( $modulename, $eventname )   X-Ref
Inform the system about a new event that can be generated

returns: nothing
param: string The name of the module that is sending the event
param: string The name of the event

RemoveEvent( $modulename, $eventname )   X-Ref
Remove an event from the CMS system
This function removes all handlers to the event, and completely removes
all references to this event from the database

Note, only events created by this module can be removed.

returns: nothing
param: string The name of the module that is sending the event
param: string The name of the event

SendEvent( $modulename, $eventname, $params = array()   X-Ref
Trigger an event.
This function will call all registered event handlers for the event

returns: nothing
param: string The name of the module that is sending the event
param: string The name of the event
param: array  The parameters associated with this event.

ListEventHandlers( $modulename, $eventname )   X-Ref
Return the list of event handlers for a particular event

returns: mixed If successful, an array of arrays, each element

ListEvents()   X-Ref
Get a list of all of the known events

returns: mixed If successful, a list of all the known events.  If it fails, false

AddEventHandler( $modulename, $eventname, $tag_name = false, $module_handler = false, $removable = true)   X-Ref
Add an event handler for a module event

returns: mixed If successful, true.  If it fails, false.

RemoveEventHandler( $modulename, $eventname, $tag_name = false, $module_handler = false )   X-Ref
Remove an event handler for a particular event

returns: mixed If successful, true.  If it fails, false.

RemoveAllEventHandlers( $modulename, $eventname )   X-Ref
Pas de description

GetEventHelp($eventname)   X-Ref
Place to handle the help messages for core events.  Basically just going to
call out to the lang() function.

returns: string Returns the help string for the event.  Empty string if nothing

GetEventDescription($eventname)   X-Ref
Place to handle the description strings for core events.  Basically just going to
call out to the lang() function.

returns: string Returns the description string for the event.  Empty string if nothing

SetupCoreEvents()   X-Ref
Pas de description



Généré le : Tue Apr 3 18:50:37 2007 par Balluche grâce à PHPXref 0.7