Description made more clear

[mailer.git] / inc / config-functions.php

diff --git a/inc/config-functions.php b/inc/config-functions.php
index db003aaf9e824e1dec3b2add7bca41467705a657..01d538db1977cd093cbb6e9edb1239a021e9220d 100644 (file)
--- a/inc/config-functions.php
+++ b/inc/config-functions.php
@@ -6,19 +6,17 @@
  * -------------------------------------------------------------------- *
  * File              : config-functions.php                             *
  * -------------------------------------------------------------------- *
- * Short description : Many non-MySQL functions (also file access)      *
+ * Short description : Configuration functions                          *
  * -------------------------------------------------------------------- *
- * Kurzbeschreibung  : Viele Nicht-MySQL-Funktionen (auch Dateizugriff) *
+ * Kurzbeschreibung  : Konfigurationsfunktionen                         *
  * -------------------------------------------------------------------- *
  * $Revision::                                                        $ *
  * $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                    *
+ * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
  * For more information visit: http://www.mxchange.org                  *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -73,13 +71,10 @@ function initConfig () {
 
 // Getter for $GLOBALS['config'] entries
 function getConfig ($configEntry) {
-       // Default value
-       $value = null;
-
        // Is the entry there?
        if (!isConfigEntrySet($configEntry)) {
                // Raise an error of missing entries
-               debug_report_bug(__FUNCTION__, __LINE__, sprintf("Configuration entry <em>%s</em> is missing.", $configEntry));
+               debug_report_bug(__FUNCTION__, __LINE__, sprintf("Configuration entry <span class=\"data\">%s</span> is missing.", $configEntry));
        } // END - if
 
        // Return it
@@ -95,7 +90,7 @@ function setConfigEntry ($configEntry, $value) {
 
 // Checks wether the given config entry is set
 function isConfigEntrySet ($configEntry) {
-       //* DEBUG: */ debugOutput(__FUNCTION__.':'.$configEntry.'='.intval(isset($GLOBALS['config'][$configEntry])));
+       //* DEBUG: */ debugOutput(__FUNCTION__ . ':' . $configEntry . '=' . intval(isset($GLOBALS['config'][$configEntry])));
        return (isset($GLOBALS['config'][$configEntry]));
 }
 
@@ -106,7 +101,7 @@ function mergeConfig ($newConfig) {
 
 // Increment or init with given value or 1 as default the given config entry
 function incrementConfigEntry ($configEntry, $value=1) {
-       // Increment it if set or init it with 1
+       // Increment it if set or init it with $value
        if (isConfigEntrySet($configEntry)) {
                $GLOBALS['config'][$configEntry] += $value;
        } else {
@@ -154,7 +149,7 @@ function updateOldConfigFile () {
                '_TABLE_TYPE'        => '_TABLE_TYPE',
                '_DB_TYPE'           => '_DB_TYPE',
                'SMTP_HOSTNAME'      => 'SMTP_HOSTNAME',
-               'SMTP_USER'           => 'SMTP_USER',
+               'SMTP_USER'          => 'SMTP_USER',
                'SMTP_PASSWORD'      => 'SMTP_PASSWORD',
                'ENABLE_BACKLINK'    => 'ENABLE_BACKLINK',
                'MAIN_TITLE'         => 'MAIN_TITLE',
@@ -198,7 +193,7 @@ function updateOldConfigFile () {
 
                        // Is the line found?
                        if ((substr($line, 0, strlen($old)) == $old) && (!isset($done[$old]))) {
-                               // Entry found!
+                               // Entry found
                                //* DEBUG: */ debugOutput(secureString($line) . ' - FOUND!');
 
                                // Eval the line...
@@ -225,7 +220,7 @@ function updateOldConfigFile () {
 
                                /// ... and write it to the new config
                                //* DEBUG: */ debugOutput('function=' . $function . ',new=' . $new . ',comment=' . $comment);
-                               changeDataInFile(getCachePath() . 'config-local.php', $comment, $function . "('" . $oldNew . "', \"", '");', constant($new), 0);
+                               changeDataInInclude(getCachePath() . 'config-local.php', $comment, $function . "('" . $oldNew . "', \"", '");', constant($new), 0);
                                //* DEBUG: */ debugOutput('CHANGED!');
 
                                // Mark it as done
@@ -243,8 +238,8 @@ function updateOldConfigFile () {
                $line = trim($line);
 
                // Is the $MySQL found?
-               if (substr($line, 0, 6) == "\$MySQL") {
-                       // Okay found!
+               if (substr($line, 0, 6) == '$MySQL') {
+                       // Okay, found
                        $found = true;
                } elseif ($found === true) {
                        // Now check this row
@@ -264,7 +259,7 @@ function updateOldConfigFile () {
                        $key = substr(trim($parts[0]), 1, -1); $value = substr(trim($parts[1]), 1, -2);
 
                        // We can now save the right part in new config file
-                       changeDataInFile(getCachePath() . 'config-local.php', $comments[$key], "        '".$key."'     => \"", '",', $value, 0);
+                       changeDataInInclude(getCachePath() . 'config-local.php', $comments[$key], "     '".$key."'     => \"", '",', $value, 0);
                }
        } // END - foreach
 
@@ -290,7 +285,7 @@ function updateConfiguration ($entries, $values, $updateMode='', $config = '0')
                        // Update mode set?
                        if (!empty($updateMode)) {
                                // Update entry
-                               $all .= sprintf("`%s`=`%s`%s%s,", $entry, $entry, $updateMode, (float)$values[$idx]);
+                               $all .= sprintf("`%s`=`%s`%s%s,", $entry, $entry, $updateMode, (float) $values[$idx]);
                        } else {
                                // Check if string or number but no array
                                if (is_array($values[$idx])) {
@@ -298,7 +293,7 @@ function updateConfiguration ($entries, $values, $updateMode='', $config = '0')
                                        debug_report_bug(__FUNCTION__, __LINE__, 'values[' . $idx . '] should not be an array! Content=<pre>'.print_r($values[$idx], true).'</pre>');
                                } elseif (($values[$idx] + 0) === $values[$idx]) {
                                        // Number detected
-                                       $all .= sprintf("`%s`=%s,", $entry, (float)$values[$idx]);
+                                       $all .= sprintf("`%s`=%s,", $entry, (float) $values[$idx]);
 
                                        // Set it in config as well
                                        setConfigEntry($entry, $values[$idx]);
@@ -322,13 +317,13 @@ function updateConfiguration ($entries, $values, $updateMode='', $config = '0')
                $entries = substr($all, 0, -1);
        } elseif (!empty($updateMode)) {
                // Update mode set
-               $entries = sprintf("`%s`=`%s`%s%s", $entries, $entries, $updateMode, (float)$values);
+               $entries = sprintf("`%s`=`%s`%s%s", $entries, $entries, $updateMode, (float) $values);
        } elseif (($values + 0) === $values) {
                // Number detected
-               $entries = sprintf("`%s`=%s", $entries, (float)$values);
+               $entries = sprintf("`%s`=%s", $entries, (float) $values);
 
                // Set it in config first
-               setConfigEntry($entries, (float)$values);
+               setConfigEntry($entries, (float) $values);
        } elseif ($values == 'UNIX_TIMESTAMP()') {
                // Function UNIX_TIMESTAMP() detected
                $entries = sprintf("`%s`=UNIX_TIMESTAMP()", $entries);
@@ -356,7 +351,9 @@ function updateConfiguration ($entries, $values, $updateMode='', $config = '0')
 // Filter for loading configuration
 function FILTER_LOAD_CONFIGURATION ($no = '0') {
        // Is the value null, fix it :(
-       if (is_null($no)) $no = '0';
+       if (is_null($no)) {
+               $no = '0';
+       } // END - if
 
        // Check for cache extension, cache-array and if the requested configuration is in cache
        if ((isset($GLOBALS['cache_array']['config'][$no])) && (is_array($GLOBALS['cache_array']['config'][$no]))) {