Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bancer committed Aug 25, 2018
1 parent 5105c49 commit f768689
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 3 deletions.
13 changes: 10 additions & 3 deletions lib/Cake/Model/Datasource/Database/Mysql.php
Expand Up @@ -141,6 +141,13 @@ class Mysql extends DboSource {
*/
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.
*
Expand Down Expand Up @@ -305,7 +312,7 @@ public function getEncoding() {
* Query charset by collation
*
* @param string $name Collation name
* @return string Character set name
* @return string|false Character set name
*/
public function getCharsetName($name) {
if ((bool)version_compare($this->getVersion(), "5", "<")) {
Expand Down Expand Up @@ -391,7 +398,7 @@ public function describe($model) {
* @param array $fields The fields to update.
* @param array $values The values to set.
* @param mixed $conditions The conditions to use.
* @return array
* @return bool
*/
public function update(Model $model, $fields = array(), $values = null, $conditions = null) {
if (!$this->_useAlias) {
Expand Down Expand Up @@ -545,7 +552,7 @@ public function index($model) {
*
* @param array $compare Result of a CakeSchema::compare()
* @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) {
if (!is_array($compare)) {
Expand Down
7 changes: 7 additions & 0 deletions lib/Cake/Model/Datasource/Database/Postgres.php
Expand Up @@ -104,6 +104,13 @@ class Postgres extends DboSource {
*/
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.
*
Expand Down
7 changes: 7 additions & 0 deletions lib/Cake/Model/Datasource/Database/Sqlite.php
Expand Up @@ -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.
*
Expand Down
7 changes: 7 additions & 0 deletions lib/Cake/Model/Datasource/Database/Sqlserver.php
Expand Up @@ -106,6 +106,13 @@ class Sqlserver extends DboSource {
'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
* which lacks proper limit/offset support.
Expand Down

0 comments on commit f768689

Please sign in to comment.