Docs For Class PreparedStatementCommon

PreparedStatementCommon __construct(
Connection
$conn, string
$sql, array
$positions, restult
$stmt)

Create new prepared statement instance.

Tags:

access:

public

Overridden in child classes as:

MSSQLCallableStatement::__construct(): Construct new MSSQLCallableStatement.

Parameters:

object	$conn	Connection object
string	$sql	The SQL to work with.
array	$positions	The positions in SQL of ?'s.
restult	$stmt	If the driver supports prepared queries, then $stmt will contain the statement to use.

[ Top ]

void close(
)

Nothing to close for emulated prepared statements.

Tags:

access:

public

Overridden in child classes as:

MSSQLCallableStatement::close()

OCI8PreparedStatement::close(): Because MySQL doesn't support prepared statements, this does nothing.

[ Top ]

string escape(
string
$str)

Escapes special characters (usu. quotes) using native driver function.

Tags:

return:	The escaped string.
access:	protected
abstract:

Overridden in child classes as:

MSSQLPreparedStatement::escape(): Add quotes using str_replace.

MySQLPreparedStatement::escape(): Quotes string using native mysql function.

ODBCPreparedStatement::escape()

OCI8PreparedStatement::escape(): ' -> ''

PgSQLPreparedStatement::escape(): Quotes string using native pgsql function (pg_escape_string).

SQLitePreparedStatement::escape(): Quotes string using native sqlite_escape_string() function.

Parameters:

string

$str

The input string.

[ Top ]

ResultSet executeQuery(
[mixed
$p1 = null], [int
$fetchmode = null])

Executes the SQL query in this PreparedStatement object and returns the resultset generated by the query.

We support two signatures for this method:

$stmt->executeQuery(ResultSet::FETCHMODE_NUM);
$stmt->executeQuery(array($param1, $param2), ResultSet::FETCHMODE_NUM);

Tags:

access:	public
throws:	SQLException if a database access error occurs.

Overridden in child classes as:

MSSQLPreparedStatement::executeQuery(): MSSQL must emulate OFFSET/LIMIT support.

MSSQLCallableStatement::executeQuery()

ODBCPreparedStatement::executeQuery()

OCI8PreparedStatement::executeQuery(): Executes the SQL query in this PreparedStatement object and returns the resultset generated by the query.

Parameters:

mixed	$p1	Either (array) Parameters that will be set using PreparedStatement::set() before query is executed or (int) fetchmode.
int	$fetchmode	The mode to use when fetching the results (e.g. ResultSet::FETCHMODE_NUM, ResultSet::FETCHMODE_ASSOC).

[ Top ]

int executeUpdate(
[array
$params = null])

Executes the SQL INSERT, UPDATE, or DELETE statement in this PreparedStatement object.

Tags:

return:	Number of affected rows (or 0 for drivers that return nothing).
access:	public
throws:	SQLException if a database access error occurs.

Overridden in child classes as:

ODBCPreparedStatement::executeUpdate()

OCI8PreparedStatement::executeUpdate(): Executes the SQL INSERT, UPDATE, or DELETE statement in this PreparedStatement object.

Parameters:

array

$params

Parameters that will be set using PreparedStatement::set() before query is executed.

[ Top ]

void getConnection(
)

Tags:

access:	public
see:	PreparedStatement::getConnection()

[ Top ]

void getLimit(
)

Tags:

access:	public
see:	PreparedStatement::getLimit()

[ Top ]

void getMoreResults(
)

Tags:

access:	public
see:	PreparedStatement::getMoreResults()

Overridden in child classes as:

MSSQLCallableStatement::getMoreResults()

[ Top ]

void getOffset(
)

Tags:

access:	public
see:	PreparedStatement::getOffset()

[ Top ]

null getResource(
)

Statement resources do not exist for emulated prepared statements, so this just returns

null

.

Tags:

access:

public

Overridden in child classes as:

MSSQLCallableStatement::getResource()

[ Top ]

void getResultSet(
)

Tags:

access:	public
see:	PreparedStatement::getResultSet()

[ Top ]

void getUpdateCount(
)

Tags:

access:	public
see:	PreparedStatement::getUpdateCount()

[ Top ]

string replaceParams(
)

Replaces placeholders with the specified parameter values in the SQL.

This is for emulated prepared statements.

Tags:

return:	New SQL statement with parameters replaced.
access:	protected
throws:	SQLException - if param not bound.

Overridden in child classes as:

ODBCPreparedStatement::replaceParams(): This does nothing since ODBC natively supports prepared statements.

[ Top ]

void set(
int
$paramIndex, mixed
$value)

A generic set method.

You can use this if you don't want to concern yourself with the details. It involves slightly more overhead than the specific settesr, since it grabs the PHP type to determine which method makes most sense.

Tags:

throws:

SQLException

Parameters:

int	$paramIndex
mixed	$value

[ Top ]

void setArray(
int
$paramIndex, array
$value)

Sets an array.

Unless a driver-specific method is used, this means simply serializing the passed parameter and storing it as a string.

Overridden in child classes as:

MSSQLCallableStatement::setArray()

PgSQLPreparedStatement::setArray(): Sets an array.

Parameters:

int	$paramIndex
array	$value

[ Top ]

void setBlob(
mixed
$paramIndex, mixed
$blob)

Tags:

see:

PreparedStatement::setBlob()

Overridden in child classes as:

MSSQLPreparedStatement::setBlob(): MSSQL-specific implementation of setBlob().

MSSQLCallableStatement::setBlob()

ODBCPreparedStatement::setBlob()

OCI8PreparedStatement::setBlob()

PgSQLPreparedStatement::setBlob(): Applies sqlite_udf_encode_binary() to ensure that binary contents will be handled correctly by sqlite.

SQLitePreparedStatement::setBlob(): Applies sqlite_udf_encode_binary() to ensure that binary contents will be handled correctly by sqlite.

[ Top ]

void setBoolean(
int
$paramIndex, boolean
$value)

Sets a boolean value.

Default behavior is true = 1, false = 0.

Overridden in child classes as:

MSSQLCallableStatement::setBoolean()

PgSQLPreparedStatement::setBoolean(): For setting value of Postgres BOOLEAN column.

Parameters:

int	$paramIndex
boolean	$value

[ Top ]

void setClob(
mixed
$paramIndex, mixed
$clob)

Tags:

see:

PreparedStatement::setClob()

Overridden in child classes as:

MSSQLCallableStatement::setClob()

ODBCPreparedStatement::setClob()

OCI8PreparedStatement::setClob()

[ Top ]

void setDate(
int
$paramIndex, string
$value)

Overridden in child classes as:

MSSQLCallableStatement::setDate()

Parameters:

int	$paramIndex
string	$value

[ Top ]

void setDecimal(
int
$paramIndex, double
$value)

Parameters:

int	$paramIndex
double	$value

[ Top ]

void setDouble(
int
$paramIndex, double
$value)

Parameters:

int	$paramIndex
double	$value

[ Top ]

void setFloat(
int
$paramIndex, float
$value)

Overridden in child classes as:

MSSQLCallableStatement::setFloat()

Parameters:

int	$paramIndex
float	$value

[ Top ]

void setInt(
int
$paramIndex, int
$value)

Overridden in child classes as:

MSSQLCallableStatement::setInt()

Parameters:

int	$paramIndex
int	$value

[ Top ]

void setInteger(
int
$paramIndex, int
$value)

Alias for setInt()

Parameters:

int	$paramIndex
int	$value

[ Top ]

void setLimit(
mixed
$v)

Tags:

access:	public
see:	PreparedStatement::setLimit()

[ Top ]

void setNull(
int
$paramIndex)

Overridden in child classes as:

MSSQLCallableStatement::setNull()

ODBCPreparedStatement::setNull()

Parameters:

int

$paramIndex

[ Top ]

void setOffset(
mixed
$v)

Tags:

access:	public
see:	PreparedStatement::setOffset()

[ Top ]

void setString(
int
$paramIndex, string
$value)

Overridden in child classes as:

MSSQLCallableStatement::setString()

Parameters:

int	$paramIndex
string	$value

[ Top ]

void setTime(
int
$paramIndex, string
$value)

Overridden in child classes as:

MSSQLCallableStatement::setTime()

Parameters:

int	$paramIndex
string	$value

[ Top ]

void setTimestamp(
int
$paramIndex, string
$value)

Overridden in child classes as:

MSSQLCallableStatement::setTimestamp()

Parameters:

int	$paramIndex
string	$value

[ Top ]

Class: PreparedStatementCommon

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

$boundInVars = array()

Tags:

$conn =

Tags:

$limit = 0

Tags:

$offset = 0

Tags:

$positions =

Tags:

$positionsCount =

Tags:

$resultSet =

Tags:

$sql =

Tags:

$updateCount =

Tags:

Class Methods

constructor __construct [line 100]

Tags:

Parameters:

method close [line 205]

Tags:

method escape [line 302]

Tags:

Parameters:

method executeQuery [line 248]

Tags:

Parameters:

method executeUpdate [line 282]

Tags:

Parameters:

method getConnection [line 187]

Tags:

method getLimit [line 137]

Tags:

method getMoreResults [line 177]

Tags:

method getOffset [line 153]

Tags:

method getResource [line 197]

Tags:

method getResultSet [line 161]

Tags:

method getUpdateCount [line 169]

Tags:

method replaceParams [line 217]

Tags:

method set [line 316]

Tags:

Parameters:

method setArray [line 351]

Parameters:

method setBlob [line 380]

Tags:

method setBoolean [line 367]

Parameters:

method setClob [line 396]

Tags:

method setDate [line 414]

Parameters:

method setDecimal [line 430]

Parameters:

method setDouble [line 444]

Parameters:

method setFloat [line 458]

Parameters:

method setInt [line 472]

Parameters: