Quick links: Content - sections - sub sections
EN FR
The page corresponding to the latest stable release can be seen in the Jelix 1.6 Manual

A DAO factory can automatically generate events on methods call.

Native methods events

update, insert, delete and deleteby methods can generate events, either before or after execution, or both. To activate event dispatching, you have to declare which events your application want to catch in the events attribute of the <factory> element. Event names are separated by a comma. Full event list includes: deletebefore, deleteafter, updatebefore, updateafter, insertbefore, insertafter, deletebybefore, deletebyafter.

Below is a detailed list of each event and its parameters. Every event has a dao parameter corresponding to their dao selector.

  • daoDeleteBefore : key (key values of the to be deleted record)
  • daoDeleteAfter : key, result (1 if record is truely deleted)
  • daoDeleteByBefore : key, criterias (objet jDaoConditions)
  • daoDeleteByAfter : key, criterias, result (number of deleted records)
  • daoUpdateBefore : record (to be updated record object)
  • daoUpdateAfter : record
  • daoInsertBefore : record (to be inserted record object)
  • daoInsertAfter : record

Here an example.

Dao file

You have to add the property events to the element <factory> (event names should be lowercase).


  <factory events="deleteAfter, insertAfter"> ...

Listener

In the directory classes/ of the module, create a file my.listener.php which defines listeners:


class myListener extends jEventListener{
 
   function onDaoDeleteAfter ($event) {
        $dao = $event->getParam('dao');
        if ($dao == 'mymodule~thedao') {
            $keys = $event->getParam('keys');
            //...
        }
   }

If you want to modify a property of the given record:


$event->getParam("record")->myPropriety = $Variable;

events.xml

The file events.xml of your module declares your listeners:


<events xmlns="http://jelix.org/ns/events/1.0">
   <listener name="my">
       <event name="daoInsertAfter" />
       <event name="daoDeleteAfter" />
   </listener>
</events>

Customized method events

Customized update or delete methods (XML or PHP methods) can declare eventbefore and/or eventafter attributes and set them to true or false.

Generated events will be: daoSpecificUpdateBefore, daoSpecificUpdateAfter, daoSpecificDeleteBefore et daoSpecificDeleteAfter.

They will be emitted with those parameters:

  • dao: dao selector
  • method: method name
  • params: parameters list