aliroMambotHandler Class Reference

Inheritance diagram for aliroMambotHandler:

List of all members.

Public Member Functions
	isPluginPresent ($formalname, $andPublished=false)
	getMambotsForTrigger ($trigger)
	loadBotGroup ($group)
	trigger ($event, $args=null, $doUnpublished=false, $maxbot=0)
	countBots ($event)
	triggerOnce ($event, $args=null, $doUnpublished=false)
	call ($event)
Static Public Member Functions
static	getInstance ()
Protected Member Functions
	__construct ()
Protected Attributes
	$extensiondir = '/mambots/'
Static Protected Attributes
static	$instance = __CLASS__
Private Member Functions
	runOneBot ($botkey, $args, $event, $botparams, $published)
Private Attributes
	$_events = array()
	$_bots = null
	$_bot_objects = array()
	$_botsByName = array()
Static Private Attributes
static	$defaults

---

Detailed Description

Definition at line 67 of file aliroMambot.php.

---

Constructor & Destructor Documentation

aliroMambotHandler::__construct

(

)

[protected]

Definition at line 84 of file aliroMambot.php.

References aliroCoreDatabase::getInstance().

                                     {
        $database = aliroCoreDatabase::getInstance();
        $this->_bots = $database->doSQLget( "SELECT element, class, triggers, published, params, 0 AS isdefault FROM #__mambots ORDER BY ordering");
        foreach ($this->_bots as $bot) $this->_botsByName[$bot->element] = true;
        foreach (self::$defaults as $trigger=>$default) {
            $defobj = new stdClass;
            $defobj->class = $default;
            $defobj->triggers = $trigger;
            $defobj->isdefault = 1;
            array_push($this->_bots, $defobj);
        }
        foreach ($this->_bots as $key=>$bot) {
            $triggers = explode (',', $bot->triggers);
            foreach ($triggers as $trigger) $this->_events[trim($trigger)][] = $key;
        }
    }

---

Member Function Documentation

static aliroMambotHandler::getInstance

(

)

[static]

Definition at line 101 of file aliroMambot.php.

Referenced by aliroEditor::__construct(), aliroUserRequest::doControl(), bot_nulleditor::editorArea(), aliroUserSession::forceLogout(), mosMambotHandler::getInstance(), aliroUserAuthenticator::logout(), aliroPage404::searchuri(), and aliroUserAuthenticator::systemLogin().

                                          {
        return is_object(self::$instance) ? self::$instance : (self::$instance = parent::getCachedSingleton(self::$instance));
    }

aliroMambotHandler::isPluginPresent	(	$	formalname,
		$	andPublished = false
	)

Definition at line 105 of file aliroMambot.php.

                                                                       {
        if (!isset($this->_botsByName[$formalname])) return false;
        if (!$andPublished) return true;
        $bot = $this->_botsByName[$formalname];
        return $bot->published ? true : false;
    }

aliroMambotHandler::getMambotsForTrigger

(

$

trigger

)

Definition at line 113 of file aliroMambot.php.

                                                    {
        if (isset($this->_events[$trigger])) foreach ($this->_events[$trigger] as $botkey) {
            $results[] = $this->_bots[$botkey];
        }
        else $results = array();
        return $results;
    }

aliroMambotHandler::loadBotGroup

(

$

group

)

Definition at line 121 of file aliroMambot.php.

                                           {
        // Only required for backward compatibility
        return true;
    }

aliroMambotHandler::trigger	(	$	event,
		$	args = null,
		$	doUnpublished = false,
		$	maxbot = 0
	)

Definition at line 128 of file aliroMambot.php.

References published(), and runOneBot().

Referenced by call(), and triggerOnce().

                                                                                   {
        if ($args === null) $args = array();
        elseif (!is_array($args)) $args = array($args);
        $result = array();
        $botcount = 0;
        if (isset( $this->_events[$event] )) foreach ($this->_events[$event] as $botkey) {
            $bot = $this->_bots[$botkey];
            if ($bot->isdefault) {
                if (!isset($defaultbotkey)) $defaultbotkey = $botkey;
            }
            else {
                $botparams = new aliroParameters($bot->params);
                if ($doUnpublished OR $bot->published) {
                    $result[] = $this->runOneBot($botkey, $args, $event, $botparams, $bot->published);
                    $botcount ++;
                    if ($maxbot AND $botcount >= $maxbot) break;
                }
            }
        }
        if (0 == $botcount AND isset($defaultbotkey)) $result[] = $this->runOneBot($defaultbotkey, $args, $event, '', '1');
        return $result;
    }

aliroMambotHandler::runOneBot	(	$	botkey,
		$	args,
		$	event,
		$	botparams,
		$	published
	)			[private]

Definition at line 151 of file aliroMambot.php.

Referenced by trigger().

                                                                                {
        if (isset($this->_bot_objects[$botkey])) $botobject = $this->_bot_objects[$botkey];
        else $botobject = $this->_bot_objects[$botkey] = new $this->_bots[$botkey]->class;
        array_unshift($args, $event, $botparams, $published);
        return call_user_func_array(array($botobject, 'perform'), $args);
    }

aliroMambotHandler::countBots

(

$

event

)

Definition at line 158 of file aliroMambot.php.

                                       {
        return isset($this->_events[$event]) ? count($this->_events[$event]) : 0;
    }

aliroMambotHandler::triggerOnce	(	$	event,
		$	args = null,
		$	doUnpublished = false
	)

Definition at line 163 of file aliroMambot.php.

References trigger().

                                                                           {
        return $this->trigger ($event, $args, $doUnpublished, 1);
    }

aliroMambotHandler::call

(

$

event

)

Definition at line 168 of file aliroMambot.php.

References trigger().

                                   {
        $args = func_get_args();
        array_shift($args);
        $result = $this->trigger($event, $args);
        if (isset($result[0])) return $result[0];
        return null;
    }

---

Member Data Documentation

aliroMambotHandler::$instance = __CLASS__ [static, protected]

Definition at line 69 of file aliroMambot.php.

aliroMambotHandler::$defaults [static, private]

Initial value:

 array (
    'onIniEditor' => 'bot_nulleditor',
    'onGetEditorContents' => 'bot_nulleditor',
    'onEditorArea' => 'bot_nulleditor'
    )

Definition at line 71 of file aliroMambot.php.

aliroMambotHandler::$_events = array() [private]

Definition at line 77 of file aliroMambot.php.

aliroMambotHandler::$_bots = null [private]

Definition at line 78 of file aliroMambot.php.

aliroMambotHandler::$_bot_objects = array() [private]

Definition at line 79 of file aliroMambot.php.

aliroMambotHandler::$_botsByName = array() [private]

Definition at line 80 of file aliroMambot.php.

aliroMambotHandler::$extensiondir = '/mambots/' [protected]

Definition at line 82 of file aliroMambot.php.

---

The documentation for this class was generated from the following file:

• aliroMambot.php