Référence de la classe JApplicationBase

Graphe d'héritage de JApplicationBase:

Liste de tous les membres

Fonctions membres publiques
	close ($code=0)
	getIdentity ()
	registerEvent ($event, $handler)
	triggerEvent ($event, array $args=null)
	loadDispatcher (JEventDispatcher $dispatcher=null)
	loadIdentity (JUser $identity=null)

Attributs publics
	$input = null

Attributs protégés
	$dispatcher
	$identity

---

Description détaillée

Définition à la ligne 19 du fichier base.php.

---

Documentation des fonctions membres

JApplicationBase::close

(

$code = 0

)

Method to close the application.

Paramètres:

integer

$code

The exit code (optional; default is 0).

Renvoie:

void

Depuis:

12.1

Définition à la ligne 55 du fichier base.php.

        {
                exit($code);
        }

JApplicationBase::getIdentity

(

)

Get the application identity.

Renvoie:

mixed A JUser object or null.

Depuis:

12.1

Définition à la ligne 67 du fichier base.php.

        {
                return $this->identity;
        }

JApplicationBase::loadDispatcher

(

JEventDispatcher

$dispatcher = null

)

Allows the application to load a custom or default dispatcher.

The logic and options for creating this object are adequately generic for default cases but for many applications it will make sense to override this method and create event dispatchers, if required, based on more specific needs.

Paramètres:

JEventDispatcher

$dispatcher

An optional dispatcher object. If omitted, the factory dispatcher is created.

Renvoie:

JApplicationBase This method is chainable.

Depuis:

12.1

Définition à la ligne 125 du fichier base.php.

Références JEventDispatcher\getInstance().

        {
                $this->dispatcher = ($dispatcher === null) ? JEventDispatcher::getInstance() : $dispatcher;

                return $this;
        }

Voici le graphe d'appel pour cette fonction :

JApplicationBase::loadIdentity

(

JUser

$identity = null

)

Allows the application to load a custom or default identity.

The logic and options for creating this object are adequately generic for default cases but for many applications it will make sense to override this method and create an identity, if required, based on more specific needs.

Paramètres:

JUser

$identity

An optional identity object. If omitted, the factory user is created.

Renvoie:

JApplicationBase This method is chainable.

Depuis:

12.1

Définition à la ligne 145 du fichier base.php.

Références JFactory\getUser().

        {
                $this->identity = ($identity === null) ? JFactory::getUser() : $identity;

                return $this;
        }

Voici le graphe d'appel pour cette fonction :

JApplicationBase::registerEvent	(		$event,
			$handler
	)

Registers a handler to a particular event group.

Paramètres:

string	$event	The event name.
callable	$handler	The handler, a function or an instance of a event object.

Renvoie:

JApplicationBase The application to allow chaining.

Depuis:

12.1

Définition à la ligne 82 du fichier base.php.

        {
                if ($this->dispatcher instanceof JEventDispatcher)
                {
                        $this->dispatcher->register($event, $handler);
                }

                return $this;
        }

JApplicationBase::triggerEvent	(		$event,
		array	$args = null
	)

Calls all handlers associated with an event group.

Paramètres:

string	$event	The event name.
array	$args	An array of arguments (optional).

Renvoie:

array An array of results from each function call, or null if no dispatcher is defined.

Depuis:

12.1

Définition à la ligne 102 du fichier base.php.

        {
                if ($this->dispatcher instanceof JEventDispatcher)
                {
                        return $this->dispatcher->trigger($event, $args);
                }

                return null;
        }

---

Documentation des données membres

JApplicationBase::$dispatcher

protected

Définition à la ligne 27 du fichier base.php.

JApplicationBase::$identity

protected

Définition à la ligne 35 du fichier base.php.

JApplicationBase::$input = null

Définition à la ligne 43 du fichier base.php.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• jplatform-13.1/joomla/application/base.php