CodeIgniter v4.5 API

PreparedQuery extends BasePreparedQuery
in package

Prepared query for Postgre

Tags
extends

BasePreparedQuery<resource, resource, resource>

Table of Contents

Properties

$db  : Connection
A reference to the db connection to use.
$errorCode  : int
The error code, if any.
$errorString  : string
The error message, if any.
$parameters  : array<string|int, mixed>
Parameters array used to store the dynamic variables.
$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
Takes a new set of data and runs it against the currently prepared query.
_getResult()  : resource|null
Returns the statement resource for the prepared query or false when preparing failed.
_prepare()  : $this
Prepares the query against the database, and saves the connection info necessary to execute the query later.
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
Deallocate prepared statements.
parameterize()  : array<string|int, mixed>
Handle parameters.

Properties

$parameters

Parameters array used to store the dynamic variables.

protected array<string|int, mixed> $parameters = []

$statement

The prepared statement itself.

protected object|resource|null $statement
Tags
phpstan-var

TStatement|null

Methods

_execute()

Takes a new set of data and runs it against the currently prepared query.

public _execute(array<string|int, mixed> $data) : bool
Parameters
$data : array<string|int, mixed>
Return values
bool

_getResult()

Returns the statement resource for the prepared query or false when preparing failed.

public _getResult() : resource|null
Return values
resource|null

_prepare()

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 = [] ]) : $this

NOTE: This version is based on SQL code. Child classes should override this method.

Parameters
$sql : string
$options : array<string|int, mixed> = []

Options takes an associative array;

Tags
throws
DatabaseException
Return values
$this

close()

Explicitly closes the prepared statement.

public close() : bool
Tags
throws
BadMethodCallException
Return values
bool

execute()

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
phpstan-return

bool|ResultInterface<TConnection, TResult>

throws
DatabaseException
Return values
bool|ResultInterface

getErrorCode()

Returns the error code created while executing this statement.

public getErrorCode() : int
Return values
int

getErrorMessage()

Returns the error message created while executing this statement.

public getErrorMessage() : string
Return values
string

getQueryString()

Returns the SQL that has been prepared.

public getQueryString() : string
Return values
string

hasError()

A helper to determine if any error exists.

public hasError() : bool
Return values
bool

prepare()

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()

Deallocate prepared statements.

protected _close() : bool
Return values
bool

parameterize()

Handle parameters.

protected parameterize(string $queryString) : array<string|int, mixed>
Parameters
$queryString : string
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results