2 /**********************************************************************
3 Copyright (C) FrontAccounting, LLC.
4 Released under the terms of the GNU General Public License, GPL,
5 as published by the Free Software Foundation, either version 3
6 of the License, or (at your option) any later version.
7 This program is distributed in the hope that it will be useful,
8 but WITHOUT ANY WARRANTY; without even the implied warranty of
9 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10 See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
11 ***********************************************************************/
13 // FrontAccounting extension modules integration.
14 // This file is included in session.inc even before session is started,
15 // and includes hooks.php connector files from all installed extensions.
16 // To make hooks active install_hooks() have to be called after interface
19 // To find how various hooks are processed look into respective hook_* functions below.
22 var $module_name; // extension module name.
25 // Helper for updating databases with extension scheme
27 // $comp can be company number, -1 for all,
28 // $updates - table of filename => array(table, field, property)
29 // $check_only - don't update database, check table/field/property existence only
31 function update_databases($comp, $updates, $check_only=false)
33 global $db_connections, $path_to_root;
36 $conn = $db_connections;
38 $conn = array( $comp => $db_connections[$comp]);
41 foreach($conn as $comp => $con) {
42 set_global_connection($comp);
43 foreach($updates as $file => $update) {
46 $properties = @$update[2];
48 $ok = check_table($con['tbpref'], $table, $field, $properties) == 0;
50 if (!$check_only && !$ok) {
51 $ok = db_import($path_to_root.'/modules/'.$this->module_name.'/sql/'.$file,
62 set_global_connection(0); // return to siteadmin account
67 // Install additional tabs provided by extension
69 function install_tabs($app)
71 // $app->add_application(new example_class); // add menu tab defined by example_class
74 // Install additonal menu options provided by extension
76 function install_options($app)
78 // global $path_to_root;
82 // $app->add_rapp_function( 0, _("&Example option"),
83 // $path_to_root.'/modules/example/example.php?', 'SA_OPEN');
87 function install_access()
89 // $security_areas['SA_EXAMPLE'] = array(SS_EXAMPLE|100, _("Example security area."));
91 // $security_sections = array(SS_EXAMPLE => _("Example module implementation"));
93 // return array($security_areas, $security_sections);
97 // Price in words. $doc_type is set to document type and can be used to suppress
98 // price in words printing for selected document types.
99 // Used instead of built in simple english price_in_words() function.
101 // Returns: amount in words as string.
103 function price_in_words($amount, $doc_type)
107 // Exchange rate currency $curr as on date $date.
108 // Keep in mind FA has internally implemented 3 exrate providers
109 // If any of them supports your currency, you can simply use function below
110 // with apprioprate provider set, otherwise implement your own.
111 // Returns: $curr value in home currency units as a real number.
113 function retrieve_exrate($curr, $date)
115 // $provider = 'ECB'; // 'ECB', 'YAHOO' or 'GOOGLE'
116 // return get_extern_rate($curr, $provider, $date);
120 // External authentication
121 // If used should return true after successfull athentication, false otherwise.
122 function authenticate($login, $password)
126 // Generic function called at the end of Tax Report (report 709)
127 // Can be used e.g. for special database updates on every report printing
128 // or to print special tax report footer
131 function tax_report_done()
134 // Following database transaction hooks akcepts array of parameters:
135 // 'cart' => transaction data
136 // 'trans_type' => transaction type
138 function db_prewrite(&$cart, $trans_type)
143 function db_postwrite(&$cart, $trans_type)
148 function db_prevoid($trans_type, $trans_no)
153 This method is called after module install.
155 function install_extension($check_only=true)
160 This method is called after module uninstall.
162 function uninstall_extension($check_only=true)
167 This method is called on extension activation for company.
169 function activate_extension($company, $check_only=true)
174 This method is called when extension is deactivated for company.
176 function deactivate_extension($company, $check_only=true)
183 Installs hooks provided by extension modules
185 function install_hooks()
187 global $path_to_root, $Hooks, $installed_extensions;
191 // include current language related $Hooks object if locale file exists
192 if (file_exists($path_to_root . "/lang/".$_SESSION['language']->code."/locale.inc"))
194 include_once($path_to_root . "/lang/".$_SESSION['language']->code."/locale.inc");
195 $code = $_SESSION['language']->code;
196 $hook_class = 'hooks_'.$code;
197 $Hooks[$code] = new $hook_class;
198 unset($code, $hook_class);
200 // install hooks provided by active extensions
201 foreach($installed_extensions as $ext) {
202 $hook_class = 'hooks_'.$ext['package'];
203 if ($ext['active'] && class_exists($hook_class)) {
204 $Hooks[$ext['package']] = new $hook_class;
209 Non active hooks are not included in $Hooks array, so we can use special function to
212 function activate_hooks($ext, $comp)
216 $hooks = @$Hooks[$ext];
218 $hookclass = 'hooks_'.$ext;
219 if (class_exists($hookclass))
220 $hooks = new $hookclass;
222 return true; // extension does not have hooks file
227 return $hooks->activate_extension($comp, false);
230 Calls hook $method defined in extension $ext (if any)
232 function hook_invoke($ext, $method, &$data, $opts=null)
238 if (isset($Hooks[$ext]) && method_exists($Hooks[$ext], $method)) {
239 set_ext_domain('modules/'.$ext);
240 $ret = $Hooks[$ext]->$method($data, $opts);
247 Calls hook $methods defined in all extensions (if any)
249 function hook_invoke_all($method, &$data, $opts=null)
255 foreach($Hooks as $ext => $hook)
256 if (method_exists($hook, $method)) {
257 set_ext_domain('modules/'.$ext);
258 $result = $hook->$method($data, $opts);
259 if (isset($result) && is_array($result)) {
260 $return = array_merge_recursive($return, $result);
261 } else if (isset($result)) {
269 Returns first non-null result returned from hook.
271 function hook_invoke_first($method, &$data, $opts=null)
277 foreach($Hooks as $ext => $hook) {
278 if (method_exists($hook, $method)) {
279 set_ext_domain('modules/'.$ext);
280 $result = $hook->$method($data, $opts);
289 Returns last non-null result returned from modules method. Helps implement hooks overriding by
290 extensions installed later.
292 function hook_invoke_last($method, &$data, $opts=null)
298 $Reverse = array_reverse($Hooks);
299 foreach($Reverse as $ext => $hook) {
300 if (method_exists($hook, $method)) {
301 set_ext_domain('modules/'.$ext);
302 $result = $hook->$method($data, $opts);
310 //------------------------------------------------------------------------------------------
311 // Database transaction hooks.
312 // $type - type of transaction (simplifies cart processing)
313 // $cart - transaction cart
314 // $args is optional array of parameters
316 // For FA 2.3 prewrite, postwrite and prevoid hooks are implemented for following transaction types:
318 // ST_BANKPAYMENT, ST_BANKDEPOSIT, ST_BANKTRANSFER,
319 // ST_SALESORDER, ST_SALESQUOTE, ST_SALESINVOICE, ST_CUSTCREDIT, ST_CUSTPAYMENT, ST_CUSTDELIVERY,
320 // ST_LOCTRANSFER, ST_INVADJUST,
321 // ST_PURCHORDER, ST_SUPPINVOICE, ST_SUPPCREDIT, ST_SUPPAYMENT, ST_SUPPRECEIVE,
322 // ST_WORKORDER, ST_MANUISSUE, ST_MANURECEIVE,
325 Invoked after transaction has been read from database to cart.
328 //function hook_db_postread(&$cart, $type)
330 // hook_invoke_all('db_postread', $cart, $type);
334 Invoked before transaction is written to database.
336 function hook_db_prewrite(&$cart, $type)
338 return hook_invoke_all('db_prewrite', $cart, $type);
342 Invoked after transaction has been written to database.
344 function hook_db_postwrite(&$cart, $type)
346 return hook_invoke_all('db_postwrite', $cart, $type);
349 Invoked before transaction is voided
351 function hook_db_prevoid($type, $type_no)
353 return hook_invoke_all('db_prevoid', $type, $type_no);
356 //-------------------------------------------------------------------------------------------
360 // Alternative exchange rates feeds.
362 function hook_retrieve_exrate($currency, $date)
364 return hook_invoke_last('retrieve_exrate', $currency, $date);
367 // Generic function called at the end of Tax Report (report 709)
369 function hook_tax_report_done()
371 return hook_invoke_all('tax_report_done', $dummy);
374 // Amount in words displayed on various documents (especially sales invoice)
376 function hook_price_in_words($amount, $document)
378 return hook_invoke_last('price_in_words', $amount, $document);
381 // Session handling hook. This is special case of hook class which have to be run before session is started.
382 // If fa_session_manager class is defined in any installed extension, this class provides session handling
383 // for application, otherwise standard php session handling is used.
385 function hook_session_start($company)
387 if (class_exists('fa_session_manager')) {
388 global $SessionManager;
389 $SessionManager = new fa_session_manager($company);
390 return $SessionManager->installed;
395 // Third party authentication modules.
396 // Returns true after successfull authentication, false otherwise, null if no login hook is defined.
398 function hook_authenticate($login, $password)
400 return hook_invoke_last('authenticate', $login, $password);