Documentation

AbstractAdapter
in package
implements AdapterInterface

Db abstract adapter class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

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

license

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

version
5.3.0

Interfaces, Classes and Traits

AdapterInterface
Db adapter interface

Table of Contents

$connection  : mixed
Database connection object/resource
$error  : mixed
Error string/object/resource
$listener  : CallableObject
Query listener object/resource
$options  : mixed
Database connection options
$profiler  : Profiler
Query profiler
$result  : mixed
Result object/resource
$statement  : mixed
Statement object/resource
__construct()  : mixed
Constructor
beginTransaction()  : AbstractAdapter
Begin a transaction
bindParams()  : AbstractAdapter
Bind parameters to a prepared SQL query
clearError()  : AbstractAdapter
Clear the error
clearProfiler()  : AbstractAdapter
Clear query profiler
commit()  : AbstractAdapter
Commit a transaction
connect()  : AbstractAdapter
Connect to the database
createSchema()  : Schema
Create Schema builder
createSql()  : Sql
Create SQL builder
disconnect()  : void
Disconnect from the database
escape()  : string
Escape the value
execute()  : AbstractAdapter
Execute a prepared SQL query
fetch()  : array<string|int, mixed>
Fetch and return a row from the result
fetchAll()  : array<string|int, mixed>
Fetch and return all rows from the result
getConnection()  : mixed
Get the connection object/resource
getError()  : mixed
Get the error
getLastId()  : int
Return the last ID of the last query
getListener()  : CallableObject
Get query listener
getNumberOfRows()  : int
Return the number of rows from the last query
getOptions()  : array<string|int, mixed>
Get database connection options
getProfiler()  : Profiler
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
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
isConnected()  : bool
Determine whether or not connected
listen()  : mixed
Add query listener to the adapter
prepare()  : AbstractAdapter
Prepare a SQL query
query()  : AbstractAdapter
Execute a SQL query directly
rollback()  : AbstractAdapter
Rollback a transaction
setError()  : AbstractAdapter
Set the error
setOptions()  : AdapterInterface
Set database connection options
setProfiler()  : AbstractAdapter
Set query profiler
throwError()  : void
Throw a database error exception

Properties

$connection

Database connection object/resource

protected mixed $connection = null

$statement

Statement object/resource

protected mixed $statement = null

Methods

__construct()

Constructor

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

Instantiate the database adapter object

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

disconnect()

Disconnect from the database

public disconnect() : void
Return values
void

escape()

Escape the value

public abstract escape(string $value) : string
Parameters
$value : string
Return values
string

fetch()

Fetch and return a row from the result

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

fetchAll()

Fetch and return all rows from the result

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

getConnection()

Get the connection object/resource

public getConnection() : mixed
Return values
mixed

getError()

Get the error

public getError() : mixed
Return values
mixed

getLastId()

Return the last ID of the last query

public abstract getLastId() : int
Return values
int

getNumberOfRows()

Return the number of rows from the last query

public abstract getNumberOfRows() : int
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
Return values
mixed

getStatement()

Get the statement object/resource

public getStatement() : mixed
Return values
mixed

getTables()

Return the tables in the database

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

getVersion()

Return the database version

public abstract 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 abstract 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

isConnected()

Determine whether or not connected

public isConnected() : bool
Return values
bool

listen()

Add query listener to the adapter

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

throwError()

Throw a database error exception

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

Search results