]> git.mxchange.org Git - mailer.git/blobdiff - inc/libs/yoomedia_functions.php
Code style changed, ext-user continued:
[mailer.git] / inc / libs / yoomedia_functions.php
index 8a9889d3ead598d0fffc4223276c617cc6890625..213b7fab04e99d8e043d950e5faca774a062fee2 100644 (file)
@@ -16,7 +16,7 @@
  * $Author::                                                          $ *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
+ * Copyright (c) 2009 - 2012 by Mailer Developer Team                   *
  * For more information visit: http://mxchange.org                      *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -41,12 +41,12 @@ if (!defined('__SECURITY')) {
 } // END - if
 
 // Queries the given Yoo!Media API 2.0 script
-function YOOMEDIA_QUERY_API ($script, $countQuery = true) {
+function YOOMEDIA_QUERY_API ($script, $countQuery = TRUE) {
        // Init response array
        $response = array();
 
        // Enougth queries left?
-       if ((getConfig('yoomedia_requests_remain') > 0) || ($countQuery === false)) {
+       if ((getConfig('yoomedia_requests_remain') > 0) || ($countQuery === FALSE)) {
                // Prepare request array
                $requestData = array(
                        'id'         => getConfig('yoomedia_id'),
@@ -60,7 +60,7 @@ function YOOMEDIA_QUERY_API ($script, $countQuery = true) {
                );
 
                // Run the query
-               $response = sendGetRequest('http://www.yoomedia.de/interface_2.0/' . $script, $requestData, true);
+               $response = sendGetRequest('http://www.yoomedia.de/interface_2.0/' . $script, $requestData, TRUE);
 
                // Convert from ISO to UTF-8 only if count is > 3 because <= 3 means timeout
                if (count($response) > 3) {
@@ -72,7 +72,7 @@ function YOOMEDIA_QUERY_API ($script, $countQuery = true) {
                } // END - if
 
                // Shall we count the query as used?
-               if ($countQuery === true) {
+               if ($countQuery === TRUE) {
                        // Then update the config!
                        updateConfiguration('yoomedia_requests_remain', 1, '-');
                } // END - if
@@ -87,7 +87,7 @@ function YOOMEDIA_TEST_CONFIG ($data) {
        // Is this admin?
        if (!isAdmin()) {
                // No admin!
-               return false;
+               return FALSE;
        } // END - if
 
        // Remove 'ok'
@@ -105,7 +105,7 @@ function YOOMEDIA_TEST_CONFIG ($data) {
 
        // Query the API with a test request without couting it
        // If zero reply comes back the data is invalid!
-       $response = YOOMEDIA_QUERY_API('out_textmail.php', true); // @TODO Ask Yoo!Media for test script
+       $response = YOOMEDIA_QUERY_API('out_textmail.php', TRUE); // @TODO Ask Yoo!Media for test script
 
        // Default error code is 0 = all fine!
        $errorCode = YOOMEDIA_GET_ERRORCODE_FROM_RESULT($response);
@@ -127,7 +127,7 @@ function YOOMEDIA_TEST_CONFIG ($data) {
                $errorCode = '0';
        }
 
-       // Do we have some data there?
+       // Is some data there?
        return ($errorCode == '0');
 }
 
@@ -160,12 +160,12 @@ function YOOMEDIA_PARSE_RESPONSE ($response, $type) {
        // If we have no result, abort here
        if (count($dummy) == 0) {
                // Empty response from API
-               debug_report_bug(__FUNCTION__, __LINE__, 'Empty result from API received. response()=' . count($response) . ',type=' . $type);
+               reportBug(__FUNCTION__, __LINE__, 'Empty result from API received. response()=' . count($response) . ',type=' . $type);
                return array();
        } // END - if
 
        // The result is now still raw, so we must split it up and trim spaces away
-       $responseLine = trim(implode("\n", $dummy));
+       $responseLine = trim(implode(chr(10), $dummy));
 
        // Last line should never be a pipe!
        if (substr($responseLine, -1, 1) == '|') {
@@ -201,34 +201,38 @@ function YOOMEDIA_PREPARE_MAIL_DELIVERY ($data) {
        // Is this an admin?
        if (!isAdmin()) {
                // Abort here
-               return false;
+               return FALSE;
        } elseif (!isExtensionActive('bonus')) {
                // Abort here
-               return false;
+               return FALSE;
        }
 
        // Is the waiting time below one second? Then fix it to one (zero seconds are not yet supported!)
-       if ($data['wait'] < 1) $data['wait'] = 1;
+       if ($data['wait'] < 1) {
+               $data['wait'] = 1;
+       } // END - if
 
        // Half of waiting time is a good reward!
        $data['reward'] = round($data['wait'] / 2 + 0.4);
 
        // Is the reward below one?
-       if ($data['reward'] < 1) $data['reward'] = 1;
+       if ($data['reward'] < 1) {
+               $data['reward'] = 1;
+       } // END - if
 
        // Load template
-       loadTemplate('admin_send_yoomedia', false, $data);
+       loadTemplate('admin_send_yoomedia', FALSE, $data);
 }
 
 // Adds the mail to the bonus mail pool
-function YOOMEDIA_SEND_BONUS_MAIL ($data, $mode) {
+function YOOMEDIA_SEND_BONUS_MAIL ($data, $mailMode) {
        // Is this an admin?
        if (!isAdmin()) {
                // Abort here
-               return false;
+               return FALSE;
        } elseif (!isExtensionActive('bonus')) {
                // Abort here
-               return false;
+               return FALSE;
        }
 
        // Add dummy receiver to avoid notice
@@ -236,7 +240,7 @@ function YOOMEDIA_SEND_BONUS_MAIL ($data, $mode) {
 
        // HTML or normal? (normal is default...)
        $type = 't';
-       if (($mode == 'html') && (isExtensionActive('html_mail'))) $type = 'h';
+       if (($mailMode == 'html') && (isExtensionActive('html_mail'))) $type = 'h';
 
        // Auto-generate URL
        $data['url'] = sprintf("http://www.yoomedia.de/code/%s-mail.php?id=%s&sid=%s",
@@ -246,23 +250,23 @@ function YOOMEDIA_SEND_BONUS_MAIL ($data, $mode) {
        );
 
        // Lock this mail for new delivery
-       YOOMEDIA_RELOAD_LOCK($data, $mode);
+       YOOMEDIA_RELOAD_LOCK($data, $mailMode);
 
        // Call the lower function
-       addNewBonusMail($data, $mode);
+       addNewBonusMail($data, $mailMode);
 }
 
 // Lockdown given id
-function YOOMEDIA_EXCLUDE_MAIL ($data, $mode) {
+function YOOMEDIA_EXCLUDE_MAIL ($data, $mailMode) {
        // Search for the entry
-       if (YOOMEDIA_CHECK_RELOAD($data['id'], $data['reload'], $mode) === false) {
+       if (YOOMEDIA_CHECK_RELOAD($data['id'], $data['reload'], $mailMode) === FALSE) {
                // Convert mode for mails
-               $mode = YOOMEDIA_CONVERT_MODE($mode);
+               $mailMode = YOOMEDIA_CONVERT_MODE($mailMode);
 
                // Add the entry
-               SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_yoomedia_reload` (`type`,`y_id`,`y_reload`,`inserted`) VALUES ('%s',%s,%s,'0000-00-00 00:00')",
+               SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_yoomedia_reload` (`type`, `y_id`, `y_reload`, `inserted`) VALUES ('%s',%s,%s,'0000-00-00 00:00')",
                        array(
-                               $mode,
+                               $mailMode,
                                bigintval($data['id']),
                                bigintval($data['reload'])
                        ), __FUNCTION__, __LINE__);
@@ -270,13 +274,13 @@ function YOOMEDIA_EXCLUDE_MAIL ($data, $mode) {
 }
 
 // Remove lock of given mail
-function YOOMEDIA_UNLIST_MAIL ($data, $mode) {
+function YOOMEDIA_UNLIST_MAIL ($data, $mailMode) {
        // Convert mode for mails
-       $mode = YOOMEDIA_CONVERT_MODE($mode);
+       $mailMode = YOOMEDIA_CONVERT_MODE($mailMode);
 
        // Add the entry
        SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_yoomedia_reload` WHERE `type`='%s' AND `y_id`=%s LIMIT 1",
-               array($mode, bigintval($data['id'])), __FUNCTION__, __LINE__);
+               array($mailMode, bigintval($data['id'])), __FUNCTION__, __LINE__);
 }
 
 // "Translates" the index number into an assosiative value
@@ -308,7 +312,7 @@ function translateYooMediaError ($errorCode) {
                $return = $GLOBALS['translation_tables']['yoomedia']['error_codes'][$errorCode];
        } else {
                // Log missing entries
-               debug_report_bug(__FUNCTION__, __LINE__, sprintf("Unknown error code <strong>%s[%s]</strong> detected.", $errorCode, gettype($errorCode)));
+               reportBug(__FUNCTION__, __LINE__, sprintf("Unknown error code <strong>%s[%s]</strong> detected.", $errorCode, gettype($errorCode)));
        }
 
        // Return value
@@ -318,7 +322,7 @@ function translateYooMediaError ($errorCode) {
 // Checks if the mail id is in reload lock
 function YOOMEDIA_CHECK_RELOAD ($id, $reload, $type) {
        // Default is not in reload lock
-       $reloaded = false;
+       $reloaded = FALSE;
 
        // Query database
        $result = SQL_QUERY_ESC("SELECT `id`, UNIX_TIMESTAMP(`inserted`) AS inserted FROM `{?_MYSQL_PREFIX?}_yoomedia_reload` WHERE `type`='%s' AND `y_id`=%s LIMIT 1",
@@ -348,33 +352,33 @@ function YOOMEDIA_CHECK_RELOAD ($id, $reload, $type) {
 }
 
 // Lock given mail down for reload lock
-function YOOMEDIA_RELOAD_LOCK ($data, $mode) {
+function YOOMEDIA_RELOAD_LOCK ($data, $mailMode) {
        // Search for the entry
-       if (YOOMEDIA_CHECK_RELOAD($data['id'], $data['reload'], $mode) === false) {
+       if (YOOMEDIA_CHECK_RELOAD($data['id'], $data['reload'], $mailMode) === FALSE) {
                // Convert mode for mails
-               $mode = YOOMEDIA_CONVERT_MODE($mode);
+               $mailMode = YOOMEDIA_CONVERT_MODE($mailMode);
 
                // Add the entry
-               SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_yoomedia_reload` (`type`,`y_id`,`y_reload`) VALUES ('%s',%s,%s)",
-                       array($mode, bigintval($data['id']), bigintval($data['reload'])), __FUNCTION__, __LINE__);
+               SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_yoomedia_reload` (`type`, `y_id`, `y_reload`) VALUES ('%s',%s,%s)",
+                       array($mailMode, bigintval($data['id']), bigintval($data['reload'])), __FUNCTION__, __LINE__);
        } // END - if
 }
 
 // Convert mode for mails
-function YOOMEDIA_CONVERT_MODE ($mode) {
+function YOOMEDIA_CONVERT_MODE ($mailMode) {
        // Convert mode for normal/html
-       switch ($mode) {
+       switch ($mailMode) {
                case 'normal':
-                       $mode = 'textmail';
+                       $mailMode = 'textmail';
                        break;
 
                case 'html':
-                       $mode = 'htmlmail';
+                       $mailMode = 'htmlmail';
                        break;
        } // END - switch
 
        // Return result
-       return $mode;
+       return $mailMode;
 }
 
 // Extract code from response
@@ -410,11 +414,11 @@ function YOOMEDIA_GET_ERRORCODE_FROM_RESULT ($response) {
                        $code = $codeArray[0];
 
                        // Remove all new-line characters
-                       $codeArray = explode("\n", $code);
+                       $codeArray = explode(chr(10), $code);
                        $code = $codeArray[0];
 
                        // Remove carrige-return
-                       $code = trim(str_replace("\n", '', $code));
+                       $code = trim(str_replace(chr(10), '', $code));
 
                        // Is it still empty?
                        if (empty($code)) {
@@ -427,7 +431,7 @@ function YOOMEDIA_GET_ERRORCODE_FROM_RESULT ($response) {
                $code = '0';
        } else {
                // Should not happen!
-               debug_report_bug(__FUNCTION__, __LINE__, 'Cannot parse response. Raw response:<pre>' . print_r($response, true) . '</pre>');
+               reportBug(__FUNCTION__, __LINE__, 'Cannot parse response. Raw response:<pre>' . print_r($response, TRUE) . '</pre>');
        }
 
        // Return error code