From fddd92a3751edafaf51ca54e7ae8ea7af153f8df Mon Sep 17 00:00:00 2001 From: "Timothy J. Warren" Date: Wed, 23 Apr 2014 16:27:43 -0400 Subject: [PATCH] Fix some more docblocks --- core/abstract/abstract_table.php | 2 +- core/interfaces/query_builder_interface.php | 30 ++++++++++----------- core/query_parser.php | 4 +-- drivers/firebird/firebird_result.php | 2 +- drivers/sqlite/sqlite_sql.php | 6 ++--- 5 files changed, 22 insertions(+), 22 deletions(-) diff --git a/core/abstract/abstract_table.php b/core/abstract/abstract_table.php index 26e35bc..9efdd92 100644 --- a/core/abstract/abstract_table.php +++ b/core/abstract/abstract_table.php @@ -87,7 +87,7 @@ abstract class Abstract_Table { * Setters * @param mixed $name * @param mixed $val - * @return \Query\Table_Column + * @return Abstract_Table */ public function __set($name, $val) { diff --git a/core/interfaces/query_builder_interface.php b/core/interfaces/query_builder_interface.php index c373ee1..c411468 100644 --- a/core/interfaces/query_builder_interface.php +++ b/core/interfaces/query_builder_interface.php @@ -41,7 +41,7 @@ interface Query_Builder_Interface { * Selects the maximum value of a field from a query * * @param string $field - * @param string $as + * @param string|bool $as * @return Query_Builder */ public function select_max($field, $as=FALSE); @@ -52,7 +52,7 @@ interface Query_Builder_Interface { * Selects the minimum value of a field from a query * * @param string $field - * @param string $as + * @param string|bool $as * @return Query_Builder */ public function select_min($field, $as=FALSE); @@ -63,7 +63,7 @@ interface Query_Builder_Interface { * Selects the average value of a field from a query * * @param string $field - * @param string $as + * @param string|bool $as * @return Query_Builder */ public function select_avg($field, $as=FALSE); @@ -74,7 +74,7 @@ interface Query_Builder_Interface { * Selects the sum of a field from a query * * @param string $field - * @param string $as + * @param string|bool $as * @return Query_Builder */ public function select_sum($field, $as=FALSE); @@ -304,7 +304,7 @@ interface Query_Builder_Interface { * Set a limit on the current sql statement * * @param int $limit - * @param int $offset + * @param int|bool $offset * @return string */ public function limit($limit, $offset=FALSE); @@ -358,9 +358,9 @@ interface Query_Builder_Interface { * execute current compiled query * * @param $table - * @param int $limit - * @param int $offset - * @return PDOStatement + * @param int|bool $limit + * @param int|bool $offset + * @return \PDOStatement */ public function get($table='', $limit=FALSE, $offset=FALSE); @@ -371,16 +371,16 @@ interface Query_Builder_Interface { * * @param string $table * @param array $where - * @param int $limit - * @param int $offset - * @return PDOStatement + * @param int|bool $limit + * @param int|bool $offset + * @return \PDOStatement */ public function get_where($table, $where=array(), $limit=FALSE, $offset=FALSE); // -------------------------------------------------------------------------- /** - * Retreive the number of rows in the selected table + * Retrieve the number of rows in the selected table * * @param string $table * @return int @@ -405,7 +405,7 @@ interface Query_Builder_Interface { * * @param string $table * @param mixed $data - * @return PDOStatement + * @return \PDOStatement */ public function insert($table, $data=array()); @@ -427,7 +427,7 @@ interface Query_Builder_Interface { * * @param string $table * @param mixed $data - * @return PDOStatement + * @return \PDOStatement */ public function update($table, $data=array()); @@ -438,7 +438,7 @@ interface Query_Builder_Interface { * * @param string $table * @param mixed $where - * @return PDOStatement + * @return \PDOStatement */ public function delete($table, $where=''); diff --git a/core/query_parser.php b/core/query_parser.php index d2b7cfc..3c6a2f9 100644 --- a/core/query_parser.php +++ b/core/query_parser.php @@ -56,9 +56,9 @@ class Query_Parser { /** * Constructor/entry point into parser * - * @param Query_Builder $db + * @param Driver\Driver_Interface $db */ - public function __construct(\Query\Driver\Driver_Interface $db) + public function __construct(Driver\Driver_Interface $db) { $this->db = $db; } diff --git a/drivers/firebird/firebird_result.php b/drivers/firebird/firebird_result.php index 28fe22a..95bff74 100644 --- a/drivers/firebird/firebird_result.php +++ b/drivers/firebird/firebird_result.php @@ -60,7 +60,7 @@ class Firebird_Result extends \PDOStatement { * @param \Query\Driver\Firebird|null $db * @return void */ - public function __construct($link, Driver_Interface $db = NULL) + public function __construct($link, Firebird $db = NULL) { if ( ! is_null($db)) $this->db = $db; $this->statement = $link; diff --git a/drivers/sqlite/sqlite_sql.php b/drivers/sqlite/sqlite_sql.php index ab9743b..f420a90 100644 --- a/drivers/sqlite/sqlite_sql.php +++ b/drivers/sqlite/sqlite_sql.php @@ -79,9 +79,9 @@ SQL; // -------------------------------------------------------------------------- /** - * Overridden in SQLite class + * List the system tables * - * @return string + * @return array */ public function system_table_list() { @@ -195,7 +195,7 @@ SQL; * Get the list of indexes for the current table * * @param string $table - * @return array + * @return string */ public function index_list($table) {