Changeset 329

Timestamp:

May 6, 2008 9:11:59 AM (16 years ago)

Author:

quinn

Message:

Slight mods to Currency class.

File:

• trunk/lib/Currency.inc.php (modified) (5 diffs)

trunk/lib/Currency.inc.php

@@ -22 +22 @@
     // Configuration parameters for this object.
     var $_params = array(
-        'cache_result' => false,
+        'cache_result' => true,
         'cache_dir' => '',
         'cache_age' => 28800, // 8 hours.
@@ -47 +47 @@
         
         // Setup cache directory.
-        if ('' == $this->getParam('cache_dir')) {
-            // Use a sane default cache directory.
-            $this->setParam(array('cache_dir' => '/tmp/' . md5(COMMON_BASE)));
-        }
-        if (!is_dir($this->getParam('cache_dir'))) {
-            $app->logMsg(sprintf('Creating cache_dir: %s', $this->getParam('cache_dir')), LOG_INFO, __FILE__, __LINE__);                
-            if (!mkdir($this->getParam('cache_dir'))) {
-                $app->logMsg(sprintf('Could not create cache_dir: %s', $this->getParam('cache_dir')), LOG_WARNING, __FILE__, __LINE__);                
+        if ($this->getParam('cache_result')) {
+            if ('' == $this->getParam('cache_dir')) {
+                // Use a sane default cache directory.
+                $this->setParam(array('cache_dir' => '/tmp/xcache_' . md5(COMMON_BASE)));
+            }
+            if (!is_dir($this->getParam('cache_dir'))) {
+                $app->logMsg(sprintf('Creating cache_dir: %s', $this->getParam('cache_dir')), LOG_INFO, __FILE__, __LINE__);                
+                if (!mkdir($this->getParam('cache_dir'))) {
+                    $app->logMsg(sprintf('Could not create cache_dir: %s', $this->getParam('cache_dir')), LOG_WARNING, __FILE__, __LINE__);                
+                }
             }
         }
@@ -98 +100 @@
     *
     * @access   public
-    * @param    
-    * @return   
+    * @param    float   Base amount to convert from.
+    * @param    string  3-letter currency code to convert from.
+    * @param    string  3-letter currency code to convert to.
+    * @return   mixed   Float exchange rate value, or false on error. 
     * @author   Quinn Comendant <quinn@strangecode.com>
     * @version  1.0
@@ -112 +116 @@
         if (!$this->getParam('cache_result') || !$cache_file_mtime || $cache_file_mtime < time() - $this->getParam('cache_age')) {
             // Get fresh data and create cached file if missing or expired.
+            $app->logMsg(sprintf('Getting fresh currency exchange rates: %s-to-%s', $base, $target), LOG_DEBUG, __FILE__, __LINE__);
             $value = $this->_performAPICall('getValue', array(
                 'amount' => $amount,
@@ -117 +122 @@
                 'target' => $target
             ));
-            if (false !== $value) {
+            if (false === $value || !is_numeric($value)) {
                 // Failed retreiving SOAP value. Use cached copy for now.
-                $app->logMsg(sprintf('Failed getting SOAP currency value: %s-to-%s', $base, $target), LOG_NOTICE, __FILE__, __LINE__);
+                $app->logMsg(sprintf('Failed getting SOAP currency exchange rates: %s-to-%s, using cached copy', $base, $target), LOG_NOTICE, __FILE__, __LINE__);
                 if (!$value = file_get_contents($cache_file_path)) {
                     $app->logMsg(sprintf('Failed reading target rate file: %s', $cache_file_path), LOG_ERR, __FILE__, __LINE__);
+                    return false;
                 }
             } else if ($this->getParam('cache_result') && !file_put_contents($cache_file_path, $value, LOCK_EX)) {
                 $app->logMsg(sprintf('Failed writing to target rate file: %s', $cache_file_path), LOG_ERR, __FILE__, __LINE__);
+                return false;
             }
         } else {
+            $app->logMsg(sprintf('Getting cached currency exchange rates: %s-to-%s', $base, $target), LOG_DEBUG, __FILE__, __LINE__);
             if (!$value = file_get_contents($cache_file_path)) {
                 $app->logMsg(sprintf('Failed reading target rate file: %s', $cache_file_path), LOG_ERR, __FILE__, __LINE__);
+                return false;
             }
         }