New Managed_DataObject retrieval: listFind

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

diff --git a/classes/Managed_DataObject.php b/classes/Managed_DataObject.php
index 0e328b151416e20b4a29268f8be3be419d31b62e..80210dc8a32179ca3fdc98f9a346f229c086ce66 100644 (file)
--- a/classes/Managed_DataObject.php
+++ b/classes/Managed_DataObject.php
@@ -93,13 +93,31 @@ 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 in 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 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, array $keyVals)