]> git.mxchange.org Git - mailer.git/blobdiff - inc/wrapper-functions.php
Mailer project rwritten:
[mailer.git] / inc / wrapper-functions.php
index 3d3e6ebc9b75a32ca44ad96b1942437da8018146..6c394da6cdfb3df579e3ae6e83e93d0a0907fff9 100644 (file)
@@ -326,7 +326,7 @@ function isInstalling () {
        // Determine whether we are installing
        if (!isset($GLOBALS['__mailer_installing'])) {
                // Check URL (css.php/js.php need this)
-               $GLOBALS['__mailer_installing'] = isGetRequestElementSet('installing');
+               $GLOBALS['__mailer_installing'] = (isGetRequestElementSet('installing') || ((isGetRequestElementSet('level')) && (getRequestElement('level') == 'install')));
        } // END - if
 
        // Return result
@@ -673,6 +673,27 @@ function setModule ($newModule) {
        $GLOBALS['__module'] = strtolower($newModule);
 }
 
+// Wrapper to get extra module names
+function getExtraModule () {
+       // Default is 'NULL'
+       $extra = 'NULL';
+
+       // Is 'tab/step' set?
+       if (isPostRequestElementSet('tab')) {
+               // Use this
+               $extra = 'tab=' . postRequestElement('tab');
+       } elseif (isPostRequestElementSet('step')) {
+               // Use this
+               $extra = 'step=' . postRequestElement('step');
+       } elseif ((isActionSet()) && (isWhatSet())) {
+               // Use 'action/what'
+               $extra = 'action=' . getAction() . ':what=' . getWhat();
+       }
+
+       // Return it
+       return $extra;
+}
+
 // Checks whether module is set and optionally aborts on miss
 function isModuleSet ($strict = FALSE) {
        // Check for it
@@ -928,7 +949,7 @@ function getAdminMd5 () {
 // Init user data array
 function initUserData () {
        // User id should not be zero
-       if (!isValidUserId(getCurrentUserId())) {
+       if (!isValidId(getCurrentUserId())) {
                // Should be always valid
                reportBug(__FUNCTION__, __LINE__, 'Current user id is invalid: ' . getCurrentUserId());
        } // END - if
@@ -941,7 +962,7 @@ function initUserData () {
 // Getter for user data
 function getUserData ($column) {
        // User id should not be zero
-       if (!isValidUserId(getCurrentUserId())) {
+       if (!isValidId(getCurrentUserId())) {
                // Should be always valid
                reportBug(__FUNCTION__, __LINE__, 'Current user id is invalid: ' . getCurrentUserId());
        } // END - if
@@ -976,7 +997,7 @@ function getUserDataArray () {
        $userid = getCurrentUserId();
 
        // Is the current userid valid?
-       if (!isValidUserId($userid)) {
+       if (!isValidId($userid)) {
                // Should be always valid
                reportBug(__FUNCTION__, __LINE__, 'Current user id is invalid: ' . $userid);
        } // END - if
@@ -1057,7 +1078,7 @@ function isCurrentUserIdSet () {
        // Is there cache?
        if (!isset($GLOBALS[__FUNCTION__])) {
                // Determine it
-               $GLOBALS[__FUNCTION__] = ((isset($GLOBALS['current_userid'])) && (isValidUserId($GLOBALS['current_userid'])));
+               $GLOBALS[__FUNCTION__] = ((isset($GLOBALS['current_userid'])) && (isValidId($GLOBALS['current_userid'])));
        } // END - if
 
        // Return cache
@@ -1069,7 +1090,7 @@ function unsetCurrentUserId () {
        // Is it set?
        if (isset($GLOBALS['current_userid'])) {
                // Unset this, too
-               unset($GLOBALS['isValidUserId'][$GLOBALS['current_userid']]);
+               unset($GLOBALS['isValidId'][$GLOBALS['current_userid']]);
        } // END - if
 
        // Unset all cache entries
@@ -1079,7 +1100,7 @@ function unsetCurrentUserId () {
 }
 
 // Checks whether we are debugging template cache
-function isDebuggingTemplateCache () {
+function isDebugTemplateCacheEnabled () {
        // Is there cache?
        if (!isset($GLOBALS[__FUNCTION__])) {
                // Determine it
@@ -1099,7 +1120,7 @@ function getFetchedUserData ($keyColumn, $userid, $valueColumn) {
                $data = NULL;
 
                // Can we fetch the user data?
-               if ((isValidUserId($userid)) && (fetchUserData($userid, $keyColumn))) {
+               if ((isValidId($userid)) && (fetchUserData($userid, $keyColumn))) {
                        // Now get the data back
                        $data = getUserData($valueColumn);
                } // END - if
@@ -1295,20 +1316,20 @@ function getTotalRandomRefidUser () {
        return $GLOBALS[__FUNCTION__];
 }
 
-// Is given userid valid?
-function isValidUserId ($userid) {
+// Is given id number valid?
+function isValidId ($id) {
        // Debug message
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid[' . gettype($userid) . ']=' . $userid);
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id[' . gettype($id) . ']=' . $id);
 
        // Is there cache?
-       if (!isset($GLOBALS[__FUNCTION__][$userid])) {
+       if (!isset($GLOBALS[__FUNCTION__][$id])) {
                // Check it out
-               $GLOBALS[__FUNCTION__][$userid] = ((!is_null($userid)) && (!empty($userid)) && ($userid != 'NULL') && ($userid > 0));
+               $GLOBALS[__FUNCTION__][$id] = ((!is_null($id)) && (!is_bool($id)) && (!empty($id)) && ($id != 'NULL') && ($id > 0));
        } // END - if
 
        // Return cache
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',result=' . intval($GLOBALS[__FUNCTION__][$userid]));
-       return $GLOBALS[__FUNCTION__][$userid];
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $id . ',result=' . intval($GLOBALS[__FUNCTION__][$id]));
+       return $GLOBALS[__FUNCTION__][$id];
 }
 
 // Encodes entities
@@ -1351,7 +1372,7 @@ function getDateTimeFromRepository () {
 function getYear ($timestamp = NULL) {
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
-               // null is time()
+               // If NULL is set, use time()
                if (is_null($timestamp)) {
                        $timestamp = time();
                } // END - if
@@ -1368,7 +1389,7 @@ function getYear ($timestamp = NULL) {
 function getMonth ($timestamp = NULL) {
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
-               // If null is set, use time()
+               // If NULL is set, use time()
                if (is_null($timestamp)) {
                        // Use time() which is current timestamp
                        $timestamp = time();
@@ -1604,7 +1625,7 @@ function isRandomReferralIdEnabled () {
        // Is there cache?
        if (!isset($GLOBALS[__FUNCTION__])) {
                // Determine it
-               $GLOBALS[__FUNCTION__] = ((isExtensionInstalledAndNewer('user', '0.3.4')) && (getConfig('select_user_zero_refid') == 'Y'));
+               $GLOBALS[__FUNCTION__] = ((isExtensionInstalledAndNewer('user', '0.3.4')) && (getSelectUserZeroRefid() == 'Y'));
        } // END - if
 
        // Return cache
@@ -1671,6 +1692,18 @@ function getCachePath () {
        return $GLOBALS[__FUNCTION__];
 }
 
+// "Getter" for WRITE_FOOTER
+function getWriteFooter () {
+       // Is there cache?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__] = getConfig('WRITE_FOOTER');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
 // "Getter" for secret_key
 function getSecretKey () {
        // Is there cache?
@@ -2474,6 +2507,78 @@ function isDisplayHomeInIndexEnabled () {
        return $GLOBALS[__FUNCTION__];
 }
 
+// Getter for 'show_points_unconfirmed'
+function getShowPointsUnconfirmed () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('show_points_unconfirmed');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks whether 'show_points_unconfirmed' is 'Y'
+function isShowPointsUnconfirmedEnabled () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = (getShowPointsUnconfirmed() == 'Y');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for 'youre_here'
+function getYoureHere () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('youre_here');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks whether 'show_timings' is 'Y'
+function isYoureHereEnabled () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = (getYoureHere() == 'Y');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for 'show_timings'
+function getShowTimings () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('show_timings');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks whether 'show_timings' is 'Y'
+function isShowTimingsEnabled () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = (getShowTimings() == 'Y');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
 // Getter for 'ap_server_name_since'
 function getApServerNameSince () {
        // Is the cache entry set?
@@ -2546,6 +2651,90 @@ function getPointsRemoveAccount () {
        return $GLOBALS[__FUNCTION__];
 }
 
+// Getter for 'css_php'
+function getCssPhp () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('css_php');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for 'guest_menu'
+function getGuestMenu () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('guest_menu');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks if guest menu is enabled
+function isGuestMenuEnabled () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = (getGuestMenu() == 'Y');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for 'member_menu'
+function getMemberMenu () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = getConfig('member_menu');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Checks if member menu is enabled
+function isMemberMenuEnabled () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // No, so determine it
+               $GLOBALS[__FUNCTION__] = (getMemberMenu() == 'Y');
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
+// Getter for 'word_wrap'
+function getWordWrap () {
+       // Is the cache entry set?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Construct config entry name
+               $configEntry = getMenuModeFromModule() . '_word_wrap_' . getWhat();
+
+               // Is a special config entry found or ext-sql_patches updated?
+               if (isConfigEntrySet($configEntry)) {
+                       // A special config entry has been found, then use it
+                       $GLOBALS[__FUNCTION__] = getConfig($configEntry);
+               } elseif (isExtensionInstalledAndNewer('other', '0.2.9')) {
+                       // No special config entry found, then use it as "fall-back"
+                       $GLOBALS[__FUNCTION__] = getConfig('word_wrap');
+               } else {
+                       // No, use default (15 characters)
+                       $GLOBALS[__FUNCTION__] = 15;
+               }
+       } // END - if
+
+       // Return cached entry
+       return $GLOBALS[__FUNCTION__];
+}
+
 // Checks whether proxy configuration is used
 function isProxyUsed () {
        // Is there cache?
@@ -2663,18 +2852,6 @@ function isExtensionTask ($content) {
        return $GLOBALS[__FUNCTION__][$content['task_type'] . '_' . $content['infos']];
 }
 
-// Getter for 'mt_start'
-function getMtStart () {
-       // Is the cache entry set?
-       if (!isset($GLOBALS[__FUNCTION__])) {
-               // No, so determine it
-               $GLOBALS[__FUNCTION__] = getConfig('mt_start');
-       } // END - if
-
-       // Return cached entry
-       return $GLOBALS[__FUNCTION__];
-}
-
 // Checks whether ALLOW_TESTER_ACCOUNTS is set
 function ifTesterAccountsAllowed () {
        // Is the cache entry set?
@@ -3183,5 +3360,55 @@ function SQL_DEBUG_ENABLED () {
        return $GLOBALS[__FUNCTION__];
 }
 
+// Wrapper function to wrap call of wordwrap()
+function wrapWords ($text) {
+       // Wrap words
+       $wrapped = wordwrap($test, getWordWrap());
+
+       // Return it
+       return $wrapped;
+}
+
+// Encodes given data into a JSON object
+function encodeJson ($data) {
+       // Encode it
+       return json_encode($data, JSON_FORCE_OBJECT);
+}
+
+// Get all extension files
+function loadAllExtensionsByTemplate () {
+       // Get all
+       $extensions = getArrayFromDirectory(
+               'templates/' . getLanguage() . '/html/ext/',
+               'ext_',
+               false,
+               false,
+               array(),
+               '.tpl',
+               '@(\.|\.\.)$@',
+               false
+       );
+
+       // Return them
+       return $extensions;
+}
+
+// Wrapper function to allow full float values as supported by current database layout
+function translateFullComma ($dotted) {
+       // Call inner function
+       return translateComma($dotted, TRUE, 5);
+}
+
+// Wrapper to check if the first element to be shifted is set to given value
+function shift_array (&$array, $value, $key = '0') {
+       // Is the element set and value matches?
+       assert(is_array($array));
+       assert(isset($array[$key]));
+       assert($array[$key] === $value);
+
+       // Shift it
+       array_shift($array);
+}
+
 // [EOF]
 ?>