API16

JEvent/update

From Joomla! Documentation

< API16:JEvent

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

Method to trigger events.


<! removed transcluded page call, red link never existed >

Syntax[edit]

update(&$args)
Parameter Name Default Value Description
&$args Arguments

Returns[edit]

mixed Routine return value

Defined in[edit]

libraries/joomla/event/event.php

Importing[edit]

jimport( 'joomla.event.event' );

Source Body[edit]

public function update(&$args)
{
        /*
         * First lets get the event from the argument array.  Next we will unset the
         * event argument as it has no bearing on the method to handle the event.
         */
        $event = $args['event'];
        unset($args['event']);

        /*
         * If the method to handle an event exists, call it and return its return
         * value.  If it does not exist, return null.
         */
        if (method_exists($this, $event)) {
                return call_user_func_array(array($this, $event), $args);
        } else {
                return null;
        }
}


<! removed transcluded page call, red link never existed >

Examples[edit]

Code Examples[edit]