Document Database::select()
authorAryeh Gregor <simetrical@users.mediawiki.org>
Fri, 29 Dec 2006 20:56:47 +0000 (20:56 +0000)
committerAryeh Gregor <simetrical@users.mediawiki.org>
Fri, 29 Dec 2006 20:56:47 +0000 (20:56 +0000)
includes/Database.php

index f2acd11..14764bd 100644 (file)
@@ -1008,6 +1008,14 @@ class Database {
 
        /**
         * SELECT wrapper
+        *
+        * @param mixed  $table   Array or string, table name(s) (prefix auto-added)
+        * @param mixed  $vars    Array or string, field name(s) to be retrieved
+        * @param mixed  $conds   Array or string, condition(s) for WHERE
+        * @param string $fname   Calling function name (use __METHOD__) for logs/profiling
+        * @param array  $options Associative array of options (e.g. array('GROUP BY' => 'page_title')),
+        *                        see Database::makeSelectOptions code for list of supported stuff
+        * @return mixed Database result resource (feed to Database::fetchObject or whatever), or false on failure
         */
        function select( $table, $vars, $conds='', $fname = 'Database::select', $options = array() )
        {