cvs: pear /MDB_QueryTool/QueryTool Query.php

quipo Fri Jun 13 13:32:31 2003 EDT Modified files: /pear/MDB_QueryTool/QueryTool Query.php Log: some phpdoc fixes Index: pear/MDB_QueryTool/QueryTool/Query.php diff -u pear/MDB_QueryTool/QueryTool/Query.php:1.11 pear/MDB_QueryTool/QueryTool/Query.php:1.12 --- pear/MDB_QueryTool/QueryTool/Query.php:1.11 Tue Jun 10 11:02:16 2003 +++ pear/MDB_QueryTool/QueryTool/Query.php Fri Jun 13 13:32:31 2003 @@ -15,7 +15,7 @@ // | Author: Lorenzo Alberton <l.alberton at quipo.it> | // +----------------------------------------------------------------------+ // -// $Id: Query.php,v 1.11 2003/06/10 15:02:16 quipo Exp $ +// $Id: Query.php,v 1.12 2003/06/13 17:32:31 quipo Exp $ // // This is just a port of DB_QueryTool, originally written by // Wolfram Kriesing and Paolo Panto, vision:produktion <wk@visionp.de> @@ -345,7 +345,6 @@ /** * get the number of entries * - * @param * @return mixed an array of the retreived data, or false in case of failure * when failing an error is set in $this->_error * @access public @@ -569,7 +568,7 @@ /** * empty a table * - * @return + * @return resultSet or false on error [execute() result] * @access public */ function removeAll() @@ -582,7 +581,7 @@ * remove the datasets with the given ids * * @param array the ids to remove - * @return + * @return resultSet or false on error [execute() result] * @access public */ function removeMultiple($ids, $colName='') @@ -1142,9 +1141,9 @@ /** * !!!! query COPIED FROM db_oci8.inc - from PHPLIB !!!! * - * @see - * @param - * @return + * @see db_oci8.inc - PHPLIB + * @param string $table + * @return resultSet or false on error * @access public */ function metadata($table='') @@ -1427,8 +1426,8 @@ /** * - * @param - * @return + * @param string $where WHERE clause + * @return string $where WHERE clause after processing * @access public */ function _buildWhere($where='') @@ -1480,8 +1479,7 @@ /** * - * @param - * @return + * @return string $order * @access public */ function _buildOrder() @@ -1519,7 +1517,7 @@ * * * @return string the having clause - * @access public + * @access public */ function _buildHaving() { @@ -1537,7 +1535,7 @@ * * @param array this array contains the elements of the query, * indexed by their key, which are: 'select','from','where', etc. - * @return + * @return string $querystring or false on error * @access public */ function _buildSelectQuery($query=array()) @@ -1614,8 +1612,9 @@ /** * - * @param - * @return + * @param string $query + * @param string method + * @return resultSet or false on error * @access public */ function execute($query=null, $method='getAll') @@ -1645,8 +1644,7 @@ $this->writeLog('end query'); } - $res = $this->_makeIndexed($res); - return $res; + return $this->_makeIndexed($res); } /** @@ -1654,7 +1652,8 @@ * * It does some additional work, like time measuring etc. to * see some additional info - * + * + * @param string $text */ function writeLog($text='START') { @@ -1710,11 +1709,11 @@ /** * * - * @param - * @return + * @param resultSet reference + * @return MDB_QueryTool_Result if "useResult"==TRUE, the $result otherwise * @access public */ - function returnResult( &$result ) + function returnResult(&$result) { if($this->_useResult) { if($result == false) { @@ -1727,8 +1726,8 @@ /** * - * @param - * @return + * @param mixed $data + * @return mixed $data or array $indexedData * @access public */ function &_makeIndexed(&$data) @@ -1773,11 +1772,10 @@ * index might be '1,2' or '2108,29389' this way you can access data which * have 2 primary keys. Be sure to remember that the index is a string! * - * @param - * @return + * @param string $key * @access public */ - function setIndex( $key=null ) + function setIndex($key=null) { if($this->getJoin()) { // is join set? @@ -1799,8 +1797,7 @@ /** * - * @param - * @return + * @return string index * @access public */ function getIndex() @@ -1810,8 +1807,7 @@ /** * - * @param - * @return + * @param boolean * @access public */ function useResult($doit=true)