Class mosMambotHandler

Description

Plugin handler

Located in /includes/mambo.php (line 2691)


	
			
Variable Summary
array $_bots
array $_events
array $_lists
int $_loading
Method Summary
mosMambotHandler mosMambotHandler ()
void addListOption (string $group, string $listName, string $value, [string $text = ''])
array call (string $event)
array getList (string $group, string $listName)
void loadBotGroup (string $group)
void registerFunction (string $event, string $function)
array trigger (string $event, [array $args = null], [boolean $doUnpublished = false])
Variables
array $_bots = null (line 2697)
  • var: An array of mambots
array $_events = null (line 2693)
  • var: An array of functions in event groups
array $_lists = null (line 2695)
  • var: An array of lists
int $_loading = null (line 2699)
  • var: Index of the mambot being loaded
Methods
Constructor mosMambotHandler (line 2704)

Constructor

mosMambotHandler mosMambotHandler ()
addListOption (line 2752)

Makes a option for a particular list in a group

void addListOption (string $group, string $listName, string $value, [string $text = ''])
  • string $group: The group name
  • string $listName: The list name
  • string $value: The value for the list option
  • string $text: The text for the list option
call (line 2800)

Same as trigger but only returns the first event and

allows for a variable argument list

  • return: The result of the first function call
array call (string $event)
  • string $event: The event name
getList (line 2760)
array getList (string $group, string $listName)
  • string $group: The group name
  • string $listName: The list name
loadBotGroup (line 2711)

Loads all the bot files for a particular group

void loadBotGroup (string $group)
  • string $group: The group name, relates to the sub-directory in the mambots directory
registerFunction (line 2742)

Registers a function to a particular event group

void registerFunction (string $event, string $function)
  • string $event: The event name
  • string $function: The function name
trigger (line 2770)

Calls all functions associated with an event group

  • return: An array of results from each function call
array trigger (string $event, [array $args = null], [boolean $doUnpublished = false])
  • string $event: The event name
  • array $args: An array of arguments
  • boolean $doUnpublished: True is unpublished bots are to be processed

Documentation generated on Fri, 4 Mar 2005 13:56:33 +1000 by phpDocumentor 1.3.0RC3