Rozbo / puck

core/Mysql.php

Doc Comments +28 added lines, -29 removed lines

@@ -255,7 +255,7 @@ 
      *
      * @param string $subQueryAlias
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public static function subQuery($subQueryAlias = "") {
         return new self(array('host' => $subQueryAlias, 'isSubQuery' => true));
@@ -277,7 +277,7 @@ 
     /**
      * Helper function to create dbObject with JSON return type
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function jsonBuilder() {
         $this->returnType = 'json';
@@ -287,7 +287,7 @@ 
     /**
      * Helper function to create dbObject with object return type.
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function objectBuilder() {
         $this->returnType = 'object';
@@ -350,7 +350,7 @@ 
      * Method attempts to prepare the SQL query
      * and throws an error if there was a problem.
      *
-     * @return mysqli_stmt
+     * @return \mysqli_stmt
      */
     protected function _prepareQuery() {
         if (!$stmt = $this->mysqli()->prepare($this->_query)) {
@@ -539,7 +539,7 @@ 
      * This helper method takes care of prepared statements' "bind_result method
      * , when the number of variables to pass is unknown.
      *
-     * @param mysqli_stmt $stmt Equal to the prepared statement object.
+     * @param \mysqli_stmt $stmt Equal to the prepared statement object.
      *
      * @return array The results of the SQL fetch.
      */
@@ -702,7 +702,7 @@ 
      *                               or only $count
      * @param array $tableData Should contain an array of data for updating the database.
      *
-     * @return mysqli_stmt Returns the $stmt object.
+     * @return null|\mysqli_stmt Returns the $stmt object.
      */
     protected function _buildQuery($numRows = null, $tableData = null) {
         // $this->_buildJoinOld();
@@ -1209,9 +1209,8 @@ 
      * A convenient function that returns TRUE if exists at least an element that
      * satisfy the where condition specified calling the "where" method before this one.
      *
-     * @param string $tableName The name of the database table to work with.
      *
-     * @return array Contains the returned rows from the select query.
+     * @return boolean Contains the returned rows from the select query.
      */
     public function has() {
         $this->getOne($this->tableName, '1');
@@ -1311,7 +1310,7 @@ 
      * @param int|array $numRows Array to define SQL limit in format Array ($count, $offset)
      *                               or only $count
      *
-     * @return bool Indicates success. 0 or 1.
+     * @return null|boolean Indicates success. 0 or 1.
      */
     public function delete($numRows = null) {
         if ($this->isSubQuery) {
@@ -1342,7 +1341,7 @@ 
      * @param array $updateColumns Variable with values
      * @param string $lastInsertId Variable value
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function onDuplicate($updateColumns, $lastInsertId = null) {
         $this->_lastInsertId = $lastInsertId;
@@ -1359,7 +1358,7 @@ 
      * @param mixed $whereValue The value of the database field.
      * @param string $operator Comparison operator. Default is =
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function orWhere($whereProp, $whereValue = 'DBNULL', $operator = '=') {
         return $this->where($whereProp, $whereValue, $operator, 'OR');
@@ -1375,7 +1374,7 @@ 
      * @param string $operator Comparison operator. Default is =
      * @param string $cond Condition of where statement (OR, AND)
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function where($whereProp, $whereValue = 'DBNULL', $operator = '=', $cond = 'AND') {
         // forkaround for an old operation api
@@ -1401,7 +1400,7 @@ 
      * @param mixed $havingValue The value of the database field.
      * @param string $operator Comparison operator. Default is =
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function orHaving($havingProp, $havingValue = null, $operator = null) {
         return $this->having($havingProp, $havingValue, $operator, 'OR');
@@ -1416,7 +1415,7 @@ 
      * @param mixed $havingValue The value of the database field.
      * @param string $operator Comparison operator. Default is =
      *
-     * @return MysqliDb
+     * @return Mysql
      */
 
     public function having($havingProp, $havingValue = 'DBNULL', $operator = '=', $cond = 'AND') {
@@ -1444,7 +1443,7 @@ 
      * @param string $joinType 'LEFT', 'INNER' etc.
      *
      * @throws Exception
-     * @return MysqliDb
+     * @return Mysql
      */
     public function join($joinTable, $joinCondition, $joinType = '') {
         $allowedTypes = array('LEFT', 'RIGHT', 'OUTER', 'INNER', 'LEFT OUTER', 'RIGHT OUTER');
@@ -1529,7 +1528,7 @@ 
      * This method does not escape strings by default so make sure you'll never use it in production.
      *
      * @author Jonas Barascu
-     * @param [[Type]] $query [[Description]]
+     * @param string $query [[Description]]
      */
     private function queryUnprepared($query) {
         // Execute query
@@ -1603,11 +1602,11 @@ 
      * @uses $MySqliDb->orderBy('id', 'desc')->orderBy('name', 'desc');
      *
      * @param string $orderByField The name of the database field.
-     * @param string $orderByDirection Order direction.
+     * @param string $orderbyDirection Order direction.
      * @param array $customFields Fieldset for ORDER BY FIELD() ordering
      *
      * @throws Exception
-     * @return MysqliDb
+     * @return Mysql
      */
     public function orderBy($orderByField, $orderbyDirection = "DESC", $customFields = null) {
         $allowedDirection = Array("ASC", "DESC");
@@ -1643,7 +1642,7 @@ 
      *
      * @param string $groupByField The name of the database field.
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function groupBy($groupByField) {
         $groupByField = preg_replace("/[^-a-z0-9\.\(\),_\*]+/i", '', $groupByField);
@@ -1659,7 +1658,7 @@ 
      * @param  string $method The table lock method. Can be READ or WRITE.
      *
      * @throws Exception
-     * @return MysqliDb
+     * @return Mysql
      */
     public function setLockMethod($method) {
         // Switch the uppercase string
@@ -1806,7 +1805,7 @@ 
      *
      * @param string $prefix Contains a tableprefix
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function setPrefix($prefix = '') {
         $this->prefix = $prefix;
@@ -2016,7 +2015,7 @@ 
      * @param bool $enabled Enable execution time tracking
      * @param string $stripPrefix Prefix to strip from the path in exec log
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function setTrace($enabled, $stripPrefix = null) {
         $this->traceEnabled = $enabled;
@@ -2053,7 +2052,7 @@ 
      *
      * @param string $idField field name to use for a mapped element key
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function map($idField) {
         $this->_mapKey = $idField;
@@ -2069,7 +2068,7 @@ 
      * @param string $whereProp The name of the database field.
      * @param mixed $whereValue The value of the database field.
      *
-     * @return dbWrapper
+     * @return Mysql
      */
     public function joinOrWhere($whereJoin, $whereProp, $whereValue = 'DBNULL', $operator = '=', $cond = 'AND') {
         return $this->joinWhere($whereJoin, $whereProp, $whereValue, $operator, 'OR');
@@ -2084,7 +2083,7 @@ 
      * @param string $whereProp The name of the database field.
      * @param mixed $whereValue The value of the database field.
      *
-     * @return dbWrapper
+     * @return Mysql
      */
     public function joinWhere($whereJoin, $whereProp, $whereValue = 'DBNULL', $operator = '=', $cond = 'AND') {
         $this->_joinAnd[$whereJoin][] = Array($cond, $whereProp, $operator, $whereValue);
@@ -2160,7 +2159,7 @@ 
      * Helper function to create dbObject with array return type
      * Added for consistency as thats default output type
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function arrayBuilder() {
         $this->returnType = 'array';
@@ -2241,7 +2240,7 @@ 
     /**
      * Function to enable SQL_CALC_FOUND_ROWS in the get queries
      *
-     * @return MysqliDb
+     * @return Mysql
      */
     public function withTotalCount() {
         $this->setQueryOption('SQL_CALC_FOUND_ROWS');
@@ -2253,10 +2252,10 @@ 
      *
      * @uses $MySqliDb->setQueryOption('name');
      *
-     * @param string|array $options The optons name of the query.
+     * @param string $options The optons name of the query.
      *
      * @throws Exception
-     * @return MysqliDb
+     * @return Mysql
      */
     public function setQueryOption($options) {
         $allowedOptions = Array('ALL', 'DISTINCT', 'DISTINCTROW', 'HIGH_PRIORITY', 'STRAIGHT_JOIN', 'SQL_SMALL_RESULT',