Class Mysql

MySQL DBO driver object

Provides connection and SQL generation for MySQL RDMS

Object

DataSource

DboSource

Mysql

Package: Cake\Model\Datasource\Database
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: Cake/Model/Datasource/Database/Mysql.php

Properties summary

$_baseConfig protected

array

Base configuration settings for MySQL driver
$_commands protected

array

Index of basic SQL commands
$_connection protected

PDO

Reference to the PDO object connection
$_useAlias protected

boolean

use alias for update and delete. Set to true if version >= 4.1
$columns public

array

MySQL column definition
$description public

string

Datasource description
$endQuote public

string

End quote
$fieldParameters public

array

List of engine specific additional field parameters used on table creating
$startQuote public

string

Start quote
$tableParameters public

array

List of table engine specific parameters used on table creating

Inherited Properties

_methodCacheChange, _queriesCnt, _queriesLog, _queriesLogMax, _queriesTime, _queryCache, _result, _sqlOps, _transactionNesting, affected, alias, cacheMethods, configKeyName, fullDebug, index, methodCache, numRows, took, virtualFieldSeparator _descriptions, _sources, _transactionStarted, cacheSources, config, connected

Method Summary

_alterIndexes() protected

Generate MySQL index alteration statements for a table.
_alterTableParameters() protected

Generate MySQL table parameter alteration statements for a table.
alterSchema() public

Generate a MySQL Alter Table syntax for the given Schema comparison
column() public

Converts database-layer column types to basic types
connect() public

Connects to the database using options in the given configuration array.
delete() public

Generates and executes an SQL DELETE statement for given id/conditions on given model.
describe() public

Returns an array of the fields in given table name.
dropSchema() public

Generate a MySQL "drop table" statement for the given Schema object
enabled() public

Check whether the MySQL extension is installed/loaded
fetchResult() public

Fetches the next row from the current result set
getCharsetName() public

Query charset by collation
getEncoding() public

Gets the database encoding
getSchemaName() public

Gets the schema name
getVersion() public

Gets the version string of the database server
index() public

Returns an array of the indexes in given datasource name.
listDetailedSources() public

Returns an detailed array of sources (tables) in the database.
listSources() public

Returns an array of sources (tables) in the database.
resultSet() public

Builds a map of the columns contained in a result
setEncoding() public

Sets the database encoding
update() public

Generates and executes an SQL UPDATE statement for given model, fields, and values.

Method Detail

_alterIndexes() protected ¶

_alterIndexes( string $table , array $indexes )

Generate MySQL index alteration statements for a table.

Parameters

string $table: Table to alter indexes for
array $indexes: Indexes to add and drop

Returns

array
Index alteration statements

_alterTableParameters() protected ¶

_alterTableParameters( string $table , array $parameters )

Generate MySQL table parameter alteration statements for a table.

Parameters

string $table: Table to alter parameters for.
array $parameters: Parameters to add & drop.

Returns

array
Array of table property alteration statements.

alterSchema() public ¶

alterSchema( array $compare , string $table = null )

Generate a MySQL Alter Table syntax for the given Schema comparison

Parameters

array $compare: Result of a CakeSchema::compare()
string $table optional null

Returns

array
Array of alter statements to make.

Overrides

DboSource::alterSchema()

column() public ¶

column( string $real )

Converts database-layer column types to basic types

Parameters

string $real: Real database-layer column type (i.e. "varchar(255)")

Returns

string
Abstract column type (i.e. "string")

Overrides

DataSource::column()

connect() public ¶

connect( )

Connects to the database using options in the given configuration array.

Returns

boolean
True if the database could be connected, else false

Throws

MissingConnectionException

delete() public ¶

delete( Model $model , mixed $conditions = null )

Generates and executes an SQL DELETE statement for given id/conditions on given model.

Parameters

Model $model
mixed $conditions optional null

Returns

boolean
Success

Overrides

DboSource::delete()

describe() public ¶

describe( Model|string $model )

Returns an array of the fields in given table name.

Parameters

Model|string $model: Name of database table to inspect or model instance

Returns

array
Fields in table. Keys are name and type

Throws

CakeException

Overrides

DataSource::describe()

dropSchema() public ¶

dropSchema( CakeSchema $schema , string $table = null )

Generate a MySQL "drop table" statement for the given Schema object

Parameters

CakeSchema $schema: An instance of a subclass of CakeSchema
string $table optional null: Optional. If specified only the table name given will be generated. Otherwise, all tables defined in the schema are generated.

Returns

string

Overrides

DboSource::dropSchema()

enabled() public ¶

enabled( )

Check whether the MySQL extension is installed/loaded

Returns

boolean

Overrides

DataSource::enabled()

fetchResult() public ¶

fetchResult( )

Fetches the next row from the current result set

Returns

mixed
array with results fetched and mapped to column names or false if there is no results left to fetch

Overrides

DboSource::fetchResult()

getCharsetName() public ¶

getCharsetName( string $name )

Query charset by collation

Parameters

string $name: Collation name

Returns

string
Character set name

getEncoding() public ¶

getEncoding( )

Gets the database encoding

Returns

string
The database encoding

getSchemaName() public ¶

getSchemaName( )

Gets the schema name

Returns

string
The schema name

Overrides

DataSource::getSchemaName()

getVersion() public ¶

getVersion( )

Gets the version string of the database server

Returns

string
The database encoding

index() public ¶

index( string $model )

Returns an array of the indexes in given datasource name.

Parameters

string $model: Name of model to inspect

Returns

array
Fields in table. Keys are column and unique

Overrides

DboSource::index()

listDetailedSources() public ¶

listDetailedSources( string $name = null )

Returns an detailed array of sources (tables) in the database.

Parameters

string $name optional null: Table name to get parameters

Returns

array
Array of table names in the database

listSources() public ¶

listSources( mixed $data = null )

Returns an array of sources (tables) in the database.

Parameters

mixed $data optional null

Returns

array
Array of table names in the database

Overrides

DataSource::listSources()

resultSet() public ¶

resultSet( PDOStatement $results )

Builds a map of the columns contained in a result

Parameters

PDOStatement $results

setEncoding() public ¶

setEncoding( string $enc )

Sets the database encoding

Parameters

string $enc: Database encoding

Returns

boolean

update() public ¶

update( Model $model , array $fields = array() , array $values = null , mixed $conditions = null )

Generates and executes an SQL UPDATE statement for given model, fields, and values.

Parameters

Model $model
array $fields optional array()
array $values optional null
mixed $conditions optional null

Returns

array

Overrides

DboSource::update()

Methods inherited from DboSource

__construct() public ¶

__construct( array $config = null , boolean $autoConnect = true )

Constructor

Parameters

array $config optional null: Array of configuration information for the Datasource.
boolean $autoConnect optional true: Whether or not the datasource should automatically connect.

Throws

MissingConnectionException
when a connection cannot be made.

Overrides

DataSource::__construct()

__destruct() public ¶

__destruct( )

Used for storing in cache the results of the in-memory methodCache

Overrides

DataSource::__destruct()

_buildFieldParameters() protected ¶

_buildFieldParameters( string $columnString , array $columnData , string $position )

Build the field parameters, in a position

Parameters

string $columnString: The partially built column string
array $columnData: The array of column data.
string $position: The position type to use. 'beforeDefault' or 'afterDefault' are common

Returns

string
a built column with the field parameters added.

_constructVirtualFields() protected ¶

_constructVirtualFields( Model $model , string $alias , mixed $fields )

Converts model virtual fields into sql expressions to be fetched later

Parameters

Model $model
string $alias: Alias table name
mixed $fields: virtual fields to be used on query

Returns

array

_execute() protected ¶

_execute( string $sql , array $params = array() , array $prepareOptions = array() )

Executes given SQL statement.

Parameters

string $sql: SQL statement
array $params optional array(): list of params to be bound to query
array $prepareOptions optional array(): Options to be used in the prepare statement

Returns

mixed

PDOStatement if query executes with no problem, true as the result of a successful, false on error query returning no rows, such as a CREATE statement, false otherwise

Throws

PDOException

_filterResults() protected ¶

_filterResults( array $results , Model $model , array $filtered = array() )

Passes association results thru afterFind filters of corresponding model

Parameters

array $results: Reference of resultset to be filtered
Model $model: Instance of model to operate against
array $filtered optional array(): List of classes already filtered, to be skipped

Returns

array
Array of results that have been filtered through $model->afterFind

_getJoins() protected ¶

_getJoins( Model $model )

Returns an array of SQL JOIN fragments from a model's associations

Parameters

Model $model

Returns

array

_matchRecords() protected ¶

_matchRecords( Model $model , mixed $conditions = null )

Gets a list of record IDs for the given conditions. Used for multi-record updates and deletes in databases that do not support aliases in UPDATE/DELETE queries.

Parameters

Model $model
mixed $conditions optional null

Returns

array
List of record IDs

_mergeAssociation() protected ¶

_mergeAssociation( array $data , array $merge , string $association , string $type , boolean $selfJoin = false )

Merge association of merge into data

Parameters

array $data
array $merge
string $association
string $type
boolean $selfJoin optional false

_mergeConditions() protected ¶

_mergeConditions( mixed $query , mixed $assoc )

Merges a mixed set of string/array conditions

Parameters

mixed $query
mixed $assoc

Returns

array

_mergeHasMany() protected ¶

_mergeHasMany( array $resultSet , array $merge , string $association , Model $model , Model $linkModel )

mergeHasMany - Merge the results of hasMany relations.

Parameters

array $resultSet: Data to merge into
array $merge: Data to merge
string $association: Name of Model being Merged
Model $model: Model being merged onto
Model $linkModel: Model being merged

_parseKey() protected ¶

_parseKey( Model $model , string $key , mixed $value )

Extracts a Model.field identifier and an SQL condition operator from a string, formats and inserts values, and composes them into an SQL snippet.

Parameters

Model $model: Model object initiating the query
string $key: An SQL key snippet containing a field and optional SQL operator
mixed $value: The value(s) to be inserted in the string

Returns

string

_prepareUpdateFields() protected ¶

_prepareUpdateFields( Model $model , array $fields , boolean $quoteValues = true , boolean $alias = false )

Quotes and prepares fields and values for an SQL UPDATE statement

Parameters

Model $model
array $fields
boolean $quoteValues optional true: If values should be quoted, or treated as SQL snippets
boolean $alias optional false: Include the model alias in the field name

Returns

array
Fields and values, quoted and prepared

_quoteFields() protected ¶

_quoteFields( string $conditions )

Quotes Model.fields

Parameters

string $conditions

Returns

string
or false if no match

_quoteMatchedField() protected ¶

_quoteMatchedField( string $match )

Auxiliary function to quote matches Model.fields from a preg_replace_callback call

Parameters

string $match: matched string

Returns

string
quoted string

_scrubQueryData() protected ¶

_scrubQueryData( array $data )

Private helper method to remove query metadata in given data array.

Parameters

array $data

Returns

array

_writeQueryCache() protected ¶

_writeQueryCache( string $sql , mixed $data , array $params = array() )

Writes a new key for the in memory sql query cache

Parameters

string $sql: SQL query
mixed $data: result of $sql query
array $params optional array(): query params bound as values

begin() public ¶

begin( )

Begin a transaction

Returns

boolean

True on success, false on fail (i.e. if the database/model does not support transactions, or a transaction has not started).

Overrides

DataSource::begin()

boolean() public ¶

boolean( mixed $data , boolean $quote = false )

Translates between PHP boolean values and Database (faked) boolean values

Parameters

mixed $data: Value to be translated
boolean $quote optional false

Returns

string|boolean
Converted boolean value

buildColumn() public ¶

buildColumn( array $column )

Generate a database-native column schema string

Parameters

array $column: An array structured like the following: array('name' => 'value', 'type' => 'value'[, options]), where options can be 'default', 'length', or 'key'.

Returns

string

buildIndex() public ¶

buildIndex( array $indexes , string $table = null )

Format indexes for create table

Parameters

array $indexes
string $table optional null

Returns

array

buildJoinStatement() public ¶

buildJoinStatement( array $join )

Builds and generates a JOIN statement from an array. Handles final clean-up before conversion.

Parameters

array $join: An array defining a JOIN statement in a query

Returns

string
An SQL JOIN statement to be used in a query

See

DboSource::renderJoinStatement()
DboSource::buildStatement()

buildStatement() public ¶

buildStatement( array $query , Model $model )

Builds and generates an SQL statement from an array. Handles final clean-up before conversion.

Parameters

array $query: An array defining an SQL query
Model $model: The model object which initiated the query

Returns

string
An executable SQL statement

See

DboSource::renderStatement()

buildTableParameters() public ¶

buildTableParameters( array $parameters , string $table = null )

Format parameters for create table

Parameters

array $parameters
string $table optional null

Returns

array

cacheMethod() public ¶

cacheMethod( string $method , string $key , mixed $value = null )

Cache a value into the methodCaches. Will respect the value of DboSource::$cacheMethods. Will retrieve a value from the cache if $value is null.

If caching is disabled and a write is attempted, the $value will be returned. A read will either return the value or null.

Parameters

string $method: Name of the method being cached.
string $key: The key name for the cache operation.
mixed $value optional null: The value to cache into memory.

Returns

mixed
Either null on failure, or the value if its set.

calculate() public ¶

calculate( Model $model , string $func , array $params = array() )

Returns an SQL calculation, i.e. COUNT() or MAX()

Parameters

Model $model
string $func: Lowercase name of SQL function, i.e. 'count' or 'max'
array $params optional array(): Function parameters (any values must be quoted manually)

Returns

string
An SQL calculation function

close() public ¶

close( )

Disconnects database, kills the connection and says the connection is closed.

Overrides

DataSource::close()

commit() public ¶

commit( )

Commit a transaction

Returns

boolean

True on success, false on fail (i.e. if the database/model does not support transactions, or a transaction has not started).

Overrides

DataSource::commit()

conditionKeysToString() public ¶

conditionKeysToString( array $conditions , boolean $quoteValues = true , Model $model = null )

Creates a WHERE clause by parsing given conditions array. Used by DboSource::conditions().

Parameters

array $conditions: Array or string of conditions
boolean $quoteValues optional true: If true, values should be quoted
Model $model optional null: A reference to the Model instance making the query

Returns

string
SQL fragment

conditions() public ¶

conditions( mixed $conditions , boolean $quoteValues = true , boolean $where = true , Model $model = null )

Creates a WHERE clause by parsing given conditions data. If an array or string conditions are provided those conditions will be parsed and quoted. If a boolean is given it will be integer cast as condition. Null will return 1 = 1.

Results of this method are stored in a memory cache. This improves performance, but because the method uses a hashing algorithm it can have collisions. Setting DboSource::$cacheMethods to false will disable the memory cache.

Parameters

mixed $conditions: Array or string of conditions, or any value.
boolean $quoteValues optional true: If true, values should be quoted
boolean $where optional true: If true, "WHERE " will be prepended to the return value
Model $model optional null: A reference to the Model instance making the query

Returns

string
SQL fragment

create() public ¶

create( Model $model , array $fields = null , array $values = null )

The "C" in CRUD

Creates new records in the database.

Parameters

Model $model: Model object that the record is for.
array $fields optional null: An array of field names to insert. If null, $model->data will be used to generate field names.
array $values optional null: An array of values with keys matching the fields. If null, $model->data will be used to generate values.

Returns

boolean
Success

Overrides

DataSource::create()

createSchema() public ¶

createSchema( Model $schema , string $tableName = null )

Generate a database-native schema for the given Schema object

Parameters

Model $schema: An instance of a subclass of CakeSchema
string $tableName optional null: Optional. If specified only the table name given will be generated. Otherwise, all tables defined in the schema are generated.

Returns

string

defaultConditions() public ¶

defaultConditions( Model $model , mixed $conditions , boolean $useAlias = true )

Creates a default set of conditions from the model if $conditions is null/empty. If conditions are supplied then they will be returned. If a model doesn't exist and no conditions were provided either null or false will be returned based on what was input.

Parameters

Model $model
mixed $conditions: Array of conditions, conditions string, null or false. If an array of conditions, or string conditions those conditions will be returned. With other values the model's existence will be checked. If the model doesn't exist a null or false will be returned depending on the input value.
boolean $useAlias optional true: Use model aliases rather than table names when generating conditions

Returns

mixed
Either null, false, $conditions or an array of default conditions to use.

See

DboSource::update()
DboSource::conditions()

disconnect() public ¶

disconnect( )

Disconnects from database.

Returns

boolean
True if the database could be disconnected, else false

execute() public ¶

execute( string $sql , array $options = array() , array $params = array() )

Queries the database with given SQL statement, and obtains some metadata about the result (rows affected, timing, any errors, number of rows in resultset). The query is also logged. If Configure::read('debug') is set, the log is shown all the time, else it is only shown on errors.

Options

log - Whether or not the query should be logged to the memory log.

Parameters

string $sql: SQL statement
array $options optional array()
array $params optional array(): values to be bound to the query

Returns

mixed
Resource or object representing the result set, or false on failure

expression() public ¶

expression( string $expression )

Returns an object to represent a database expression in a query. Expression objects are not sanitized or escaped.

Parameters

string $expression: An arbitrary SQL expression to be inserted into a query.

Returns

stdClass
An object representing a database expression to be used in a query

fetchAll() public ¶

fetchAll( string $sql , array $params = array() , array $options = array() )

Returns an array of all result rows for a given SQL query. Returns false if no rows matched.

Options

cache - Returns the cached version of the query, if exists and stores the result in cache. This is a non-persistent cache, and only lasts for a single request. This option defaults to true. If you are directly calling this method, you can disable caching by setting $options to false

Parameters

string $sql: SQL statement
array $params optional array(): parameters to be bound as values for the SQL statement
array $options optional array(): additional options for the query.

Returns

array
Array of resultset rows, or false if no rows matched

fetchAssociated() public ¶

fetchAssociated( Model $model , string $query , array $ids )

A more efficient way to fetch associations. Woohoo!

Parameters

Model $model: Primary model object
string $query: Association query
array $ids: Array of IDs of associated records

Returns

array
Association results

fetchRow() public ¶

fetchRow( string $sql = null )

Returns a row from current resultset as an array

Parameters

string $sql optional null: Some SQL to be executed.

Returns

array
The fetched row as an array

fetchVirtualField() public ¶

fetchVirtualField( array $result )

Modifies $result array to place virtual fields in model entry where they belongs to

Parameters

array $result: Reference to the fetched row

field() public ¶

field( string $name , string $sql )

Returns a single field of the first of query results for a given SQL query, or false if empty.

Parameters

string $name: Name of the field
string $sql: SQL query

Returns

mixed
Value of field read.

fields() public ¶

fields( Model $model , string $alias = null , mixed $fields = array() , boolean $quote = true )

Generates the fields list of an SQL query.

Parameters

Model $model
string $alias optional null: Alias table name
mixed $fields optional array()
boolean $quote optional true: If false, returns fields array unquoted

Returns

array

flushMethodCache() public ¶

flushMethodCache( )

Empties the method caches. These caches are used by DboSource::name() and DboSource::conditions()

fullTableName() public ¶

fullTableName( mixed $model , boolean $quote = true , boolean $schema = true )

Gets full table name including prefix

Parameters

mixed $model: Either a Model object or a string table name.
boolean $quote optional true: Whether you want the table name quoted.
boolean $schema optional true: Whether you want the schema name included.

Returns

string
Full quoted table name

generateAssociationQuery() public ¶

generateAssociationQuery( Model $model , Model $linkModel , string $type , string $association , array $assocData , array $queryData , boolean $external , array $resultSet )

Generates an array representing a query or part of a query from a single model or two associated models

Parameters

Model $model
Model $linkModel
string $type
string $association
array $assocData
array $queryData
boolean $external
array $resultSet

Returns

mixed

getConnection() public ¶

getConnection( )

Get the underlying connection object.

Returns

PDOConnection

getConstraint() public ¶

getConstraint( string $type , Model $model , string $linkModel , string $alias , array $assoc , string $alias2 = null )

Returns a conditions array for the constraint between two models

Parameters

string $type: Association type
Model $model: Model object
string $linkModel
string $alias
array $assoc
string $alias2 optional null

Returns

array
Conditions array defining the constraint between $model and $association

getLog() public ¶

getLog( boolean $sorted = false , boolean $clear = true )

Get the query log as an array.

Parameters

boolean $sorted optional false: Get the queries sorted by time taken, defaults to false.
boolean $clear optional true: If True the existing log will cleared.

Returns

array
Array of queries run as an array

getQueryCache() public ¶

getQueryCache( string $sql , array $params = array() )

Returns the result for a sql query if it is already cached

Parameters

string $sql: SQL query
array $params optional array(): query params bound as values

Returns

mixed
results for query if it is cached, false otherwise

group() public ¶

group( string $group , Model $model = null )

Create a GROUP BY SQL clause

Parameters

string $group: Group By Condition
Model $model optional null

Returns

string
string condition or null

hasAny() public ¶

hasAny( Model $Model , string $sql )

Checks if the specified table contains any record matching specified SQL

Parameters

Model $Model: Model to search
string $sql: SQL WHERE clause (condition only, not the "WHERE" part)

Returns

boolean
True if the table has a matching record, else false

hasResult() public ¶

hasResult( )

Checks if the result is valid

Returns

boolean
True if the result is valid else false

identifier() public ¶

identifier( string $identifier )

Returns an object to represent a database identifier in a query. Expression objects are not sanitized or escaped.

Parameters

string $identifier: A SQL expression to be used as an identifier

Returns

stdClass
An object representing a database identifier to be used in a query

insertMulti() public ¶

insertMulti( string $table , array $fields , array $values )

Inserts multiple values into a table

Parameters

string $table: The table being inserted into.
array $fields: The array of field/column names being inserted.
array $values: The array of values to insert. The values should be an array of rows. Each row should have values keyed by the column name. Each row must have the values in the same order as $fields.

Returns

boolean

introspectType() public ¶

introspectType( string $value )

Guesses the data type of an array

Parameters

string $value

isConnected() public ¶

isConnected( )

Checks if the source is connected to the database.

Returns

boolean
True if the database is connected, else false

lastAffected() public ¶

lastAffected( mixed $source = null )

Returns number of affected rows in previous database operation. If no previous operation exists, this returns false.

Parameters

mixed $source optional null

Returns

integer
Number of affected rows

Overrides

DataSource::lastAffected()

lastError() public ¶

lastError( PDOStatement $query = null )

Returns a formatted error message from previous database operation.

Parameters

PDOStatement $query optional null: the query to extract the error from if any

Returns

string
Error message with error number

lastInsertId() public ¶

lastInsertId( mixed $source = null )

Returns the ID generated from the previous INSERT operation.

Parameters

mixed $source optional null

Returns

mixed

Overrides

DataSource::lastInsertId()

lastNumRows() public ¶

lastNumRows( mixed $source = null )

Returns number of rows in previous resultset. If no previous resultset exists, this returns false.

Parameters

mixed $source optional null: Not used

Returns

integer
Number of rows in resultset

Overrides

DataSource::lastNumRows()

length() public ¶

length( string $real )

Gets the length of a database-native column description, or null if no length

Parameters

string $real: Real database-layer column type (i.e. "varchar(255)")

Returns

mixed
An integer or string representing the length of the column, or null for unknown length.

limit() public ¶

limit( integer $limit , integer $offset = null )

Returns a limit statement in the correct format for the particular database.

Parameters

integer $limit: Limit of results returned
integer $offset optional null: Offset from which to start results

Returns

string
SQL limit/offset statement

logQuery() public ¶

logQuery( string $sql , array $params = array() )

Log given SQL query.

Parameters

string $sql: SQL statement
array $params optional array(): Values binded to the query (prepared statements)

name() public ¶

name( mixed $data )

Returns a quoted name of $data for use in an SQL statement. Strips fields out of SQL functions before quoting.

Parameters

mixed $data: Either a string with a column to quote. An array of columns to quote or an object from DboSource::expression() or DboSource::identifier()

Returns

string
SQL field

order() public ¶

order( array|string $keys , string $direction = 'ASC' , Model $model = null )

Returns an ORDER BY clause as a string.

Parameters

array|string $keys: Field reference, as a key (i.e. Post.title)
string $direction optional 'ASC': Direction (ASC or DESC)
Model $model optional null: model reference (used to look for virtual field)

Returns

string
ORDER BY clause

query() public ¶

query( )

DataSource Query abstraction

Returns

resource
Result resource identifier.

queryAssociation() public ¶

queryAssociation( Model $model , Model $linkModel , string $type , string $association , array $assocData , array $queryData , boolean $external , array $resultSet , integer $recursive , array $stack )

Queries associations. Used to fetch results on recursive models.

Parameters

Model $model: Primary Model object
Model $linkModel: Linked model that
string $type: Association type, one of the model association types ie. hasMany
string $association
array $assocData
array $queryData
boolean $external: Whether or not the association query is on an external datasource.
array $resultSet: Existing results
integer $recursive: Number of levels of association
array $stack

Returns

mixed

Throws

CakeException
when results cannot be created.

rawQuery() public ¶

rawQuery( string $sql , array $params = array() )

Executes given SQL statement.

Parameters

string $sql: SQL statement
array $params optional array(): Additional options for the query.

Returns

boolean

read() public ¶

read( Model $model , array $queryData = array() , integer $recursive = null )

The "R" in CRUD

Reads record(s) from the database.

Parameters

Model $model: A Model object that the query is for.
array $queryData optional array(): An array of queryData information containing keys similar to Model::find()
integer $recursive optional null: Number of levels of association

Returns

mixed
boolean false on error/failure. An array of results on success.

Overrides

DataSource::read()

readTableParameters() public ¶

readTableParameters( string $name )

Read additional table parameters

Parameters

string $name

Returns

array

reconnect() public ¶

reconnect( array $config = array() )

Reconnects to database server with optional new settings

Parameters

array $config optional array(): An array defining the new configuration settings

Returns

boolean
True on success, false on failure

renderJoinStatement() public ¶

renderJoinStatement( array $data )

Renders a final SQL JOIN statement

Parameters

array $data

Returns

string

renderStatement() public ¶

renderStatement( string $type , array $data )

Renders a final SQL statement by putting together the component parts in the correct order

Parameters

string $type: type of query being run. e.g select, create, update, delete, schema, alter.
array $data: Array of data to insert into the query.

Returns

string
Rendered SQL expression to be run.

resolveKey() public ¶

resolveKey( Model $model , string $key , string $assoc = null )

Returns a key formatted like a string Model.fieldname(i.e. Post.title, or Country.name)

Parameters

Model $model
string $key
string $assoc optional null

Returns

string

Overrides

DataSource::resolveKey()

rollback() public ¶

rollback( )

Rollback a transaction

Returns

boolean

True on success, false on fail (i.e. if the database/model does not support transactions, or a transaction has not started).

Overrides

DataSource::rollback()

showLog() public ¶

showLog( boolean $sorted = false )

Outputs the contents of the queries log. If in a non-CLI environment the sql_log element will be rendered and output. If in a CLI environment, a plain text log is generated.

Parameters

boolean $sorted optional false: Get the queries sorted by time taken, defaults to false.

truncate() public ¶

truncate( mixed $table )

Deletes all the records in a table and resets the count of the auto-incrementing primary key, where applicable.

Parameters

mixed $table: A string or model class representing the table to be truncated

Returns

boolean
SQL TRUNCATE TABLE statement, false if not applicable.

value() public ¶

value( string $data , string $column = null )

Returns a quoted and escaped string of $data for use in an SQL statement.

Parameters

string $data: String to be prepared for use in an SQL statement
string $column optional null: The column into which this data will be inserted

Returns

string
Quoted and escaped data

Methods inherited from DataSource

_cacheDescription() protected ¶

_cacheDescription( string $object , mixed $data = null )

Cache the DataSource description

Parameters

string $object: The name of the object (model) to cache
mixed $data optional null: The description of the model, usually a string or array

Returns

mixed

insertQueryData() public ¶

insertQueryData( string $query , array $data , string $association , array $assocData , Model $model , Model $linkModel , array $stack )

Replaces {$__cakeID__$} and {$__cakeForeignKey__$} placeholders in query data.

Parameters

string $query: Query string needing replacements done.
array $data: Array of data with values that will be inserted in placeholders.
string $association: Name of association model being replaced
array $assocData
Model $model: Instance of the model to replace $cakeID$
Model $linkModel: Instance of model to replace $cakeForeignKey$
array $stack

Returns

string
String of query data with placeholders replaced.

setConfig() public ¶

setConfig( array $config = array() )

Sets the configuration for the DataSource. Merges the $config information with the _baseConfig and the existing $config property.

Parameters

array $config optional array(): The configuration array

Methods inherited from Object

_mergeVars() protected ¶

_mergeVars( array $properties , string $class , boolean $normalize = true )

Merges this objects $property with the property in $class' definition. This classes value for the property will be merged on top of $class'

This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine this method as an empty function.

Parameters

array $properties: The name of the properties to merge.
string $class: The class to merge the property with.
boolean $normalize optional true: Set to true to run the properties through Set::normalize() before merging.

_set() protected ¶

_set( array $properties = array() )

Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.

Parameters

array $properties optional array(): An associative array containing properties and corresponding values.

_stop() protected ¶

_stop( integer|string $status = 0 )

Stop execution of the current script. Wraps exit() making testing easier.

Parameters

integer|string $status optional 0: see http://php.net/exit for values

dispatchMethod() public ¶

dispatchMethod( string $method , array $params = array() )

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array

Parameters

string $method: Name of the method to call
array $params optional array(): Parameter list to use when calling $method

Returns

mixed
Returns the result of the method call

log() public ¶

log( string $msg , integer $type = LOG_ERROR )

Convenience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.

Parameters

string $msg: Log message
integer $type optional LOG_ERROR: Error type constant. Defined in app/Config/core.php.

Returns

boolean
Success of log write

requestAction() public ¶

requestAction( mixed $url , array $extra = array() )

Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.

Under the hood this method uses Router::reverse() to convert the $url parameter into a string URL. You should use URL formats that are compatible with Router::reverse()

Passing POST and GET data

POST and GET data can be simulated in requestAction. Use $extra['url'] for GET data. The $extra['data'] parameter allows POST data simulation.

Parameters

mixed $url: String or array-based url. Unlike other url arrays in CakePHP, this url will not automatically handle passed and named arguments in the $url parameter.
array $extra optional array(): if array includes the key "return" it sets the AutoRender to true. Can also be used to submit GET/POST data, and named/passed arguments.

Returns

mixed

Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.

toString() public ¶

toString( )

Object-to-string conversion. Each class can override this method as necessary.

Returns

string
The name of this class

Properties detail

`$_baseConfig` ¶

protected array

Base configuration settings for MySQL driver

array(
    'persistent' => true,
    'host' => 'localhost',
    'login' => 'root',
    'password' => '',
    'database' => 'cake',
    'port' => '3306'
)

`$_commands` ¶

protected array

Index of basic SQL commands

array(
    'begin'    => 'START TRANSACTION',
    'commit'   => 'COMMIT',
    'rollback' => 'ROLLBACK'
)

`$_connection` ¶

protected PDO

Reference to the PDO object connection

null

`$_useAlias` ¶

protected boolean

use alias for update and delete. Set to true if version >= 4.1

true

`$columns` ¶

public array

MySQL column definition

array(
    'primary_key' => array('name' => 'NOT NULL AUTO_INCREMENT'),
    'string' => array('name' => 'varchar', 'limit' => '255'),
    'text' => array('name' => 'text'),
    'integer' => array('name' => 'int', 'limit' => '11', 'formatter' => 'intval'),
    'float' => array('name' => 'float', 'formatter' => 'floatval'),
    'datetime' => array('name' => 'datetime', 'format' => 'Y-m-d H:i:s', 'formatter' => 'date'),
    'timestamp' => array('name' => 'timestamp', 'format' => 'Y-m-d H:i:s', 'formatter' => 'date'),
    'time' => array('name' => 'time', 'format' => 'H:i:s', 'formatter' => 'date'),
    'date' => array('name' => 'date', 'format' => 'Y-m-d', 'formatter' => 'date'),
    'binary' => array('name' => 'blob'),
    'boolean' => array('name' => 'tinyint', 'limit' => '1')
)

`$description` ¶

public string

Datasource description

"MySQL DBO Driver"

`$endQuote` ¶

public string

End quote

"`"

`$fieldParameters` ¶

public array

List of engine specific additional field parameters used on table creating

array(
    'charset' => array('value' => 'CHARACTER SET', 'quote' => false, 'join' => ' ', 'column' => false, 'position' => 'beforeDefault'),
    'collate' => array('value' => 'COLLATE', 'quote' => false, 'join' => ' ', 'column' => 'Collation', 'position' => 'beforeDefault'),
    'comment' => array('value' => 'COMMENT', 'quote' => true, 'join' => ' ', 'column' => 'Comment', 'position' => 'afterDefault')
)

`$startQuote` ¶

public string

Start quote

"`"

`$tableParameters` ¶

public array

List of table engine specific parameters used on table creating

array(
    'charset' => array('value' => 'DEFAULT CHARSET', 'quote' => false, 'join' => '=', 'column' => 'charset'),
    'collate' => array('value' => 'COLLATE', 'quote' => false, 'join' => '=', 'column' => 'Collation'),
    'engine' => array('value' => 'ENGINE', 'quote' => false, 'join' => '=', 'column' => 'Engine')
)

Packages

Classes

Class Mysql

Properties summary

Inherited Properties

Method Summary

_alterIndexes() protected

_alterTableParameters() protected

alterSchema() public

column() public

connect() public

delete() public

describe() public

dropSchema() public

enabled() public

fetchResult() public

getCharsetName() public

getEncoding() public

getSchemaName() public

getVersion() public

index() public

listDetailedSources() public

listSources() public

resultSet() public

setEncoding() public

update() public

Method Detail

_alterIndexes() protected ¶

Parameters

Returns

_alterTableParameters() protected ¶

Parameters

Returns

alterSchema() public ¶

Parameters

Returns

Overrides

column() public ¶

Parameters

Returns

Overrides

connect() public ¶

Returns

Throws

delete() public ¶

Parameters

Returns

Overrides

describe() public ¶

Parameters

Returns

Throws

Overrides

dropSchema() public ¶

Parameters

Returns

Overrides

enabled() public ¶

Returns

Overrides

fetchResult() public ¶

Returns

Overrides

getCharsetName() public ¶

Parameters

Returns

getEncoding() public ¶

Returns

getSchemaName() public ¶

Returns

Overrides

getVersion() public ¶

Returns

index() public ¶

Parameters

Returns

Overrides

listDetailedSources() public ¶

Parameters

Returns