Jaxl 2.x provides an event mechanism using which developers can register callbacks for various xmpp events inside their application code. This blog post will demonstrate how to register callbacks for required xmpp events and go through a list of all available hooks. Finally, we will discuss parameters that are passed to called back methods by Jaxl core.
Registering callback on XMPP events
Applications can register callback for various XMPP events. Jaxl core will then callback application methods (with 2 parameters) every time associated XMPP event occurs. Shown below are some sample examples for registering callbacks.
When application callback’d method is a function:
function postAuth($payload, $jaxl) {
}
$jaxl->addPlugin('jaxl_post_auth', 'postAuth');
When application callback’d method is a public static method of a class:
class MyXMPPApp {
public static function postAuth($payload, $jaxl) {
}
}
$jaxl->addPlugin('jaxl_post_auth', array('MyXMPPApp', 'postAuth'));
When application callback’d method is a public method inside a class:
class MyXMPPApp {
function postAuth($payload, $jaxl) {
}
}
$MyXMPPApp = new MyXMPPApp();
$jaxl->addPlugin('jaxl_post_auth', array($MyXMPPApp, 'postAuth'));
In all the above examples jaxl_post_auth is one of the available hook for registering callbacks.
List of available hooks
Below is a complete list of available hooks in order of their occurrence within a Jaxl instance life cycle:
Hooks for events related to instance connection and authentication steps in various modes:
- jaxl_post_connect
- jaxl_get_auth_mech
- jaxl_get_facebook_key
- jaxl_post_auth_failure
- jaxl_post_auth
- jaxl_post_handshake
- jaxl_pre_shutdown
- jaxl_post_disconnect
- jaxl_get_empty_body
Hooks for events related to XMPP stream and stanza’s:
- jaxl_get_stream_error
- jaxl_get_presence
- jaxl_get_message
- jaxl_get_iq_get
- jaxl_get_iq_set
- jaxl_get_iq_error
- jaxl_send_message
- jaxl_send_presence
Hooks for events related to reading/writing of XMPP packets and internal packet routing:
- jaxl_get_xml
- jaxl_send_xml
- jaxl_send_body
- jaxl_pre_handler
- jaxl_post_handler
TO-DO: Update when every hook is called inside your application life cycle and list of parameters passed for each callback. As of now you can var_dump($payload); inside your callback method.
