Fixed documentation
This commit is contained in:
parent
0332a57bfd
commit
80c8ec17c2
2 changed files with 18 additions and 18 deletions
|
@ -218,7 +218,7 @@ class DBA
|
|||
/**
|
||||
* Check if data exists
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @param array $condition Array of fields for condition
|
||||
* @return boolean Are there rows for that condition?
|
||||
* @throws \Exception
|
||||
|
@ -289,7 +289,7 @@ class DBA
|
|||
/**
|
||||
* Insert a row into a table
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @param array $param parameter array
|
||||
* @param int $duplicate_mode What to do on a duplicated entry
|
||||
* @return boolean was the insert successful?
|
||||
|
@ -304,7 +304,7 @@ class DBA
|
|||
* Inserts a row with the provided data in the provided table.
|
||||
* If the data corresponds to an existing row through a UNIQUE or PRIMARY index constraints, it updates the row instead.
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @param array $param parameter array
|
||||
* @return boolean was the insert successful?
|
||||
* @throws \Exception
|
||||
|
@ -329,7 +329,7 @@ class DBA
|
|||
*
|
||||
* This function can be extended in the future to accept a table array as well.
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @return boolean was the lock successful?
|
||||
* @throws \Exception
|
||||
*/
|
||||
|
@ -414,7 +414,7 @@ class DBA
|
|||
* Only set $old_fields to a boolean value when you are sure that you will update a single row.
|
||||
* When you set $old_fields to "true" then $fields must contain all relevant fields!
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @param array $fields contains the fields that are updated
|
||||
* @param array $condition condition array with the key values
|
||||
* @param array|boolean $old_fields array with the old field values that are about to be replaced (true = update on duplicate, false = don't update identical fields)
|
||||
|
@ -431,7 +431,7 @@ class DBA
|
|||
/**
|
||||
* Retrieve a single record from a table and returns it in an associative array
|
||||
*
|
||||
* @param string|array $table Table name or array [schema => table]
|
||||
* @param string|array $table Table name in format schema.table (while scheme is optiona)
|
||||
* @param array $fields
|
||||
* @param array $condition
|
||||
* @param array $params
|
||||
|
@ -447,7 +447,7 @@ class DBA
|
|||
/**
|
||||
* Select rows from a table and fills an array with the data
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @param array $fields Array of selected fields, empty for all
|
||||
* @param array $condition Array of fields for condition
|
||||
* @param array $params Array of several parameters
|
||||
|
@ -464,7 +464,7 @@ class DBA
|
|||
/**
|
||||
* Select rows from a table
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @param array $fields Array of selected fields, empty for all
|
||||
* @param array $condition Array of fields for condition
|
||||
* @param array $params Array of several parameters
|
||||
|
@ -492,7 +492,7 @@ class DBA
|
|||
/**
|
||||
* Counts the rows from a table satisfying the provided condition
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @param array $condition array of fields for condition
|
||||
* @param array $params Array of several parameters
|
||||
*
|
||||
|
|
|
@ -820,7 +820,7 @@ class Database
|
|||
/**
|
||||
* Check if data exists
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @param array $condition Array of fields for condition
|
||||
*
|
||||
* @return boolean Are there rows for that condition?
|
||||
|
@ -1003,7 +1003,7 @@ class Database
|
|||
/**
|
||||
* Insert a row into a table. Field value objects will be cast as string.
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @param array $param parameter array
|
||||
* @param int $duplicate_mode What to do on a duplicated entry
|
||||
*
|
||||
|
@ -1054,7 +1054,7 @@ class Database
|
|||
* Inserts a row with the provided data in the provided table.
|
||||
* If the data corresponds to an existing row through a UNIQUE or PRIMARY index constraints, it updates the row instead.
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @param array $param parameter array
|
||||
* @return boolean was the insert successful?
|
||||
* @throws \Exception
|
||||
|
@ -1102,7 +1102,7 @@ class Database
|
|||
*
|
||||
* This function can be extended in the future to accept a table array as well.
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @return boolean was the lock successful?
|
||||
* @throws \Exception
|
||||
*/
|
||||
|
@ -1300,7 +1300,7 @@ class Database
|
|||
* Only set $old_fields to a boolean value when you are sure that you will update a single row.
|
||||
* When you set $old_fields to "true" then $fields must contain all relevant fields!
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @param array $fields contains the fields that are updated
|
||||
* @param array $condition condition array with the key values
|
||||
* @param array|boolean $old_fields array with the old field values that are about to be replaced (true = update on duplicate, false = don't update identical fields)
|
||||
|
@ -1366,7 +1366,7 @@ class Database
|
|||
/**
|
||||
* Retrieve a single record from a table and returns it in an associative array
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @param array $fields Array of selected fields, empty for all
|
||||
* @param array $condition Array of fields for condition
|
||||
* @param array $params Array of several parameters
|
||||
|
@ -1392,7 +1392,7 @@ class Database
|
|||
/**
|
||||
* Select rows from a table and fills an array with the data
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @param array $fields Array of selected fields, empty for all
|
||||
* @param array $condition Array of fields for condition
|
||||
* @param array $params Array of several parameters
|
||||
|
@ -1466,7 +1466,7 @@ class Database
|
|||
*
|
||||
* $data = DBA::select($table, $fields, $condition, $params);
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @param array $fields Array of selected fields, empty for all
|
||||
* @param array $condition Array of fields for condition
|
||||
* @param array $params Array of several parameters
|
||||
|
@ -1506,7 +1506,7 @@ class Database
|
|||
/**
|
||||
* Counts the rows from a table satisfying the provided condition
|
||||
*
|
||||
* @param string $table Table name or array [schema => table]
|
||||
* @param string $table Table name in format schema.table (while scheme is optiona)
|
||||
* @param array $condition Array of fields for condition
|
||||
* @param array $params Array of several parameters
|
||||
*
|
||||
|
|
Loading…
Reference in a new issue