Documentation

Pdo extends AbstractAdapter
in package

PDO database adapter class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
6.5.0

Table of Contents

Properties

$connection  : mixed
Database connection object/resource
$dsn  : string|null
PDO DSN
$error  : mixed
Error string/object/resource
$listener  : mixed
Query listener object/resource
$options  : array<string|int, mixed>
Database connection options
$placeholder  : string|null
Statement placeholder
$profiler  : Profiler|null
Query profiler
$result  : mixed
Result object/resource
$statement  : mixed
Statement object/resource
$statementResult  : bool
Statement result
$transactionManager  : Manager|null
Transaction manager
$type  : string|null
PDO type

Methods

__construct()  : mixed
Constructor
beginTransaction()  : Pdo
Begin a transaction
bindColumn()  : Pdo
Bind a column to a PHP variable.
bindParam()  : Pdo
Bind a parameter for a prepared SQL query
bindParams()  : Pdo
Bind parameters to a prepared SQL query
bindValue()  : Pdo
Bind a value for a prepared SQL query
clearError()  : AbstractAdapter
Clear the error
clearProfiler()  : AbstractAdapter
Clear query profiler
closeCursor()  : bool
Method closes the cursor, translating the request in the ready state.
commit()  : Pdo
Commit a transaction
connect()  : Pdo
Connect to the database
createSchema()  : Schema
Create Schema builder
createSql()  : Sql
Create SQL builder
dbFileExists()  : bool
Does the database file exist
debugDumpParams()  : string
The method displays information about the prepared SQL command for debugging purposes.
delete()  : int
Directly execute a DELETE SQL query or prepared statement and return the results
disconnect()  : void
Disconnect from the database
escape()  : string
Escape the value
exec()  : Pdo
The method runs an SQL query for execution and returns the number of rows affected during execution.
execute()  : Pdo
Execute a prepared SQL query
executeSql()  : AbstractAdapter
Execute a SQL query or prepared statement with params
fetch()  : mixed
Fetch and return a row from the result
fetchAll()  : array<string|int, mixed>
Fetch and return all rows from the result
fetchColumn()  : mixed
The method receives data of one column from the next row of the result set.
getAttribute()  : string
The method of obtaining the value of the request attribute PDO.
getConnection()  : mixed
Get the connection object/resource
getCountOfFields()  : int
The method returns the number of columns in the result set.
getCountOfRows()  : int
The method returns the number of rows modified by the last SQL query.
getDsn()  : string|null
Return the DSN
getError()  : mixed
Get the error
getLastId()  : int
Return the last ID of the last query
getListener()  : mixed
Get query listener
getNumberOfAffectedRows()  : int
Return the number of affected rows from the last query
getNumberOfFields()  : int
Return the number of fields in the result.
getNumberOfRows()  : int
Return the number of rows from the last query
getOptions()  : array<string|int, mixed>
Get database connection options
getProfiler()  : Profiler|null
Get query profiler
getResult()  : mixed
Get the result object/resource
getStatement()  : mixed
Get the statement object/resource
getTables()  : array<string|int, mixed>
Return the tables in the database
getTransactionDepth()  : int
Get transaction depth
getType()  : string|null
Return the type
getVersion()  : string
Return the database version
hasError()  : bool
Determine whether or not there is an error
hasOptions()  : bool
Has database connection options
hasResult()  : bool
Determine whether or not a result resource exists
hasStatement()  : bool
Determine whether or not a statement resource exists
hasTable()  : bool
Return if the database has a table
insert()  : int
Directly execute an INSERT SQL query or prepared statement and return the results
inTransaction()  : bool
Method checks, whether the transaction is initiated.
isConnected()  : bool
Determine whether or not connected
isSuccess()  : bool
Check if transaction is success
isTransaction()  : bool
Check if adapter is in the middle of an open transaction
listen()  : mixed
Add query listener to the adapter
prepare()  : Pdo
Prepare a SQL query
query()  : Pdo
Execute a SQL query directly
rollback()  : Pdo
Rollback a transaction
select()  : array<string|int, mixed>
Directly execute a SELECT SQL query or prepared statement and return the results
setAttribute()  : bool
Method sets the value of the request attribute PDO.
setError()  : AbstractAdapter
Set the error
setOptions()  : Pdo
Set database connection options
setProfiler()  : AbstractAdapter
Set query profiler
throwError()  : void
Throw a database error exception
transaction()  : void
Execute complete transaction with the DB adapter
update()  : int
Directly execute an UPDATE SQL query or prepared statement and return the results
buildError()  : Pdo
Build the error
getErrorMessage()  : string|null
Get the error message
getTransactionManager()  : Manager
Return the transaction manager object, initialize on first use

Properties

$connection

Database connection object/resource

protected mixed $connection = null

$dsn

PDO DSN

protected string|null $dsn = null

$listener

Query listener object/resource

protected mixed $listener = null

$options

Database connection options

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

$placeholder

Statement placeholder

protected string|null $placeholder = null

$statement

Statement object/resource

protected mixed $statement = null

$statementResult

Statement result

protected bool $statementResult = false

$type

PDO type

protected string|null $type = null

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $options = [] ]) : mixed

Instantiate the database connection object using PDO

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

beginTransaction()

Begin a transaction

public beginTransaction() : Pdo
Return values
Pdo

bindColumn()

Bind a column to a PHP variable.

public bindColumn(mixed $column, mixed $param[, int $dataType = PDO::PARAM_STR ]) : Pdo
Parameters
$column : mixed

Number of the column (1-indexed) or name of the column in the result set.

$param : mixed

Name of the PHP variable to which the column will be bound.

$dataType : int = PDO::PARAM_STR

Data type of the parameter, specified by the PDO::PARAM_* constants.

Return values
Pdo

bindParam()

Bind a parameter for a prepared SQL query

public bindParam(mixed $param, mixed &$value[, int $dataType = PDO::PARAM_STR ][, int|null $length = null ][, mixed $options = null ]) : Pdo
Parameters
$param : mixed
$value : mixed
$dataType : int = PDO::PARAM_STR
$length : int|null = null
$options : mixed = null
Return values
Pdo

bindParams()

Bind parameters to a prepared SQL query

public bindParams(array<string|int, mixed> $params) : Pdo
Parameters
$params : array<string|int, mixed>
Return values
Pdo

bindValue()

Bind a value for a prepared SQL query

public bindValue(mixed $param, mixed $value[, int $dataType = PDO::PARAM_STR ]) : Pdo
Parameters
$param : mixed
$value : mixed
$dataType : int = PDO::PARAM_STR
Return values
Pdo

closeCursor()

Method closes the cursor, translating the request in the ready state.

public closeCursor() : bool
Return values
bool

commit()

Commit a transaction

public commit() : Pdo
Return values
Pdo

connect()

Connect to the database

public connect([array<string|int, mixed> $options = [] ]) : Pdo
Parameters
$options : array<string|int, mixed> = []
Return values
Pdo

dbFileExists()

Does the database file exist

public dbFileExists() : bool
Return values
bool

debugDumpParams()

The method displays information about the prepared SQL command for debugging purposes.

public debugDumpParams([bool $debug = false ]) : string
Parameters
$debug : bool = false
Return values
string

delete()

Directly execute a DELETE SQL query or prepared statement and return the results

public delete(string|Sql $sql[, array<string|int, mixed> $params = [] ]) : int
Parameters
$sql : string|Sql
$params : array<string|int, mixed> = []
Tags
throws
Exception
Return values
int

disconnect()

Disconnect from the database

public disconnect() : void

escape()

Escape the value

public escape([string|null $value = null ]) : string
Parameters
$value : string|null = null
Return values
string

exec()

The method runs an SQL query for execution and returns the number of rows affected during execution.

public exec(mixed $sql) : Pdo
Parameters
$sql : mixed

The SQL statement to be prepared and run

Return values
Pdo

execute()

Execute a prepared SQL query

public execute() : Pdo
Return values
Pdo

executeSql()

Execute a SQL query or prepared statement with params

public executeSql(string|Sql $sql[, array<string|int, mixed> $params = [] ]) : AbstractAdapter
Parameters
$sql : string|Sql
$params : array<string|int, mixed> = []
Return values
AbstractAdapter

fetch()

Fetch and return a row from the result

public fetch([int $dataType = PDO::FETCH_ASSOC ]) : mixed
Parameters
$dataType : int = PDO::FETCH_ASSOC

Data type of the parameter, specified by the PDO::PARAM_* constants.

fetchAll()

Fetch and return all rows from the result

public fetchAll([int $dataType = PDO::FETCH_ASSOC ]) : array<string|int, mixed>
Parameters
$dataType : int = PDO::FETCH_ASSOC

Data type of the parameter, specified by the PDO::PARAM_* constants.

Return values
array<string|int, mixed>

fetchColumn()

The method receives data of one column from the next row of the result set.

public fetchColumn([int $num = null ]) : mixed
Parameters
$num : int = null

The number of the table column

getAttribute()

The method of obtaining the value of the request attribute PDO.

public getAttribute(int $attribute) : string
Parameters
$attribute : int

A request attribute

Return values
string

getConnection()

Get the connection object/resource

public getConnection() : mixed

getCountOfFields()

The method returns the number of columns in the result set.

public getCountOfFields() : int
Return values
int

getCountOfRows()

The method returns the number of rows modified by the last SQL query.

public getCountOfRows() : int
Return values
int

getDsn()

Return the DSN

public getDsn() : string|null
Return values
string|null

getLastId()

Return the last ID of the last query

public getLastId() : int
Return values
int

getNumberOfAffectedRows()

Return the number of affected rows from the last query

public getNumberOfAffectedRows() : int
Tags
throws
Exception
Return values
int

getNumberOfFields()

Return the number of fields in the result.

public getNumberOfFields() : int
Tags
throws
Exception
Return values
int

getNumberOfRows()

Return the number of rows from the last query

public getNumberOfRows() : int
Tags
throws
Exception
Return values
int

getOptions()

Get database connection options

public getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getResult()

Get the result object/resource

public getResult() : mixed

getStatement()

Get the statement object/resource

public getStatement() : mixed

getTables()

Return the tables in the database

public getTables() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTransactionDepth()

Get transaction depth

public getTransactionDepth() : int
Return values
int

getType()

Return the type

public getType() : string|null
Return values
string|null

getVersion()

Return the database version

public getVersion() : string
Return values
string

hasError()

Determine whether or not there is an error

public hasError() : bool
Return values
bool

hasOptions()

Has database connection options

public hasOptions() : bool
Return values
bool

hasResult()

Determine whether or not a result resource exists

public hasResult() : bool
Return values
bool

hasStatement()

Determine whether or not a statement resource exists

public hasStatement() : bool
Return values
bool

hasTable()

Return if the database has a table

public hasTable(string $table) : bool
Parameters
$table : string
Return values
bool

insert()

Directly execute an INSERT SQL query or prepared statement and return the results

public insert(string|Sql $sql[, array<string|int, mixed> $params = [] ]) : int
Parameters
$sql : string|Sql
$params : array<string|int, mixed> = []
Tags
throws
Exception
Return values
int

inTransaction()

Method checks, whether the transaction is initiated.

public inTransaction() : bool
Return values
bool

isConnected()

Determine whether or not connected

public isConnected() : bool
Return values
bool

isSuccess()

Check if transaction is success

public isSuccess() : bool
Return values
bool

isTransaction()

Check if adapter is in the middle of an open transaction

public isTransaction() : bool
Return values
bool

listen()

Add query listener to the adapter

public listen(mixed $listener[, mixed $params = null ][, Profiler $profiler = new ProfilerProfiler() ]) : mixed
Parameters
$listener : mixed
$params : mixed = null
$profiler : Profiler = new ProfilerProfiler()

prepare()

Prepare a SQL query

public prepare(mixed $sql[, array<string|int, mixed>|null $attribs = null ]) : Pdo
Parameters
$sql : mixed
$attribs : array<string|int, mixed>|null = null
Return values
Pdo

query()

Execute a SQL query directly

public query(mixed $sql) : Pdo
Parameters
$sql : mixed
Return values
Pdo

rollback()

Rollback a transaction

public rollback() : Pdo
Return values
Pdo

select()

Directly execute a SELECT SQL query or prepared statement and return the results

public select(string|Sql $sql[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$sql : string|Sql
$params : array<string|int, mixed> = []
Tags
throws
Exception
Return values
array<string|int, mixed>

setAttribute()

Method sets the value of the request attribute PDO.

public setAttribute(int $attribute, mixed $value) : bool
Parameters
$attribute : int

A request attribute

$value : mixed

The value of the attribute request

Return values
bool

setOptions()

Set database connection options

public setOptions(array<string|int, mixed> $options) : Pdo
Parameters
$options : array<string|int, mixed>
Return values
Pdo

throwError()

Throw a database error exception

public throwError([string|null $error = null ]) : void
Parameters
$error : string|null = null
Tags
throws
Exception

transaction()

Execute complete transaction with the DB adapter

public transaction(mixed $callable[, mixed $params = null ]) : void
Parameters
$callable : mixed
$params : mixed = null
Tags
throws
Exception

update()

Directly execute an UPDATE SQL query or prepared statement and return the results

public update(string|Sql $sql[, array<string|int, mixed> $params = [] ]) : int
Parameters
$sql : string|Sql
$params : array<string|int, mixed> = []
Tags
throws
Exception
Return values
int

buildError()

Build the error

protected buildError([string|null $code = null ][, array<string|int, mixed>|null $info = null ]) : Pdo
Parameters
$code : string|null = null
$info : array<string|int, mixed>|null = null
Return values
Pdo

getErrorMessage()

Get the error message

protected getErrorMessage(mixed $errorInfo) : string|null
Parameters
$errorInfo : mixed
Return values
string|null

getTransactionManager()

Return the transaction manager object, initialize on first use

protected getTransactionManager() : Manager
Return values
Manager 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results