]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - classes/Managed_DataObject.php
listFind throws NoResultException on no results
[quix0rs-gnu-social.git] / classes / Managed_DataObject.php
index 4ec8de669d3dd4abd39f43450e587dfd35e2d945..c005ce66624608263ccf699f992071387fdd6ebf 100644 (file)
@@ -28,7 +28,10 @@ abstract class Managed_DataObject extends Memcached_DataObject
     /**
      * The One True Thingy that must be defined and declared.
      */
-    public static abstract function schemaDef();
+    public static function schemaDef()
+    {
+        throw new MethodNotImplementedException(__METHOD__);
+    }
 
     /**
      * Get an instance by key
@@ -56,11 +59,25 @@ abstract class Managed_DataObject extends Memcached_DataObject
      * @return get_called_class() object if found, or null for no hits
      *
      */
-    static function pkeyGet($kv)
+    static function pkeyGet(array $kv)
     {
         return parent::pkeyGetClass(get_called_class(), $kv);
     }
 
+    /**
+     * Get multiple items from the database by key
+     *
+     * @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
+     */
+       static function multiGet($keyCol, array $keyVals, $skipNulls=true)
+       {
+           return parent::multiGetClass(get_called_class(), $keyCol, $keyVals, $skipNulls);
+       }
+
     /**
      * Get multiple items from the database by key
      *
@@ -79,16 +96,34 @@ abstract class Managed_DataObject extends Memcached_DataObject
      * Get a multi-instance object
      *
      * This is a utility method to get multiple instances with a given set of
+     * values for a specific column.
+     *
+     * @param string $keyCol  key column name
+     * @param array  $keyVals array of key values
+     *
+     * @return get_called_class() object with multiple instances if found,
+     *         Exception is thrown when no entries are found.
+     *
+     */
+    static function listFind($keyCol, array $keyVals)
+    {
+        return parent::listFindClass(get_called_class(), $keyCol, $keyVals);
+    }
+
+    /**
+     * Get a multi-instance object separated into an array
+     *
+     * This is a utility method to get multiple instances with a given set of
      * values for a specific key column. Usually used for the primary key when
-     * multiple values are desired.
+     * multiple values are desired. Result is an array.
      *
-     * @param array $keyCol  key column name
-     * @param array $keyVals array of key values
+     * @param string $keyCol  key column name
+     * @param array  $keyVals array of key values
      *
-     * @return get_called_class() object with multiple instances if found, or null for no hits
+     * @return array with an get_called_class() object for each $keyVals entry
      *
      */
-    static function listGet($keyCol, $keyVals)
+    static function listGet($keyCol, array $keyVals)
     {
         return parent::listGetClass(get_called_class(), $keyCol, $keyVals);
     }