include/utils/LogicHook.php

Show: inherited
Table of Contents

\LogicHook

Package: SugarCRM

Predefined logic hooks after_ui_frame after_ui_footer after_save before_save before_retrieve after_retrieve process_record before_delete after_delete before_restore after_restore server_roundtrip before_logout after_logout before_login after_login login_failed after_session_start after_entry_point

Api
 

Properties

Propertypublic  $bean= 'null'
Default valuenullDetails
Type
n/a
Propertyprotected  $hook_map= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotected  $hooks= 'array()'
static
Default valuearray()Details
Type
n/a
Propertyprotected  $hookscan= 'array()'
Default valuearray()Details
Type
n/a

Methods

methodpublicLogicHook( ) : void

methodpubliccall_custom_logic( string $module_dir, string $event, array $arguments = null ) : void

Provide a means for developers to create upgrade safe business logic hooks.

If the bean is null, then we assume this call was not made from a SugarBean Object and therefore we do not pass it to the method call.

Parameters
Name Type Description
$module_dir string
$event string
$arguments array
methodpublicgetHooks(  $module_dir,  $refresh = false ) : void

Parameters
Name Type Description
$module_dir
$refresh
methodpublicgetHooksList( ) : void

methodpublicgetHooksMap( ) : void

methodpublicinitialize( ) : \unknown

Static Function which returns and instance of LogicHook

Returns
Type Description
\unknown
methodpublicloadHooks(  $module_dir ) : void

Parameters
Name Type Description
$module_dir
methodpublicprocess_hooks( array $hook_array, string $event, array $arguments ) : void

This is called from call_custom_logic and actually performs the action as defined in the logic hook. If the bean is null, then we assume this call was not made from a SugarBean Object and therefore we do not pass it to the method call.

Parameters
Name Type Description
$hook_array array
$event string
$arguments array
methodpublicrefreshHooks( ) : void
static

methodpublicscanHooksDir(  $extpath ) : void

Parameters
Name Type Description
$extpath
methodpublicsetBean(  $bean ) : void

Parameters
Name Type Description
$bean
Documentation was generated by DocBlox 0.18.1.