This manual is deprecated. Please visit https://groupoffice.readthedocs.io for the latest documentation.

Difference between revisions of "Event handling"

From Group-Office Groupware and CRM Documentation
Jump to: navigation, search
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
Group-Office modules can interact with eachother with event handling. For example you might want to do something in a custom module when a particular thing happens in another module.  
+
Group-Office fires event on certain actions. You can attach your own functions to do specific actions on these events. To do this create a new module.
  
−
Some practical examples:
+
eg. modules/myevent.
  
−
# The IMAP authentication module checks access when a user logs in.
+
Inside this folder create the file MyeventModule.php:
−
# When an order status changes in the webshop of group-office.com, an event handler enables the download for the customer
+
−
# When a password is change in Group-Office. A system account can be updated.
+
−
# etc.
+
−
 
+
−
How does it work? I'll explain the IMAP authentication example.
+
−
 
+
−
When a user logs in, an event is fired in classes/base/auth.class.inc.php:
+
−
 
+
−
<pre>
+
−
$params = array('username'=>$username, 'password'=>$password);
+
−
$GO_MODULES->fire_event('before_login', $params);
+
−
</pre>
+
−
 
+
−
The fire_event function searches for a function in each module class. It does it in this way.
+
−
 
+
−
# It searches for the file "module/<module_id>/classes/<module_id>.class.inc.php" and includes it.
+
−
# It checks if class <module_id> is available.
+
−
# It checks if the <module_id>::__on_<event_name>() is defined.
+
−
 
+
−
In the imapauth module I have created this function:
+
  
 
<pre>
 
<pre>
−
class imapauth extends db
+
class GO_Myevent_MyeventModule extends GO_Base_Module{
−
{
+
 
 
−
var $config;
+
public static function initListeners() {
−
+
GO_Files_Model_File::model()->addListener('save', 'GO_Myevent_MyeventModule', 'save');
−
public function __construct(){
+
GO_Files_Model_File::model()->addListener('delete', 'GO_Myevent_MyeventModule', 'delete');
 
 
−
global $GO_MODULES;
+
//attaching to a controller works a bit different
−
+
$c = new GO_Core_Controller_Maintenance();
−
$this->db();
+
$c->addListener('someAction', 'GO_Myevent_MyeventModule', 'doSomething');
−
+
−
if(file_exists($GO_MODULES->modules['imapauth']['path'].'config.inc.php'))
+
−
{
+
−
require($GO_MODULES->modules['imapauth']['path'].'config.inc.php');
+
−
$this->config=$config;
+
−
}
+
 
}
 
}
−
 
−
public function __on_before_login($arguments)
 
−
{
 
 
 
−
...
+
public static function save(&$file){
 +
//do something with the file module here
 +
}
  
 +
public static function delete(&$file){
 +
//do something with the file module here
 +
}
 +
 +
public static function doSomething(){
 +
//do something with the file module here
 
}
 
}
 
}
 
}
 
</pre>
 
</pre>
  
−
So now just before a user is logged in this function is called. The function connects to the IMAP server using the supplied password. If it succeeds it will add a user account and e-mail account or update the password if necessary.
+
After creating new listeners you must reload Group-Office so it will call the initListeners function.
−
 
+
−
The same could be done with any application/protocol like Joomla, PhpBB, LDAP etc. You'll just have to write it!
+
−
 
+
  
−
==Defined events==
+
=Standard events=
 +
Every model that is derived from GO_Base_Db_ActiveRecord has a "save" and "delete" event. They listeners will be called with the model as the first argument.
  
−
{|cellpadding="5" cellspacing="0" border="1"
+
Every controller that is derived from GO_Base_Controller_AbstractModelController has a "submit", "load", "display" and "delete" event. They are all called with these parameters: $controller, $response,$model,$params,$modifiedAttributes
−
! Module
+
−
! Event name
+
−
! Parameters
+
−
! Description
+
−
|-
+
−
| Framework
+
−
| before_login
+
−
| username, password
+
−
| Fires just before a user logins. Useful for authentication bridges.
+
−
|-
+
−
| Framework
+
−
| update_user
+
−
| user: array with all db fields
+
−
| Fires when a user is updated.
+
−
|-
+
−
| Framework
+
−
| before_add_user
+
−
| user: array with all db fields
+
−
| Fires just before a user is added.
+
−
|-
+
−
| Framework
+
−
| add_user
+
−
| user: array with all db fields
+
−
| Fires after a user is added.
+
−
|-
+
−
| Framework
+
−
| user_delete
+
−
| user: array with all db fields
+
−
| Fires after a user is deleted.
+
−
|-
+
−
| Framework
+
−
| install_module
+
−
| module: array with module db fields
+
−
| Fires when a module is installed.
+
−
| Eg. You could enable extra functionality in another module when a module is installed
+
−
| -
+
−
| Framework
+
−
| save_settings
+
−
| Fires when a the user settings are updated
+
−
| Each module can add it's own panels to the settings dialog. Through this event you can update the module settings.
+
−
| -
+
−
| Framework
+
−
| reminder_dismissed
+
−
| reminder: array with reminder db fields
+
−
| Fires when a reminder is dismised
+
−
| Eg. When a reminder of a recurring event is dismissed, a new reminder is created for the next occurrence.
+
−
| -
+
−
|}
+

Latest revision as of 10:21, 26 July 2012

Group-Office fires event on certain actions. You can attach your own functions to do specific actions on these events. To do this create a new module.

eg. modules/myevent.

Inside this folder create the file MyeventModule.php: 

class GO_Myevent_MyeventModule extends GO_Base_Module{	
	
	public static function initListeners() {
		GO_Files_Model_File::model()->addListener('save', 'GO_Myevent_MyeventModule', 'save');
		GO_Files_Model_File::model()->addListener('delete', 'GO_Myevent_MyeventModule', 'delete');
		
		//attaching to a controller works a bit different
		$c = new GO_Core_Controller_Maintenance();
		$c->addListener('someAction', 'GO_Myevent_MyeventModule', 'doSomething');
	}
	
	public static function save(&$file){
		//do something with the file module here		
	}

	public static function delete(&$file){
		//do something with the file module here		
	}

	public static function doSomething(){
		//do something with the file module here		
	}
}

After creating new listeners you must reload Group-Office so it will call the initListeners function.

Standard events

Every model that is derived from GO_Base_Db_ActiveRecord has a "save" and "delete" event. They listeners will be called with the model as the first argument.

Every controller that is derived from GO_Base_Controller_AbstractModelController has a "submit", "load", "display" and "delete" event. They are all called with these parameters: $controller, $response,$model,$params,$modifiedAttributes

Retrieved from "http://www.group-office.com/w/index.php?title=Event_handling&oldid=2878"