]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - classes/Memcached_DataObject.php
pkeyGet is now static and more similar to getKV
[quix0rs-gnu-social.git] / classes / Memcached_DataObject.php
index e515e3d9e0abd6c87e0fb71b880bd2492471e335..8460931fcce341ab981ab41913ad872b5f260f94 100644 (file)
@@ -30,15 +30,16 @@ class Memcached_DataObject extends Safe_DataObject
      * @param mixed $v key field value, or leave out for primary key lookup
      * @return mixed Memcached_DataObject subtype or false
      */
-    function &staticGet($cls, $k, $v=null)
+    static function getClassKV($cls, $k, $v=null)
     {
         if (is_null($v)) {
             $v = $k;
-            // XXX: HACK!
-            $i = new $cls;
-            $keys = $i->keys();
+            $keys = self::pkeyCols($cls);
+            if (count($keys) > 1) {
+                // FIXME: maybe call pkeyGetClass() ourselves?
+                throw new Exception('Use pkeyGetClass() for compound primary keys');
+            }
             $k = $keys[0];
-            unset($i);
         }
         $i = Memcached_DataObject::getcached($cls, $k, $v);
         if ($i === false) { // false == cache miss
@@ -63,44 +64,44 @@ class Memcached_DataObject extends Safe_DataObject
         }
         return $i;
     }
-    
+
     /**
      * Get multiple items from the database by key
-     * 
+     *
      * @param string  $cls       Class to fetch
      * @param string  $keyCol    name of column for key
      * @param array   $keyVals   key values to fetch
      * @param boolean $skipNulls return only non-null results?
-     * 
+     *
      * @return array Array of objects, in order
      */
     function multiGet($cls, $keyCol, $keyVals, $skipNulls=true)
     {
-       $result = self::pivotGet($cls, $keyCol, $keyVals);
-       
-       $values = array_values($result);
-       
-       if ($skipNulls) {
-               $tmp = array();
-               foreach ($values as $value) {
-                       if (!empty($value)) {
-                               $tmp[] = $value;
-                       }
-               }
-               $values = $tmp;
-       }
-       
-       return new ArrayWrapper($values);
-    }
-    
+        $result = self::pivotGet($cls, $keyCol, $keyVals);
+
+        $values = array_values($result);
+
+        if ($skipNulls) {
+            $tmp = array();
+            foreach ($values as $value) {
+                if (!empty($value)) {
+                    $tmp[] = $value;
+                }
+            }
+            $values = $tmp;
+        }
+
+        return new ArrayWrapper($values);
+    }
+
     /**
      * Get multiple items from the database by key
-     * 
+     *
      * @param string  $cls       Class to fetch
      * @param string  $keyCol    name of column for key
      * @param array   $keyVals   key values to fetch
      * @param boolean $otherCols Other columns to hold fixed
-     * 
+     *
      * @return array Array mapping $keyVals to objects, or null if not found
      */
     static function pivotGet($cls, $keyCol, $keyVals, $otherCols = array())
@@ -112,10 +113,10 @@ class Memcached_DataObject extends Safe_DataObject
         } else {
             $result = array_fill_keys($keyVals, null);
         }
-       
-       $toFetch = array();
-       
-       foreach ($keyVals as $keyVal) {
+
+        $toFetch = array();
+
+        foreach ($keyVals as $keyVal) {
 
             if (is_array($keyCol)) {
                 $kv = array_combine($keyCol, $keyVal);
@@ -123,25 +124,26 @@ class Memcached_DataObject extends Safe_DataObject
                 $kv = array($keyCol => $keyVal);
             }
 
-               $kv = array_merge($otherCols, $kv);
-               
-               $i = self::multicache($cls, $kv);
-               
-               if ($i !== false) {
+            $kv = array_merge($otherCols, $kv);
+
+            $i = self::multicache($cls, $kv);
+
+            if ($i !== false) {
                 if (is_array($keyCol)) {
                     $result[implode(',', $keyVal)] = $i;
                 } else {
                     $result[$keyVal] = $i;
                 }
-               } else if (!empty($keyVal)) {
-                       $toFetch[] = $keyVal;
-               }
-       }
-        
-       if (count($toFetch) > 0) {
+            } else if (!empty($keyVal)) {
+                $toFetch[] = $keyVal;
+            }
+        }
+
+        if (count($toFetch) > 0) {
             $i = DB_DataObject::factory($cls);
             if (empty($i)) {
-               throw new Exception(_('Cannot instantiate class ' . $cls));
+                // TRANS: Exception thrown when a program code class (%s) cannot be instantiated.
+                throw new Exception(sprintf(_('Cannot instantiate class %s.'),$cls));
             }
             foreach ($otherCols as $otherKeyCol => $otherKeyVal) {
                 $i->$otherKeyCol = $otherKeyVal;
@@ -151,10 +153,10 @@ class Memcached_DataObject extends Safe_DataObject
             } else {
                 $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
             }
-               if ($i->find()) {
-                       while ($i->fetch()) {
-                               $copy = clone($i);
-                               $copy->encache();
+            if ($i->find()) {
+                while ($i->fetch()) {
+                    $copy = clone($i);
+                    $copy->encache();
                     if (is_array($keyCol)) {
                         $vals = array();
                         foreach ($keyCol as $k) {
@@ -164,36 +166,36 @@ class Memcached_DataObject extends Safe_DataObject
                     } else {
                         $result[$i->$keyCol] = $copy;
                     }
-                       }
-               }
-               
-               // Save state of DB misses
-               
-               foreach ($toFetch as $keyVal) {
+                }
+            }
+
+            // Save state of DB misses
+
+            foreach ($toFetch as $keyVal) {
                 $r = null;
                 if (is_array($keyCol)) {
                     $r = $result[implode(',', $keyVal)];
                 } else {
                     $r = $result[$keyVal];
                 }
-                       if (empty($r)) {
+                if (empty($r)) {
                     if (is_array($keyCol)) {
                         $kv = array_combine($keyCol, $keyVal);
                     } else {
                         $kv = array($keyCol => $keyVal);
                     }
                     $kv = array_merge($otherCols, $kv);
-                       // save the fact that no such row exists
-                       $c = self::memcache();
-                       if (!empty($c)) {
-                       $ck = self::multicacheKey($cls, $kv);
-                       $c->set($ck, null);
-                       }       
-                       }
-               }
-       }
+                    // save the fact that no such row exists
+                    $c = self::memcache();
+                    if (!empty($c)) {
+                        $ck = self::multicacheKey($cls, $kv);
+                        $c->set($ck, null);
+                    }
+                }
+            }
+        }
 
-       return $result;
+        return $result;
     }
 
     static function _inMultiKey($i, $cols, $values)
@@ -248,7 +250,8 @@ class Memcached_DataObject extends Safe_DataObject
     {
         $i = DB_DataObject::factory($cls);
         if (empty($i)) {
-            throw new Exception(_('Cannot instantiate a ' . $cls));
+            // TRANS: Exception thrown when a program code class (%s) cannot be instantiated.
+            throw new Exception(sprintf(_('Cannot instantiate class %s.'),$cls));
         }
         $types = $i->keyTypes();
         ksort($types);
@@ -266,27 +269,27 @@ class Memcached_DataObject extends Safe_DataObject
 
     function listGet($cls, $keyCol, $keyVals)
     {
-       $pkeyMap = array_fill_keys($keyVals, array());
+        $pkeyMap = array_fill_keys($keyVals, array());
         $result = array_fill_keys($keyVals, array());
 
         $pkeyCols = self::pkeyCols($cls);
 
-       $toFetch = array();
+        $toFetch = array();
         $allPkeys = array();
 
         // We only cache keys -- not objects!
 
-       foreach ($keyVals as $keyVal) {
-           $l = self::cacheGet(sprintf("%s:list-ids:%s:%s", $cls, $keyCol, $keyVal));
-           if ($l !== false) {
-               $pkeyMap[$keyVal] = $l;
+        foreach ($keyVals as $keyVal) {
+            $l = self::cacheGet(sprintf("%s:list-ids:%s:%s", strtolower($cls), $keyCol, $keyVal));
+            if ($l !== false) {
+                $pkeyMap[$keyVal] = $l;
                 foreach ($l as $pkey) {
                     $allPkeys[] = $pkey;
                 }
-           } else {
-               $toFetch[] = $keyVal;
-           }
-       }
+            } else {
+                $toFetch[] = $keyVal;
+            }
+        }
 
         if (count($allPkeys) > 0) {
             $keyResults = self::pivotGet($cls, $pkeyCols, $allPkeys);
@@ -302,10 +305,11 @@ class Memcached_DataObject extends Safe_DataObject
         }
 
         if (count($toFetch) > 0) {
-               $i = DB_DataObject::factory($cls);
-               if (empty($i)) {
-                       throw new Exception(_('Cannot instantiate class ' . $cls));
-               }
+            $i = DB_DataObject::factory($cls);
+            if (empty($i)) {
+                // TRANS: Exception thrown when a program code class (%s) cannot be instantiated.
+                throw new Exception(sprintf(_('Cannot instantiate class %s.'),$cls));
+            }
             $i->whereAddIn($keyCol, $toFetch, $i->columnType($keyCol));
             if ($i->find()) {
                 sprintf("listGet() got {$i->N} results for class $cls key $keyCol");
@@ -319,36 +323,36 @@ class Memcached_DataObject extends Safe_DataObject
                     }
                     $pkeyMap[$i->$keyCol][] = $pkeyVal;
                 }
-            }       
-               foreach ($toFetch as $keyVal) {
-                self::cacheSet(sprintf("%s:list-ids:%s:%s", $cls, $keyCol, $keyVal),
+            }
+            foreach ($toFetch as $keyVal) {
+                self::cacheSet(sprintf("%s:list-ids:%s:%s", strtolower($cls), $keyCol, $keyVal),
                                $pkeyMap[$keyVal]);
-            }      
-        }
-
-       return $result;        
-    }
-
-       function columnType($columnName)
-       {
-               $keys = $this->table();
-               if (!array_key_exists($columnName, $keys)) {
-                       throw new Exception('Unknown key column ' . $columnName . ' in ' . join(',', array_keys($keys)));
-               }
-               
-               $def = $keys[$columnName];
-               
-               if ($def & DB_DATAOBJECT_INT) {
-                       return 'integer';
-               } else {
-                       return 'string';
-               }
-       }
-       
+            }
+        }
+
+        return $result;
+    }
+
+    function columnType($columnName)
+    {
+        $keys = $this->table();
+        if (!array_key_exists($columnName, $keys)) {
+            throw new Exception('Unknown key column ' . $columnName . ' in ' . join(',', array_keys($keys)));
+        }
+
+        $def = $keys[$columnName];
+
+        if ($def & DB_DATAOBJECT_INT) {
+            return 'integer';
+        } else {
+            return 'string';
+        }
+    }
+
     /**
-     * @fixme Should this return false on lookup fail to match staticGet?
+     * @todo FIXME: Should this return false on lookup fail to match getKV?
      */
-    function pkeyGet($cls, $kv)
+    static function pkeyGetClass($cls, $kv)
     {
         $i = Memcached_DataObject::multicache($cls, $kv);
         if ($i !== false) { // false == cache miss
@@ -359,13 +363,13 @@ class Memcached_DataObject extends Safe_DataObject
                 return false;
             }
             foreach ($kv as $k => $v) {
-               if (is_null($v)) {
-                       // XXX: possible SQL injection...? Don't 
-                       // pass keys from the browser, eh.
-                       $i->whereAdd("$k is null");
-               } else {
-                       $i->$k = $v;
-               }
+                if (is_null($v)) {
+                    // XXX: possible SQL injection...? Don't
+                    // pass keys from the browser, eh.
+                    $i->whereAdd("$k is null");
+                } else {
+                    $i->$k = $v;
+                }
             }
             if ($i->find(true)) {
                 $i->encache();
@@ -676,8 +680,10 @@ class Memcached_DataObject extends Safe_DataObject
                         'delete',
                         'update',
                         'find');
-        $ignoreStatic = array('staticGet',
+        $ignoreStatic = array('getKV',
+                              'getClassKV',
                               'pkeyGet',
+                              'pkeyGetClass',
                               'cachedQuery');
         $here = get_class($this); // if we get confused
         $bt = debug_backtrace();
@@ -696,7 +702,7 @@ class Memcached_DataObject extends Safe_DataObject
                     continue;
                 }
                 if (in_array($func, $ignoreStatic)) {
-                    continue; // @fixme this shouldn't be needed?
+                    continue; // @todo FIXME: This shouldn't be needed?
                 }
                 $here = get_class($frame['object']) . '->' . $func;
                 break;
@@ -839,7 +845,7 @@ class Memcached_DataObject extends Safe_DataObject
 
         if (!$dsn) {
             // TRANS: Exception thrown when database name or Data Source Name could not be found.
-            throw new Exception(_("No database name or DSN found anywhere."));
+            throw new Exception(_('No database name or DSN found anywhere.'));
         }
 
         return $dsn;