Docs For Class MysqlConnector

Description

Implements interfaces:

IConnector

IConnector implementation for the PHP MySQL database extension.

Located in /MysqlConnector.php (line 43)

BaseConnector
   |
   --MysqlConnector

Class Constant Summary

PARAM_ADD_SLASHES = "paramAddSlashes"

Method Summary

MysqlConnector MysqlConnector (array $connection, [array $options = array()])

string build (string $query, [array $options = array()])

int delete (string $query, [array $param = array()], [array $map = array()], [array $options = array()])

array fetch (resource $stmt, [array $options = array()])

int insert (string $query, [array $param = array()], [array $map = array()], [array $options = array()])

bool open (array $connection)

array select (string $query, [array $param = array()], [array $map = array()], [array $options = array()])

string strEscape (string $value, [array $options = array()])

int update (string $query, [array $param = array()], [array $map = array()], [array $options = array()])

Variables

Inherited Variables

Inherited from BaseConnector

BaseConnector::$cache
BaseConnector::$conn
BaseConnector::$options

Methods

Constructor MysqlConnector (line 61)

Open a connection to a MySQL Server and set global options.

access: public

MysqlConnector MysqlConnector (array $connection, [array $options = array()])

array $connection: An associated array of connection settings, like host and user name.
array $options: An associated array of global options for the resulting instance.

build (line 300)

Add a LIMIT x y statement to a SQL SELECT query when the IConnector::RESULT_LENGTH or IConnector::RESULT_OFFSET is set.

return: A modified SQL query.
access: protected

string build (string $query, [array $options = array()])

string $query: A SQL query to execute on a database.
array $options: An associated array of options.

delete (line 249)

Send a SQL DELETE query to the database and get the number of rows deleted by the query.

return: The number of rows deleted by the query.
see: IConnector::delete().
throws: Exception when $param doesn't match the type definition $map.
access: public

int delete (string $query, [array $param = array()], [array $map = array()], [array $options = array()])

string $query: A SQL query to execute on a database.
array $param: An associated array of values to be used in the $query.
array $map: An array of type definitions for the $param values.
array $options: An associated array of options, see the Option elements.

Implementation of:

IConnector::delete(): Send a SQL DELETE query to the database and get the number of rows deleted by the query.

fetch (line 329)

Fetch multiple rows of a query result.

If the IConnector::RESULT_LENGTH or IConnector::RESULT_OFFSET options are set, some rows are omitted from the beginning and/or the end of the query result. If the IConnector::RESULT_KEY_FIELD option is set, the resulting table is an associated array of rows.

return: The query result as a table (array of associated arrays).
access: protected

array fetch (resource $stmt, [array $options = array()])

resource $stmt: A statement resource corresponding to an executed statement.
array $options: An associated array of options.

insert (line 172)

Send a SQL INSERT query to the database and get the IDENTITY ID generated from the last INSERT operation (if any).

return: The IDENTITY ID of the last inserted row.
see: IConnector::insert().
throws: Exception when $param doesn't match the type definition $map.
access: public

int insert (string $query, [array $param = array()], [array $map = array()], [array $options = array()])

string $query: A SQL query to execute on a database.
array $param: An associated array of values to be used in the $query.
array $map: An array of type definitions for the $param values.
array $options: An associated array of options, see the Option elements.

Implementation of:

IConnector::insert(): Send a SQL INSERT query to the database and get the IDENTITY ID generated from the last INSERT operation (if any).

open (line 88)

Open a database connection.

return: true, if a database connection was successfully opened, false otherwise.
access: protected

bool open (array $connection)

array $connection: An associated array of connection settings, like host and user name.

select (line 126)

Send a SQL SELECT query to the database and get the query result.

return: The query result as a table (array of associated arrays).
see: IConnector::select().
throws: Exception when $param doesn't match the type definition $map.
access: public

array select (string $query, [array $param = array()], [array $map = array()], [array $options = array()])

string $query: A SQL query to execute on a database.
array $param: An associated array of values to be used in the $query.
array $map: An array of type definitions for the $param values.
array $options: An associated array of options, see the Option elements.

Implementation of:

IConnector::select(): Send a SQL SELECT query to the database and get the query result.

strEscape (line 282)

Escape special characters in a string parameter.

return: The escaped string.
access: protected

string strEscape (string $value, [array $options = array()])

string $value: The string to be escaped.
array $options: An associated array of options.

Redefinition of:

BaseConnector::strEscape(): Escape special characters in a string parameter.

update (line 211)

Send a SQL UPDATE query to the database and get the number of rows updates by the query.

return: The number of rows updates by the query.
see: IConnector::update().
throws: Exception when $param doesn't match the type definition $map.
access: public

int update (string $query, [array $param = array()], [array $map = array()], [array $options = array()])

string $query: A SQL query to execute on a database.
array $param: An associated array of values to be used in the $query.
array $map: An array of type definitions for the $param values.
array $options: An associated array of options, see the Option elements.

Implementation of:

IConnector::update(): Send a SQL UPDATE query to the database and get the number of rows updates by the query.

Inherited Methods

Inherited From BaseConnector

BaseConnector::BaseConnector()
BaseConnector::bind()
BaseConnector::cast()
BaseConnector::castArray()
BaseConnector::castBool()
BaseConnector::castDate()
BaseConnector::castFloat()
BaseConnector::castInt()
BaseConnector::castNull()
BaseConnector::castNumeric()
BaseConnector::castObject()
BaseConnector::castString()
BaseConnector::commit()
BaseConnector::getCache()
BaseConnector::getHash()
BaseConnector::getLink()
BaseConnector::getOptions()
BaseConnector::lookup()
BaseConnector::push()
BaseConnector::rollback()
BaseConnector::setCache()
BaseConnector::setOptions()
BaseConnector::strDecode()
BaseConnector::strEncode()
BaseConnector::strEscape()
BaseConnector::strQuote()
BaseConnector::strStrip()
BaseConnector::transaction()

Class Constants

PARAM_ADD_SLASHES = "paramAddSlashes" (line 50)

List of additional escape characters for MySQL string parameters.