Merge branch 'master' of git.gnu.io:gnu/gnu-social into nightly

[quix0rs-gnu-social.git] / classes / Managed_DataObject.php

diff --git a/classes/Managed_DataObject.php b/classes/Managed_DataObject.php
index b324984b7f8e7512d4c8b77606654ca6b10b8ae2..5f8445d81e641b7f595a415f185100c48bbb4580 100644 (file)
--- a/classes/Managed_DataObject.php
+++ b/classes/Managed_DataObject.php
@@ -64,6 +64,11 @@ abstract class Managed_DataObject extends Memcached_DataObject
         return parent::pkeyGetClass(get_called_class(), $kv);
     }
 
+    static function pkeyCols()
+    {
+        return parent::pkeyColsClass(get_called_class());
+    }
+
     /**
      * Get multiple items from the database by key
      *
@@ -304,6 +309,88 @@ abstract class Managed_DataObject extends Memcached_DataObject
         return common_database_tablename($this->tableName());
     }
 
+    /**
+     * Returns an object by looking at the primary key column(s).
+     *
+     * Will require all primary key columns to be defined in an associative array
+     * and ignore any keys which are not part of the primary key.
+     *
+     * Will NOT accept NULL values as part of primary key.
+     *
+     * @param   array   $vals       Must match all primary key columns for the dataobject.
+     *
+     * @return  Managed_DataObject  of the get_called_class() type
+     * @throws  NoResultException   if no object with that primary key
+     */
+    static function getByPK(array $vals)
+    {
+        $classname = get_called_class();
+
+        $pkey = static::pkeyCols();
+        if (is_null($pkey)) {
+            throw new ServerException("Failed to get primary key columns for class '{$classname}'");
+        }
+
+        $object = new $classname();
+        foreach ($pkey as $col) {
+            if (!array_key_exists($col, $vals)) {
+                throw new ServerException("Missing primary key column '{$col}' for ".get_called_class()." among provided keys: ".implode(',', array_keys($vals)));
+            } elseif (is_null($vals[$col])) {
+                throw new ServerException("NULL values not allowed in getByPK for column '{$col}'");
+            }
+            $object->$col = $vals[$col];
+        }
+        if (!$object->find(true)) {
+            throw new NoResultException($object);
+        }
+        return $object;
+    }
+
+    /**
+     * Returns an object by looking at given unique key columns.
+     *
+     * Will NOT accept NULL values for a unique key column. Ignores non-key values.
+     *
+     * @param   array   $vals       All array keys which are set must be non-null.
+     *
+     * @return  Managed_DataObject  of the get_called_class() type
+     * @throws  NoResultException   if no object with that primary key
+     */
+    static function getByKeys(array $vals)
+    {
+        $classname = get_called_class();
+
+        $object = new $classname();
+
+        $keys = $object->keys();
+        if (is_null($keys)) {
+            throw new ServerException("Failed to get key columns for class '{$classname}'");
+        }
+
+        foreach ($keys as $col) {
+            if (!array_key_exists($col, $vals)) {
+                continue;
+            } elseif (is_null($vals[$col])) {
+                throw new ServerException("NULL values not allowed in getByPK for column '{$col}'");
+            }
+            $object->$col = $vals[$col];
+        }
+        if (!$object->find(true)) {
+            throw new NoResultException($object);
+        }
+        return $object;
+    }
+
+    static function getByID($id)
+    {
+        if (empty($id)) {
+            throw new ServerException('Empty ID on lookup');
+        }
+        // getByPK throws exception if id is null
+        // or if the class does not have a single 'id' column as primary key
+        return static::getByPK(array('id' => $id));
+    }
+
     /**
      * Returns an ID, checked that it is set and reasonably valid
      *
@@ -354,7 +441,7 @@ abstract class Managed_DataObject extends Memcached_DataObject
                 common_log_db_error($this, 'UPDATE', __FILE__);
                 // rollback as something bad occurred
                 $this->query('ROLLBACK');
-                throw new ServerException("Could not UPDATE non-keys for {$this->__table}");
+                throw new ServerException("Could not UPDATE non-keys for {$this->tableName()}");
             }
             $orig->decache();
             $this->encache();
@@ -376,7 +463,7 @@ abstract class Managed_DataObject extends Memcached_DataObject
             common_log_db_error($this, 'UPDATE', __FILE__);
             // rollback as something bad occurred
             $this->query('ROLLBACK');
-            throw new ServerException("Could not UPDATE key fields for {$this->__table}");
+            throw new ServerException("Could not UPDATE key fields for {$this->tableName()}");
         }
 
         // Update non-keys too, if the previous endeavour worked.
@@ -386,7 +473,7 @@ abstract class Managed_DataObject extends Memcached_DataObject
             common_log_db_error($this, 'UPDATE', __FILE__);
             // rollback as something bad occurred
             $this->query('ROLLBACK');
-            throw new ServerException("Could not UPDATE non-keys for {$this->__table}");
+            throw new ServerException("Could not UPDATE non-keys for {$this->tableName()}");
         }
         $orig->decache();
         $this->encache();
@@ -401,4 +488,16 @@ abstract class Managed_DataObject extends Memcached_DataObject
     {
         // NOOP
     }
+
+    static function newUri(Profile $actor, Managed_DataObject $object, $created=null)
+    {
+        if (is_null($created)) {
+            $created = common_sql_now();
+        }
+        return TagURI::mint(strtolower(get_called_class()).':%d:%s:%d:%s',
+                                        $actor->getID(),
+                                        ActivityUtils::resolveUri($object->getObjectType(), true),
+                                        $object->getID(),
+                                        common_date_iso8601($created));
+    }
 }