X-Git-Url: https://delta.frontaccounting.com/gitweb/?a=blobdiff_plain;f=includes%2Fhooks.inc;h=cb5cddfa9db3e604635b80a3ab52023cb0dd3cbb;hb=0b63d898491b6577a5a5bf90e771dca0dcbbcf1f;hp=f5cfe2a09c64ffef8beb3dd71b5a7d5a58f2180f;hpb=5045b61ccd1b86932c8b981041a93112c6f9db36;p=fa-stable.git

diff --git a/includes/hooks.inc b/includes/hooks.inc
index f5cfe2a0..cb5cddfa 100644
--- a/includes/hooks.inc
+++ b/includes/hooks.inc
@@ -93,6 +93,19 @@ class hooks {
 //		return array($security_areas, $security_sections);
 	}
 
+	//
+	//	Invoked for all modules before page header is displayed
+	//
+	function pre_header($fun_args)
+	{
+	}
+	//
+	//	Invoked for all modules before page footer is displayed
+	//
+	function pre_footer($fun_args)
+	{
+	}
+
 	//
 	// Price in words. $doc_type is set to document type and can be used to suppress 
 	// price in words printing for selected document types.
@@ -100,11 +113,10 @@ class hooks {
 	//
 	//	Returns: amount in words as string.
 
-/*	commented out in base class to enable use with hook_invoke_last
 	function price_in_words($amount, $doc_type)
 	{
 	}
-*/
+
 	//
 	// Exchange rate currency $curr as on date $date.
 	// Keep in mind FA has internally implemented 3 exrate providers
@@ -112,14 +124,19 @@ class hooks {
 	// with apprioprate provider set, otherwise implement your own.
 	// Returns: $curr value in home currency units as a real number.
 
-/*	commented out in base class to enable use with hook_invoke_last
 	function retrieve_exrate($curr, $date)
 	{
 //	 	$provider = 'ECB'; // 'ECB', 'YAHOO' or 'GOOGLE'
 //		return get_extern_rate($curr, $provider, $date);
 		return null;
 	}
-*/
+
+	// External authentication
+	// If used should return true after successfull athentication, false otherwise.
+	function authenticate($login, $password)
+	{
+		return null;
+	}
 	// Generic function called at the end of Tax Report (report 709)
 	// Can be used e.g. for special database updates on every report printing
 	// or to print special tax report footer 
@@ -174,6 +191,29 @@ class hooks {
 	{
 		return true;
 	}
+
+	/*
+	 * Returns the quantity allowed to be dispatched for a particular item 
+	 * and a status (which can be used to style the row).
+	 * This quantity would be the default value on the delivery note.
+	 * The usual use case for this is when a item is in stock,
+	 * but has been reserved by someone else.
+	 * This allows extensions to implements its own priority algorithm.
+	 * This function is by detail_id and not item in case the item is present
+	 * more than one in  the cart.
+	 */
+	/* Default behavior check if there is enough quantity on hand and change the css
+ * class if needed */
+	static function  default_get_dispatchable_quantity($line_item, $location, $date, $qoh) {
+    global $SysPrefs;
+
+		if ($SysPrefs->allow_negative_stock() || ($line_item->qty_dispatched <= $qoh)) {
+			return true;
+		}
+		return array($qoh, 'stockmankobg');
+		return array($line_item->qty_dispatched, 'stockmankobg');
+	}
+
 }
 
 /*
@@ -186,9 +226,10 @@ function install_hooks()
 	$Hooks = array();
 	
 	// include current language related $Hooks object if locale file exists
-	if (file_exists($path_to_root . "/lang/".$_SESSION['language']->code."/locale.inc"))
+	$lang_code  = clean_file_name($_SESSION['language']->code);
+	if (file_exists($path_to_root . "/lang/" . $lang_code . "/locale.inc"))
 	{
-		include_once($path_to_root . "/lang/".$_SESSION['language']->code."/locale.inc");
+		include_once($path_to_root . "/lang/" . $lang_code . "/locale.inc");
 		$code = $_SESSION['language']->code;
 		$hook_class = 'hooks_'.$code;
 		$Hooks[$code] = new $hook_class;
@@ -209,7 +250,7 @@ function install_hooks()
 function activate_hooks($ext, $comp)
 {
 	global $Hooks;
-	
+
 	$hooks = @$Hooks[$ext];
 	if (!$hooks) {
 		$hookclass = 'hooks_'.$ext;
@@ -249,17 +290,20 @@ function hook_invoke_all($method, &$data, $opts=null)
 	global $Hooks;
 	
 	$return = array();
-	foreach($Hooks as $ext => $hook)
-		if (method_exists($hook, $method)) {
-			set_ext_domain('modules/'.$ext);
-			$result = $hook->$method($data, $opts);
-			if (isset($result) && is_array($result)) {
-				$return = array_merge_recursive($return, $result);
-			} else if (isset($result)) {
-				$return[] = $result;
-				}
-		}
-	set_ext_domain();
+	if (isset($Hooks))
+	{
+		foreach($Hooks as $ext => $hook)
+			if (method_exists($hook, $method)) {
+				set_ext_domain('modules/'.$ext);
+				$result = $hook->$method($data, $opts);
+				if (isset($result) && is_array($result)) {
+					$return = array_merge_recursive($return, $result);
+				} else if (isset($result)) {
+					$return[] = $result;
+					}
+				set_ext_domain();
+			}
+	}
 	return $return;
 }
 /*
@@ -269,42 +313,40 @@ function hook_invoke_first($method, &$data, $opts=null)
 {
 
 	global $Hooks;
-	
+
 	$result = null;
 	foreach($Hooks as $ext => $hook) {
 		if (method_exists($hook, $method)) {
 			set_ext_domain('modules/'.$ext);
 			$result = $hook->$method($data, $opts);
+			set_ext_domain();
 			if (isset($result))
 				break;
 		}
 	}
-	set_ext_domain();
 	return $result;
 }
 /*
-	Returns result of last hook installed. Helps implement hooks overriding by 
+	Returns last non-null result returned from modules method. Helps implement hooks overriding by 
 	extensions installed later.
-	
 */
 function hook_invoke_last($method, &$data, $opts=null)
 {
 
 	global $Hooks;
 
-	$found = false;
-	foreach($Hooks as $ext => $hook) {
+	$result = null;
+	$Reverse = array_reverse($Hooks);
+	foreach($Reverse as $ext => $hook) {
 		if (method_exists($hook, $method)) {
-			$found = $ext;
+			set_ext_domain('modules/'.$ext);
+			$result = $hook->$method($data, $opts);
+			set_ext_domain();
+			if (isset($result))
+				break;
 		}
 	}
-	$ret = null;
-	if ($found) {
-		set_ext_domain('modules/'.$found);
-		$ret = $Hooks[$found]->$method($data, $opts);
-		set_ext_domain();
-	}
-	return $ret;
+	return $result;
 }
 //------------------------------------------------------------------------------------------
 //	Database transaction hooks.
@@ -390,3 +432,27 @@ function hook_session_start($company)
 	}
 	return false;
 }
+//
+//	Third party authentication modules.
+//	Returns true after successfull authentication, false otherwise, null if no login hook is defined.
+//
+function hook_authenticate($login, $password)
+{
+	return hook_invoke_last('authenticate', $login, $password);
+}
+
+	/*
+	 * Returns the quantity allowed to be dispatched for a particular item 
+	 * and a "reason" (css classes).
+	 * This quantity would be the default value on the delivery note.
+	 * The usual use case for this is when a item is in stock,
+	 * but has been reserved by someone else.
+	 * This allows extensions to implements its own priority algorithm.
+	 * This function is by detail_id and not item in case the item is present
+	 * more than one in  the cart.
+	 * If 'skip' is returned, the line will be skipped and not displayed
+	 */
+function hook_get_dispatchable_quantity($line_item, $location, $date, $qoh) {
+		$result =  hook_invoke_first('get_dispatchable_quantity', $line_item, array($location, $date, $qoh));
+		return $result !== null ? $result : hooks::default_get_dispatchable_quantity($line_item, $location, $date, $qoh);
+}