Improve documentation

This commit is contained in:
Val Bancer 2018-08-25 19:34:29 +02:00
parent 5105c49668
commit f768689bd0
4 changed files with 31 additions and 3 deletions

View file

@ -141,6 +141,13 @@ class Mysql extends DboSource {
*/ */
protected $_charsets = array(); protected $_charsets = array();
/**
* Map of the columns contained in a result.
*
* @var array
*/
public $map;
/** /**
* Connects to the database using options in the given configuration array. * Connects to the database using options in the given configuration array.
* *
@ -305,7 +312,7 @@ class Mysql extends DboSource {
* Query charset by collation * Query charset by collation
* *
* @param string $name Collation name * @param string $name Collation name
* @return string Character set name * @return string|false Character set name
*/ */
public function getCharsetName($name) { public function getCharsetName($name) {
if ((bool)version_compare($this->getVersion(), "5", "<")) { if ((bool)version_compare($this->getVersion(), "5", "<")) {
@ -391,7 +398,7 @@ class Mysql extends DboSource {
* @param array $fields The fields to update. * @param array $fields The fields to update.
* @param array $values The values to set. * @param array $values The values to set.
* @param mixed $conditions The conditions to use. * @param mixed $conditions The conditions to use.
* @return array * @return bool
*/ */
public function update(Model $model, $fields = array(), $values = null, $conditions = null) { public function update(Model $model, $fields = array(), $values = null, $conditions = null) {
if (!$this->_useAlias) { if (!$this->_useAlias) {
@ -545,7 +552,7 @@ class Mysql extends DboSource {
* *
* @param array $compare Result of a CakeSchema::compare() * @param array $compare Result of a CakeSchema::compare()
* @param string $table The table name. * @param string $table The table name.
* @return array Array of alter statements to make. * @return string|false String of alter statements to make.
*/ */
public function alterSchema($compare, $table = null) { public function alterSchema($compare, $table = null) {
if (!is_array($compare)) { if (!is_array($compare)) {

View file

@ -104,6 +104,13 @@ class Postgres extends DboSource {
*/ */
protected $_sqlOps = array('like', 'ilike', 'or', 'not', 'in', 'between', '~', '~\*', '\!~', '\!~\*', 'similar to'); protected $_sqlOps = array('like', 'ilike', 'or', 'not', 'in', 'between', '~', '~\*', '\!~', '\!~\*', 'similar to');
/**
* Map of the columns contained in a result.
*
* @var array
*/
public $map;
/** /**
* Connects to the database using options in the given configuration array. * Connects to the database using options in the given configuration array.
* *

View file

@ -102,6 +102,13 @@ class Sqlite extends DboSource {
), ),
); );
/**
* Map of the columns contained in a result.
*
* @var array
*/
public $map;
/** /**
* Connects to the database using config['database'] as a filename. * Connects to the database using config['database'] as a filename.
* *

View file

@ -106,6 +106,13 @@ class Sqlserver extends DboSource {
'boolean' => array('name' => 'bit') 'boolean' => array('name' => 'bit')
); );
/**
* Map of the columns contained in a result.
*
* @var array
*/
public $map;
/** /**
* Magic column name used to provide pagination support for SQLServer 2008 * Magic column name used to provide pagination support for SQLServer 2008
* which lacks proper limit/offset support. * which lacks proper limit/offset support.