Minor cleanups/renaming

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

diff --git a/inc/wrapper-functions.php b/inc/wrapper-functions.php
index a89c49a676972c42d106c7e4548a8e29a71e84f3..87e0a3d01c6d74dfb401692f3a717b844f0462e6 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');
@@ -1052,6 +1061,7 @@ 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'
@@ -1068,6 +1078,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];
 }
 
@@ -2469,6 +2480,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 +2488,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 +2501,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
@@ -2553,6 +2566,33 @@ function parseFloat ($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
 //-----------------------------------------------------------------------------