AdamB7586 / pdo-dbal

src/Database.php

Doc Comments +7 added lines, -7 removed lines

@@ -47,7 +47,7 @@ 
      * @param string $password This should be the password for the chosen database 

      * @param string $database This should be the database that you wish to connect to

      * @param string|false $backuphost If you have a replication server set up put the hostname or IP address incase the primary server goes down

-     * @param object|false $cache If you want to cache the queries with Memcache(d)/Redis/APC/Xcache This should be the object else set to false

+     * @param boolean $cache If you want to cache the queries with Memcache(d)/Redis/APC/Xcache This should be the object else set to false

      * @param boolean $persistent If you want a persistent database connection set to true

      * @param string $type The type of connection that you wish to make can be 'mysql', 'cubrid', 'dblib', 'mssql', 'odbc', 'pgsql, or 'sqlite'

      * @param int $port This should be the port number of the MySQL database connection

@@ -113,7 +113,7 @@ 
     /**

      * This query function is used for more advanced SQL queries for which non of the other methods fit

      * @param string $sql This should be the SQL query which you wish to run

-     * @param array $variables This should be an array of values to execute as the values in a prepared statement

+     * @param integer[] $variables This should be an array of values to execute as the values in a prepared statement

      * @return array Returns array of results for the query that has just been run

      */

     public function query($sql, $variables = array(), $cache = true) {

@@ -134,7 +134,7 @@ 
      * Returns a single record for a select query for the chosen table

      * @param string $table This should be the table you wish to select the values from

      * @param array $where Should be the field names and values you wish to use as the where query e.g. array('fieldname' => 'value', 'fieldname2' => 'value2', etc).

-     * @param string|array $fields This should be the records you wis to select from the table. It should be either set as '*' which is the default or set as an array in the following format array('field', 'field2', 'field3', etc).

+     * @param string $fields This should be the records you wis to select from the table. It should be either set as '*' which is the default or set as an array in the following format array('field', 'field2', 'field3', etc).

      * @param array|string $order This is the order you wish the results to be ordered in should be formatted as follows array('fieldname' => 'ASC') or array("'fieldname', 'fieldname2'" => 'DESC')

      * @param boolean $cache If the query should be cached or loaded from cache set to true else set to false

      * @return array Returns a single table record as the standard array when running SQL queries

@@ -149,9 +149,9 @@ 
      * @param array $where Should be the field names and values you wish to use as the where query e.g. array('fieldname' => 'value', 'fieldname2' => 'value2', etc).

      * @param string|array $fields This should be the records you wis to select from the table. It should be either set as '*' which is the default or set as an array in the following format array('field', 'field2', 'field3', etc).

      * @param array $order This is the order you wish the results to be ordered in should be formatted as follows array('fieldname' => 'ASC') or array("'fieldname', 'fieldname2'" => 'DESC')

-     * @param integer|array $limit The number of results you want to return 0 is default and returns all results, else should be formated either as a standard integer or as an array as the start and end values e.g. array(0 => 150)

+     * @param integer $limit The number of results you want to return 0 is default and returns all results, else should be formated either as a standard integer or as an array as the start and end values e.g. array(0 => 150)

      * @param boolean $cache If the query should be cached or loaded from cache set to true else set to false

-     * @return array Returns a multidimensional array with the chosen fields from the table

+     * @return boolean Returns a multidimensional array with the chosen fields from the table

      */

     public function selectAll($table, $where = array(), $fields = '*', $order = array(), $limit = 0, $cache = true) {        

         $this->buildSelectQuery(SafeString::makeSafe($table), $where, $fields, $order, $limit);

@@ -357,7 +357,7 @@ 
      * @param array $where Should be the field names and values you wish to use as the where query e.g. array('fieldname' => 'value', 'fieldname2' => 'value2', etc).

      * @param string|array $fields This should be the records you wis to select from the table. It should be either set as '*' which is the default or set as an array in the following format array('field', 'field2', 'field3', etc).

      * @param array $order This is the order you wish the results to be ordered in should be formatted as follows array('fieldname' => 'ASC') or array("'fieldname', 'fieldname2'" => 'DESC') so it can be done in both directions

-     * @param integer|array $limit The number of results you want to return 0 is default and returns all results, else should be formated either as a standard integer or as an array as the start and end values e.g. array(0 => 150)

+     * @param integer $limit The number of results you want to return 0 is default and returns all results, else should be formated either as a standard integer or as an array as the start and end values e.g. array(0 => 150)

      */

     protected function buildSelectQuery($table, $where = array(), $fields = '*', $order = array(), $limit = 0) {

         if(is_array($fields)) {

@@ -461,7 +461,7 @@ 
     

     /**

      * Returns the limit SQL for the current query as a string

-     * @param integer|array $limit This should either be set as an integer or should be set as an array with a start and end value  

+     * @param integer $limit This should either be set as an integer or should be set as an array with a start and end value  

      * @return string|false Will return the LIMIT string for the current query if it is valid else returns false

      */

     private function limit($limit = 0) {