Renamed function so it might be more understandable
[mailer.git] / inc / inc-functions.php
index 54853e78ad893cc408c14917d074be4ccaf505c3..163fec15f76069ca49b730fd6b519604329ab076 100644 (file)
  * $Date::                                                            $ *
  * $Tag:: 0.2.1-FINAL                                                 $ *
  * $Author::                                                          $ *
- * Needs to be in all Files and every File needs "svn propset           *
- * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
+ * Copyright (c) 2009, 2010 by Mailer Developer Team                    *
  * For more information visit: http://www.mxchange.org                  *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -43,43 +42,49 @@ if (!defined('__SECURITY')) {
 
 // Init INC_POOL
 function initIncludePool ($pool) {
-       //* DEBUG: */ print __FUNCTION__.':pool='.$pool.'<br />';
+       //* DEBUG: */ debugOutput(__FUNCTION__.':pool='.$pool);
        $GLOBALS['inc_pool'][$pool] = array();
 }
 
 // Setter for INC_POOL
 function setIncludePool ($pool, $includePool) {
-       //* DEBUG: */ print __FUNCTION__.':pool='.$pool.'<br />';
+       //* DEBUG: */ debugOutput(__FUNCTION__.':pool='.$pool);
        $GLOBALS['inc_pool'][$pool] = (array) $includePool;
 }
 
 // Getter for INC_POOL
 function getIncludePool ($pool) {
-       //* DEBUG: */ print __FUNCTION__.':pool='.$pool.'<br />';
-       return $GLOBALS['inc_pool'][$pool];
+       //* DEBUG: */ debugOutput(__FUNCTION__.':pool='.$pool);
+       if (isset($GLOBALS['inc_pool'][$pool])) {
+               // Return found pool (array)
+               return $GLOBALS['inc_pool'][$pool];
+       } else {
+               // Return empty array if not found
+               return array();
+       }
 }
 
 // Count INC_POOL
 function countIncludePool ($pool) {
-       //* DEBUG: */ print __FUNCTION__.':pool='.$pool.'<br />';
+       //* DEBUG: */ debugOutput(__FUNCTION__.':pool='.$pool);
        return count($GLOBALS['inc_pool'][$pool]);
 }
 
 // Merge INC_POOL into given
 function mergeIncludePool ($pool, $includePool) {
-       //* DEBUG: */ print __FUNCTION__.':pool='.$pool.'<br />';
+       //* DEBUG: */ debugOutput(__FUNCTION__.':pool='.$pool);
        setIncludePool($pool, merge_array(getIncludePool($pool), $includePool));
 }
 
 // Add single include file to INC_POOL
 function addIncludeToPool ($pool, $inc) {
-       //* DEBUG: */ print __FUNCTION__.':pool='.$pool.'<br />';
+       //* DEBUG: */ debugOutput(__FUNCTION__.':pool='.$pool);
        $GLOBALS['inc_pool'][$pool][] = (string) $inc;
 }
 
 // Remove an include file from INC_POOL
 function removeIncludeFromPool ($pool, $inc) {
-       //* DEBUG: */ print __FUNCTION__.':pool='.$pool.'<br />';
+       //* DEBUG: */ debugOutput(__FUNCTION__.':pool='.$pool);
        // First look it up
        $key = array_search($inc, getIncludePool($pool));
 
@@ -95,12 +100,12 @@ function removeIncludeFromPool ($pool, $inc) {
 
 // Load the whole include pool
 function loadIncludePool ($pool) {
-       //* DEBUG: */ print __FUNCTION__.':pool='.$pool.' - START<br />';
+       //* DEBUG: */ debugOutput(__FUNCTION__.':pool='.$pool.' - START');
        foreach (getIncludePool($pool) as $inc) {
-               //* DEBUG: */ print __FUNCTION__.':inc='.$inc.'<br />';
+               //* DEBUG: */ debugOutput(__FUNCTION__.':inc='.$inc);
                loadIncludeOnce($inc);
        } // END - foreach
-       //* DEBUG: */ print __FUNCTION__.':pool='.$pool.' - END<br />';
+       //* DEBUG: */ debugOutput(__FUNCTION__.':pool='.$pool.' - END');
 
        // Remove it
        initIncludePool($pool);
@@ -111,12 +116,12 @@ function loadInclude ($inc) {
        // Do we have cache?
        if (!isset($GLOBALS['inc_loaded'][$inc])) {
                // Add the path. This is why we need a trailing slash in config.php
-               $GLOBALS['inc_loaded'][$inc] = getConfig('PATH') . $inc;
+               $GLOBALS['inc_loaded'][$inc] = getPath() . $inc;
 
                // Is the include file there?
                if (!isIncludeReadable($inc)) {
                        // Not there so log it
-                       debug_report_bug(sprintf("Include file %s not found.", $inc));
+                       debug_report_bug(__FUNCTION__, __LINE__, sprintf("Include file %s not found.", $inc));
                } // END - if
        } // END - if
 
@@ -127,7 +132,7 @@ function loadInclude ($inc) {
 // Loads an include file once
 function loadIncludeOnce ($inc) {
        // Remove double path
-       $inc = str_replace(getConfig('PATH'), '', $inc);
+       $inc = str_replace(getPath(), '', $inc);
 
        // Is it not loaded?
        if (!isset($GLOBALS['load_once'][$inc])) {
@@ -144,10 +149,10 @@ function isIncludeReadable ($inc) {
        // Do we have cache?
        if (!isset($GLOBALS['inc_readable'][$inc])) {
                // Remove double path
-               $inc = str_replace(getConfig('PATH'), '', $inc);
+               $inc = str_replace(getPath(), '', $inc);
 
                // Construct FQFN
-               $FQFN = getConfig('PATH') . $inc;
+               $FQFN = getPath() . $inc;
 
                // Is it readable?
                $GLOBALS['inc_readable'][$inc] = isFileReadable($FQFN);