BasePreparedQuery
in package
implements
PreparedQueryInterface
Tags
Table of Contents
Interfaces
Properties
- $db : BaseConnection
- A reference to the db connection to use.
- $errorCode : int
- The error code, if any.
- $errorString : string
- The error message, if any.
- $query : Query
- Holds the prepared query object that is cloned during execute.
- $statement : object|resource|null
- The prepared statement itself.
Methods
- __construct() : mixed
- _execute() : bool
- The database dependant version of the execute method.
- _getResult() : object|resource|null
- Returns the result object for the prepared query.
- _prepare() : $this
- The database-dependent portion of the prepare statement.
- close() : bool
- Explicitly closes the prepared statement.
- execute() : bool|ResultInterface
- Takes a new set of data and runs it against the currently prepared query. Upon success, will return a Results object.
- getErrorCode() : int
- Returns the error code created while executing this statement.
- getErrorMessage() : string
- Returns the error message created while executing this statement.
- getQueryString() : string
- Returns the SQL that has been prepared.
- hasError() : bool
- A helper to determine if any error exists.
- prepare() : $this
- Prepares the query against the database, and saves the connection info necessary to execute the query later.
- _close() : bool
- The database-dependent version of the close method.
Properties
$db
A reference to the db connection to use.
protected
BaseConnection
$db
Tags
$errorCode
The error code, if any.
protected
int
$errorCode
$errorString
The error message, if any.
protected
string
$errorString
$query
Holds the prepared query object that is cloned during execute.
protected
Query
$query
$statement
The prepared statement itself.
protected
object|resource|null
$statement
Tags
Methods
__construct()
public
__construct(BaseConnection $db) : mixed
Parameters
- $db : BaseConnection
_execute()
The database dependant version of the execute method.
public
abstract _execute(array<string|int, mixed> $data) : bool
Parameters
- $data : array<string|int, mixed>
Return values
bool_getResult()
Returns the result object for the prepared query.
public
abstract _getResult() : object|resource|null
Return values
object|resource|null_prepare()
The database-dependent portion of the prepare statement.
public
abstract _prepare(string $sql[, array<string|int, mixed> $options = [] ]) : $this
Parameters
- $sql : string
- $options : array<string|int, mixed> = []
Return values
$thisclose()
Explicitly closes the prepared statement.
public
close() : bool
Tags
Return values
boolexecute()
Takes a new set of data and runs it against the currently prepared query. Upon success, will return a Results object.
public
execute(mixed ...$data) : bool|ResultInterface
Parameters
- $data : mixed
Tags
Return values
bool|ResultInterfacegetErrorCode()
Returns the error code created while executing this statement.
public
getErrorCode() : int
Return values
intgetErrorMessage()
Returns the error message created while executing this statement.
public
getErrorMessage() : string
Return values
stringgetQueryString()
Returns the SQL that has been prepared.
public
getQueryString() : string
Return values
stringhasError()
A helper to determine if any error exists.
public
hasError() : bool
Return values
boolprepare()
Prepares the query against the database, and saves the connection info necessary to execute the query later.
public
prepare(string $sql[, array<string|int, mixed> $options = [] ][, string $queryClass = Query::class ]) : $this
NOTE: This version is based on SQL code. Child classes should override this method.
Parameters
- $sql : string
- $options : array<string|int, mixed> = []
- $queryClass : string = Query::class
Return values
$this_close()
The database-dependent version of the close method.
protected
abstract _close() : bool