adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2025-01-18 18:46:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adding more documentation to DboSource.

Browse source
This commit is contained in:
mark_story 2010-12-22 22:33:17 -05:00
parent 98c356a9c5
commit a37b3a1598
1 changed files with 12 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
cake/libs/model/datasources/dbo_source.php
View file

@ -253,9 +253,10 @@ class DboSource extends DataSource {
/** /**
* Returns an object to represent a database identifier in a query * Returns an object to represent a database identifier in a query. Expression objects
* are not sanitized or esacped.
* *
* @param string $identifier * @param string $identifier A SQL expression to be used as an identifier
* @return object An object representing a database identifier to be used in a query * @return object An object representing a database identifier to be used in a query
*/ */
public function identifier($identifier) { public function identifier($identifier) {
@ -266,9 +267,10 @@ class DboSource extends DataSource {
} }
/** /**
* Returns an object to represent a database expression in a query * Returns an object to represent a database expression in a query. Expression objects
* are not sanitized or esacped.
* *
* @param string $expression * @param string $expression An arbitrary SQL expression to be inserted into a query.
* @return object An object representing a database expression to be used in a query * @return object An object representing a database expression to be used in a query
*/ */
public function expression($expression) { public function expression($expression) {
@ -282,6 +284,7 @@ class DboSource extends DataSource {
* Executes given SQL statement. * Executes given SQL statement.
* *
* @param string $sql SQL statement * @param string $sql SQL statement
* @param array $params Additional options for the query.
* @return boolean * @return boolean
*/ */
public function rawQuery($sql, $params = array()) { public function rawQuery($sql, $params = array()) {
@ -381,6 +384,7 @@ class DboSource extends DataSource {
* Returns number of affected rows in previous database operation. If no previous operation exists, * Returns number of affected rows in previous database operation. If no previous operation exists,
* this returns false. * this returns false.
* *
* @param string $source
* @return integer Number of affected rows * @return integer Number of affected rows
*/ */
function lastAffected($source = null) { function lastAffected($source = null) {
@ -394,6 +398,7 @@ class DboSource extends DataSource {
* Returns number of rows in previous resultset. If no previous resultset exists, * Returns number of rows in previous resultset. If no previous resultset exists,
* this returns false. * this returns false.
* *
* @param string $source
* @return integer Number of rows in resultset * @return integer Number of rows in resultset
*/ */
function lastNumRows($source = null) { function lastNumRows($source = null) {
@ -498,6 +503,7 @@ class DboSource extends DataSource {
/** /**
* Returns a row from current resultset as an array * Returns a row from current resultset as an array
* *
* @param string $sql Some SQL to be executed.
* @return array The fetched row as an array * @return array The fetched row as an array
*/ */
public function fetchRow($sql = null) { public function fetchRow($sql = null) {
@ -575,7 +581,7 @@ class DboSource extends DataSource {
/** /**
* Modifies $result array to place virtual fields in model entry where they belongs to * Modifies $result array to place virtual fields in model entry where they belongs to
* *
* @param array $resut REference to the fetched row * @param array $resut Reference to the fetched row
* @return void * @return void
*/ */
public function fetchVirtualField(&$result) { public function fetchVirtualField(&$result) {
@ -736,6 +742,7 @@ class DboSource extends DataSource {
* Get the query log as an array. * Get the query log as an array.
* *
* @param boolean $sorted Get the queries sorted by time taken, defaults to false. * @param boolean $sorted Get the queries sorted by time taken, defaults to false.
* @param boolean $clear If True the existing log will cleared.
* @return array Array of queries run as an array * @return array Array of queries run as an array
*/ */
public function getLog($sorted = false, $clear = true) { public function getLog($sorted = false, $clear = true) {