Extension ext-mediadata continued, wrapper function introduced:

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

diff --git a/inc/wrapper-functions.php b/inc/wrapper-functions.php
index 564ee853e3dbe4ce6d0d11215ecfbb7eb16f62b2..2eecd1a2ef5931f614b245f5678037d8ea990847 100644 (file)
--- a/inc/wrapper-functions.php
+++ b/inc/wrapper-functions.php
@@ -741,10 +741,19 @@ function isBlockModeEnabled () {
        return $GLOBALS['block_mode'];
 }
 
-// Wrapper function for addPointsThroughReferalSystem()
+/**
+ * Wrapper function for addPointsThroughReferalSystem(), you should generally
+ * avoid this function and use addPointsThroughReferalSystem() directly and add
+ * your special payment method entry to points_data instead.
+ *
+ * @param      $subject        A string-encoded subject for this add
+ * @param      $userid         The recipient (member) for given points
+ * @param      $points         Points to be added to member's account
+ * @return     $added          Wether the points has been added to the user's account
+ */
 function addPointsDirectly ($subject, $userid, $points) {
        // Reset level here
-       unset($GLOBALS['ref_level']);
+       initReferalSystem();
 
        // Call more complicated method (due to more parameters)
        return addPointsThroughReferalSystem($subject, $userid, $points, false, 0, 'DIRECT');
@@ -940,6 +949,7 @@ function initUserData () {
        } // END - if
 
        // Init the user
+       unset($GLOBALS['is_userdata_valid'][getCurrentUserId()]);
        $GLOBALS['user_data'][getCurrentUserId()] = array();
 }
 
@@ -1000,7 +1010,9 @@ function getUserDataArray () {
 // in, but you should use isMember() if you want to find that out.
 function isUserDataValid () {
        // User id should not be zero so abort here
-       if (!isCurrentUserIdSet()) return false;
+       if (!isCurrentUserIdSet()) {
+               return false;
+       } // END - if
 
        // Is it cached?
        if (!isset($GLOBALS['is_userdata_valid'][getCurrentUserId()])) {
@@ -1052,10 +1064,11 @@ function isDebuggingTemplateCache () {
 
 // Wrapper for fetchUserData() and getUserData() calls
 function getFetchedUserData ($keyColumn, $userid, $valueColumn) {
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'keyColumn=' . $keyColumn . ',userid=' . $userid . ',valueColumn=' . $valueColumn . ' - ENTERED!');
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__][$userid][$keyColumn][$valueColumn])) {
-               // Default is 'guest'
-               $data = '{--USERNAME_GUEST--}';
+               // Default is NULL
+               $data = NULL;
 
                // Can we fetch the user data?
                if ((isValidUserId($userid)) && (fetchUserData($userid, $keyColumn))) {
@@ -1068,6 +1081,7 @@ function getFetchedUserData ($keyColumn, $userid, $valueColumn) {
        } // END - if
 
        // Return it
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'keyColumn=' . $keyColumn . ',userid=' . $userid . ',valueColumn=' . $valueColumn . ',value=' . $GLOBALS[__FUNCTION__][$userid][$keyColumn][$valueColumn] . ' - EXIT!');
        return $GLOBALS[__FUNCTION__][$userid][$keyColumn][$valueColumn];
 }
 
@@ -1259,11 +1273,23 @@ function encodeEntities ($str) {
 }
 
 // "Getter" for date from patch_ctime
-function getDateFromPatchTime () {
+function getDateFromRepository () {
+       // Is it cached?
+       if (!isset($GLOBALS[__FUNCTION__])) {
+               // Then set it
+               $GLOBALS[__FUNCTION__] = generateDateTime(getConfig('CURRENT_REPOSITORY_DATE'), '5');
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__];
+}
+
+// "Getter" for date/time from patch_ctime
+function getDateTimeFromRepository () {
        // Is it cached?
        if (!isset($GLOBALS[__FUNCTION__])) {
                // Then set it
-               $GLOBALS[__FUNCTION__] = generateDateTime(getConfig('patch_ctime'), '5');
+               $GLOBALS[__FUNCTION__] = generateDateTime(getConfig('CURRENT_REPOSITORY_DATE'), '2');
        } // END - if
 
        // Return cache
@@ -2469,6 +2495,7 @@ function generateWrappedUserEmailLink ($email) {
 
 // Wrapper to check if user points are locked
 function ifUserPointsLocked ($userid) {
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - ENTERED!');
        // Do we have cache?
        if (!isset($GLOBALS[__FUNCTION__][$userid])) {
                // Determine it
@@ -2476,6 +2503,7 @@ function ifUserPointsLocked ($userid) {
        } // END - if
 
        // Return cache
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',locked=' . intval($GLOBALS[__FUNCTION__][$userid]) . ' - EXIT!');
        return $GLOBALS[__FUNCTION__][$userid];
 }
 
@@ -2488,18 +2516,18 @@ function appendLineToFile ($file, $line) {
 }
 
 // Wrapper for changeDataInFile() but with full path added
-function changeDataInInclude ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0) {
+function changeDataInInclude ($FQFN, $comment, $prefix, $suffix, $inserted, $seek=0) {
        // Add full path
        $FQFN = getPath() . $FQFN;
 
        // Call inner function
-       return changeDataInFile($FQFN, $comment, $prefix, $suffix, $DATA, $seek);
+       return changeDataInFile($FQFN, $comment, $prefix, $suffix, $inserted, $seek);
 }
 
 // Wrapper for changing entries in config-local.php
-function changeDataInLocalConfigurationFile ($comment, $prefix, $suffix, $DATA, $seek = 0) {
+function changeDataInLocalConfigurationFile ($comment, $prefix, $suffix, $inserted, $seek = 0) {
        // Call the inner function
-       return changeDataInInclude(getCachePath() . 'config-local.php', $comment, $prefix, $suffix, $DATA, $seek);
+       return changeDataInInclude(getCachePath() . 'config-local.php', $comment, $prefix, $suffix, $inserted, $seek);
 }
 
 // Shortens ucfirst(strtolower()) calls
@@ -2537,6 +2565,53 @@ function convertCommaToDotInPostDataArray ($postEntries) {
        } // END - foreach
 }
 
+/**
+ * Parses a string into a US formated float variable, taken from user comments
+ * from PHP documentation website.
+ *
+ * @param      $floatString    A string holding a float expression
+ * @return     $float                  Corresponding float variable
+ * @author     chris<at>georgakopoulos<dot>com
+ * @link       http://de.php.net/manual/en/function.floatval.php#92563
+ */
+function parseFloat ($floatString){
+    $LocaleInfo = localeconv();
+    $floatString = str_replace($LocaleInfo['mon_thousands_sep'] , '', $floatString);
+    $floatString = str_replace($LocaleInfo['mon_decimal_point'] , '.', $floatString);
+    return floatval($floatString);
+}
+
+// Generates a YES/NO option list from given default
+function generateYesNoOptionList ($default = '') {
+       // Generate it
+       return generateOptionList('/ARRAY/', array('Y', 'N'), array('{--YES--}', '{--NO--}'), $default);
+}
+
+// "Getter" for total available receivers
+function getTotalReceivers ($mode = 'normal') {
+       // Get num rows
+       $numRows = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true, ' AND `receive_mails` > 0' . runFilterChain('exclude_users', $mode));
+
+       // Return value
+       return $numRows;
+}
+
+// Wrapper "getter" to get total unconfirmed mails for given userid
+function getTotalUnconfirmedMails ($userid) {
+       // Do we have cache?
+       if (!isset($GLOBALS[__FUNCTION__][$userid])) {
+               // Determine it
+               $GLOBALS[__FUNCTION__][$userid] = countSumTotalData($userid, 'user_links', 'id', 'userid', true);
+       } // END - if
+
+       // Return cache
+       return $GLOBALS[__FUNCTION__][$userid];
+}
+
+//-----------------------------------------------------------------------------
+//                        Configuration wrapper
+//-----------------------------------------------------------------------------
+
 // Getter for 'check_double_email'
 function getCheckDoubleEmail () {
        // Is the cache entry set?
@@ -2549,7 +2624,7 @@ function getCheckDoubleEmail () {
        return $GLOBALS[__FUNCTION__];
 }
 
-// Checks wether 'check_double_email' is "YES"
+// Checks wether 'check_double_email' is 'Y'
 function isCheckDoubleEmailEnabled () {
        // Is the cache entry set?
        if (!isset($GLOBALS[__FUNCTION__])) {