Table of Contents Previous Next

Sugar Developer Guide

Version 5.1

Chapter 4 Customizing Sugar : Business Logic Hooks : Available Hooks
Available Hooks
The hooks are processed in the order in which they are added to the array. The first dimension is simply the current action, for example before_save. The following hooks are available:
Application hooks
These hooks do not make use of the $bean argument.
o
after_ui_frame
o
Fired after the frame has been invoked and before the footer has been invoked
o
Available in version 4.5.0 and later
o
after_ui_footer
o
Fired after the footer has been invoked
o
Available in version 4.5.0 and later
o
server_round_trip
o
Fired at the end of every SugarCRM page
o
Available in version 4.5.0 and later
Module hooks
o
before_delete
o
Fired before a record is deleted
o
Available in version 4.5.0 and later
o
after_delete
o
Fired after a record is deleted
o
Available in version 4.5.0 and later
o
before_restore
o
Fired before a record is undeleted
o
Available in version 4.5.0 and later
o
after_restore
o
Fired after a record is undeleted
o
Available in version 4.5.0 and later
o
after_retrieve
o
Fired after a record has been retrieved from the database. This hook does not fire when you create a new record.
o
Available in version 4.5.0 and later
o
before_save
o
Fired before a record is saved.
Note: With certain modules, like Cases and Bugs, the human-readable ID of the record (like the case_number field in the Case module), is not available within a before_save call. This is because this business logic simply hasn't been executed yet.
o
Available in version 4.5.0 and later
o
after_save
o
Fired after a record is saved.
Note: With certain modules, like Cases and Bugs, the human-readable ID of the record (like the case_number field in the Case module), is not available within a before_save call. This is because this business logic simply hasn't been executed yet.
o
Available in version 4.5.0 and later
o
process_record
o
Fired immediately prior to the database query resulting in a record being made current. This gives developers an opportunity to examine and tailor the underlying queries. This is also a perfect place to set values in a record’s fields prior to display in the DetailView or ListView. This event is not fired in the EditView.
o
Available in version 4.5.0 and later
Hooks for Users module
o
before_logout
o
Fired before a user logs out of the system
o
Available in version 4.5.0 and later
o
after_logout
o
Fired after a user logs out of the system
o
Available in version 4.5.0 and later
o
after_login
o
Fired after a user logs into the system.
o
Available in version 4.5.0 and later
o
after_logout
o
Fired after a user logs out of the system.
o
Available in version 4.5.0 and later
o
before_logout
o
Fired before a user logs out of the system.
o
Available in version 4.5.0 and later
o
login_failed
o
Fired on a failed login attempt
o
Available in version 4.5.0 and later
Table of Contents Previous Next

Copyright 2004-2008 SugarCRM Inc.
Product License