Docs For Class atkMySQLiStatement

Home

Documentation home

Atk index

Docs For Class atkMySQLiStatement [ package: atk ]

Class: atkMySQLiStatement

Source Location: /db/statement/class.atkmysqlistatement.inc

Class atkMySQLiStatement

Class Overview

MySQLi statement implementation.

Located in /db/statement/class.atkmysqlistatement.inc [line 27]

Wiki documentation

atkStatement
   |
   --atkMySQLiStatement

Author(s):

Peter C. Verhage <peter@achievo.org>

Information Tags:

Properties

Methods

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkStatement atkStatement::$m_bindPositions atkStatement::$m_latestParams atkStatement::$m_parsedQuery atkStatement::$m_position atkStatement::$m_query	Inherited From atkStatement atkStatement::__construct() Constructs a new statement for the given query. atkStatement::close() Close this statement. atkStatement::execute() Executes the statement. atkStatement::fetch() Fetches the next row from the result set. atkStatement::getAffectedRowCount() Returns the number of affected rows in case of an INSERT, UPDATE or DELETE query. atkStatement::getAllRows() Get all rows for the given query. atkStatement::getAllRowsAssoc() Get rows in an associative array with the given column used as key for the rows. atkStatement::getAllValues() Get an array with all the values in the specified column. atkStatement::getAllValuesAssoc() Get rows in an associative array with the given key column used as key and the given value column used as value. atkStatement::getDb() Returns the database instance. atkStatement::getFirstRow() Returns the first row. atkStatement::getFirstValue() Get the value of the first (or the given) column of the first row in the result. atkStatement::getIterator() Returns an iterator for iterating over the result rows for this statement. atkStatement::getQuery() Returns the query on which this statement is based. atkStatement::reset() Resets this statement so that it can be re-used again. atkStatement::rewind() Moves the cursor back to the beginning of the result set. atkStatement::_close() Frees up all resources for this statement. The statement cannot be re-used anymore. atkStatement::_execute() Executes the statement using the given bind parameters. atkStatement::_fetch() Fetches the next row from the result set. atkStatement::_getAffectedRowCount() Returns the number of affected rows in case of an INSERT, UPDATE or DELETE query. Called immediatly after atkStatement::_execute(). atkStatement::_getBindPositions() Returns the positions for the bind parameters in the query. atkStatement::_getLatestParams() Get latest execution parameters. atkStatement::_getParsedQuery() Returns the parsed query for this statement (e.g. named bind parameters are replaced by anonymous bind parameters). atkStatement::_parse() Parses the query. Named bind parameters are replaced by anonymous bind parameters and the positions of the different named/anonymous bind parameters are made available for later use. atkStatement::_prepare() Prepares the statement for execution. atkStatement::_reset() Resets the statement so that it can be re-used again. atkStatement::_validateParams() Validates if all bind parameters are supplied. atkStatement::__destruct() Destructor.

Inherited Properties

Inherited Methods

Inherited From atkStatement

atkStatement::$m_bindPositions

atkStatement::$m_latestParams

atkStatement::$m_parsedQuery

atkStatement::$m_position

atkStatement::$m_query

Inherited From atkStatement

atkStatement::__construct()

Constructs a new statement for the given query.

atkStatement::close()

Close this statement.

atkStatement::execute()

Executes the statement.

atkStatement::fetch()

Fetches the next row from the result set.

atkStatement::getAffectedRowCount()

Returns the number of affected rows in case of an INSERT, UPDATE or DELETE query.

atkStatement::getAllRows()

Get all rows for the given query.

atkStatement::getAllRowsAssoc()

Get rows in an associative array with the given column used as key for the rows.

atkStatement::getAllValues()

Get an array with all the values in the specified column.

atkStatement::getAllValuesAssoc()

Get rows in an associative array with the given key column used as key and the given value column used as value.

atkStatement::getDb()

Returns the database instance.

atkStatement::getFirstRow()

Returns the first row.

atkStatement::getFirstValue()

Get the value of the first (or the given) column of the first row in the result.

atkStatement::getIterator()

Returns an iterator for iterating over the result rows for this statement.

atkStatement::getQuery()

Returns the query on which this statement is based.

atkStatement::reset()

Resets this statement so that it can be re-used again.

atkStatement::rewind()

Moves the cursor back to the beginning of the result set.

atkStatement::_close()

Frees up all resources for this statement. The statement cannot be re-used anymore.

atkStatement::_execute()

Executes the statement using the given bind parameters.

atkStatement::_fetch()

Fetches the next row from the result set.

atkStatement::_getAffectedRowCount()

Returns the number of affected rows in case of an INSERT, UPDATE or DELETE query. Called immediatly after atkStatement::_execute().

atkStatement::_getBindPositions()

Returns the positions for the bind parameters in the query.

atkStatement::_getLatestParams()

Get latest execution parameters.

atkStatement::_getParsedQuery()

Returns the parsed query for this statement (e.g. named bind parameters are replaced by anonymous bind parameters).

atkStatement::_parse()

Parses the query. Named bind parameters are replaced by anonymous bind parameters and the positions of the different named/anonymous bind parameters are made available for later use.

atkStatement::_prepare()

Prepares the statement for execution.

atkStatement::_reset()

Resets the statement so that it can be re-used again.

atkStatement::_validateParams()

Validates if all bind parameters are supplied.

atkStatement::__destruct()

Destructor.

[ Top ]

Property Summary

array	$m_columnNames	Column names.
MySQLi_Statement	$m_stmt	MySQLi statement.
array	$m_values	Row value bindings.

[ Top ]

Method Summary

int	getInsertId()	Returns the auto-generated id used in the last query.
void	rewind()	Moves the cursor back to the beginning of the result set.
void	_bindParams()	Bind statement parameters.
void	_bindResult()	Bind result columns to values array so we can read the result when fetching rows.
void	_close()	Frees up all resources for this statement. The statement cannot be re-used anymore.
void	_execute()	Executes the statement using the given bind parameters.
array	_fetch()	Fetches the next row from the result set.
void	_getAffectedRowCount()	Returns the number of affected rows in case of an INSERT, UPDATE or DELETE query. Called immediatly after atkStatement::_execute().
void	_prepare()	Prepares the statement for execution.
void	_reset()	Resets the statement so that it can be re-used again.
void	_storeColumnNames()	Store the column names from this statement's metadata.

[ Top ]

Properties

array $m_columnNames = null [line 41]

Column names.

API Tags:

Access:

private

[ Top ]

MySQLi_Statement $m_stmt [line 34]

MySQLi statement.

API Tags:

Access:

private

[ Top ]

array $m_values = null [line 48]

Row value bindings.

API Tags:

Access:

private

[ Top ]

Methods

getInsertId [line 251]

int getInsertId(
)

Returns the auto-generated id used in the last query.

API Tags:

Return:	auto-generated id
Access:	public

[ Top ]

rewind [line 76]

void rewind(
)

Moves the cursor back to the beginning of the result set.

NOTE: Depending on the database driver, using this method might result in the query to be executed again.

API Tags:

Access:

public

Redefinition of:

atkStatement::rewind(): Moves the cursor back to the beginning of the result set.

[ Top ]

_bindParams [line 91]

void _bindParams(
array
$params 
)

Bind statement parameters.

Parameters:

array

$params:

parameters

API Tags:

Access:

private

[ Top ]

_bindResult [line 145]

void _bindResult(
)

Bind result columns to values array so we can read the result when fetching rows.

API Tags:

Access:

private

[ Top ]

_close [line 232]

void _close(
)

Frees up all resources for this statement. The statement cannot be re-used anymore.

API Tags:

Access:

public

Redefinition of:

atkStatement::_close(): Frees up all resources for this statement. The statement cannot be re-used anymore.

[ Top ]

_execute [line 172]

void _execute(
array
$params 
)

Executes the statement using the given bind parameters.

Parameters:

array

$params:

bind parameters

API Tags:

Access:

protected

Redefinition of:

atkStatement::_execute(): Executes the statement using the given bind parameters.

[ Top ]

_fetch [line 202]

array _fetch(
)

Fetches the next row from the result set.

API Tags:

Return:	next row from the result set (false if no other rows exist)
Access:	protected

Redefinition of:

atkStatement::_fetch(): Fetches the next row from the result set.

[ Top ]

_getAffectedRowCount [line 241]

void _getAffectedRowCount(
)

Returns the number of affected rows in case of an INSERT, UPDATE or DELETE query. Called immediatly after atkStatement::_execute().

API Tags:

Access:

protected

Redefinition of:

atkStatement::_getAffectedRowCount(): Returns the number of affected rows in case of an INSERT, UPDATE or DELETE query. Called immediatly after atkStatement::_execute().

[ Top ]

_prepare [line 53]

void _prepare(
)

Prepares the statement for execution.

API Tags:

Access:

protected

Redefinition of:

atkStatement::_prepare(): Prepares the statement for execution.

[ Top ]

_reset [line 222]

void _reset(
)

Resets the statement so that it can be re-used again.

API Tags:

Access:

protected

Redefinition of:

atkStatement::_reset(): Resets the statement so that it can be re-used again.

[ Top ]

_storeColumnNames [line 114]

void _storeColumnNames(
)

Store the column names from this statement's metadata.

API Tags:

Access:

private

[ Top ]