Skip to content

Commit 76565db

Browse files
committed
Refactoring And Refine documentation
1 parent c7f65f1 commit 76565db

File tree

7 files changed

+493
-124
lines changed

7 files changed

+493
-124
lines changed

MysqliDb.php

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ public function rawQuery ($query, $bindParams = null, $sanitize = true)
264264
/**
265265
*
266266
* @param string $query Contains a user-provided select query.
267-
* @param int $numRows The number of rows total to return.
267+
* @param integer|array $numRows Array to define SQL limit in format Array ($count, $offset)
268268
*
269269
* @return array Contains the returned rows from the query.
270270
*/
@@ -321,7 +321,8 @@ public function withTotalCount () {
321321
* A convenient SELECT * function.
322322
*
323323
* @param string $tableName The name of the database table to work with.
324-
* @param integer $numRows The number of rows total to return.
324+
* @param integer|array $numRows Array to define SQL limit in format Array ($count, $offset)
325+
* or only $count
325326
*
326327
* @return array Contains the returned rows from the select query.
327328
*/
@@ -453,7 +454,8 @@ public function update($tableName, $tableData)
453454
* Delete query. Call the "where" method first.
454455
*
455456
* @param string $tableName The name of the database table to work with.
456-
* @param integer $numRows The number of rows to delete.
457+
* @param integer|array $numRows Array to define SQL limit in format Array ($count, $offset)
458+
* or only $count
457459
*
458460
* @return boolean Indicates success. 0 or 1.
459461
*/
@@ -694,7 +696,8 @@ protected function _buildPair ($operator, $value) {
694696
* any passed update data, and the desired rows.
695697
* It then builds the SQL query.
696698
*
697-
* @param int $numRows The number of rows total to return.
699+
* @param integer|array $numRows Array to define SQL limit in format Array ($count, $offset)
700+
* or only $count
698701
* @param array $tableData Should contain an array of data for updating the database.
699702
*
700703
* @return mysqli_stmt Returns the $stmt object.
@@ -937,7 +940,6 @@ protected function _buildGroupBy () {
937940
/**
938941
* Abstraction method that will build the LIMIT part of the WHERE statement
939942
*
940-
* @param int $numRows The number of rows total to return.
941943
*/
942944
protected function _buildOrderBy () {
943945
if (empty ($this->_orderBy))
@@ -957,7 +959,8 @@ protected function _buildOrderBy () {
957959
/**
958960
* Abstraction method that will build the LIMIT part of the WHERE statement
959961
*
960-
* @param int $numRows The number of rows total to return.
962+
* @param integer|array $numRows Array to define SQL limit in format Array ($count, $offset)
963+
* or only $count
961964
*/
962965
protected function _buildLimit ($numRows) {
963966
if (!isset ($numRows))

0 commit comments

Comments
 (0)