API16

JEvent/update: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 55: Line 55:


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=update
  category=update
  category=JEvent
  category=JEvent
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*

Latest revision as of 01:37, 25 March 2017

Description

Method to trigger events.


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

Syntax

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

Returns

mixed Routine return value

Defined in

libraries/joomla/event/event.php

Importing

jimport( 'joomla.event.event' );

Source Body

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

Code Examples