Sql
extends AbstractSql
in package
Sql class
Tags
Table of Contents
Constants
- BACKTICK = 'BACKTICK'
- Constants for id quote types
- BRACKET = 'BRACKET'
- DOUBLE_QUOTE = 'DOUBLE_QUOTE'
- MYSQL = 'MYSQL'
- Constants for database types
- NO_QUOTE = 'NO_QUOTE'
- PGSQL = 'PGSQL'
- SQLITE = 'SQLITE'
- SQLSRV = 'SQLSRV'
Properties
- $closeQuote : string|null
- ID close quote
- $db : AbstractAdapter|null
- Database object
- $dbType : string|null
- Database type
- $delete : Delete|null
- Delete object
- $idQuoteType : string
- ID quote type
- $insert : Insert|null
- Insert object
- $openQuote : string|null
- ID open quote
- $parameterCount : int
- Parameter count
- $placeholder : string|null
- SQL placeholder
- $select : Select|null
- Select object
- $update : Update|null
- Update object
Methods
- __construct() : mixed
- Constructor
- __toString() : string
- Render the SQL statement
- db() : AbstractAdapter|null
- Get the current database adapter object (alias method)
- decrementParameterCount() : AbstractSql
- Decrement parameter count
- delete() : Delete|null
- Access the delete object
- getCloseQuote() : string|null
- Get close quote
- getDb() : AbstractAdapter|null
- Get the current database adapter object
- getDbType() : string|null
- Get the current database type
- getIdQuoteType() : string
- Get the quote ID type
- getOpenQuote() : string|null
- Get open quote
- getParameter() : string
- Get parameter placeholder value
- getParameterCount() : int
- Get parameter count
- getPlaceholder() : string|null
- Get the SQL placeholder
- hasDelete() : bool
- Determine if SQL object has a delete object
- hasInsert() : bool
- Determine if SQL object has a insert object
- hasSelect() : bool
- Determine if SQL object has a select object
- hasUpdate() : bool
- Determine if SQL object has a update object
- incrementParameterCount() : AbstractSql
- Increment parameter count
- insert() : Insert|null
- Access the insert object
- isMysql() : bool
- Determine if the DB type is MySQL
- isParameter() : bool
- Check if value is parameter placeholder
- isPgsql() : bool
- Determine if the DB type is PostgreSQL
- isSqlite() : bool
- Determine if the DB type is SQLite
- isSqlsrv() : bool
- Determine if the DB type is SQL Server
- quote() : float|int|string
- Quote the value (if it is not a numeric value)
- quoteId() : string
- Quote the identifier
- render() : string
- Render the SQL statement
- reset() : Sql
- Reset and clear the SQL object
- select() : Select|null
- Access the select object
- setIdQuoteType() : AbstractSql
- Set the quote ID type
- setPlaceholder() : AbstractSql
- Set the placeholder
- update() : Update|null
- Access the update object
- init() : void
- Initialize SQL object
- initQuoteType() : void
- Initialize quite type
Constants
BACKTICK
Constants for id quote types
public
mixed
BACKTICK
= 'BACKTICK'
BRACKET
public
mixed
BRACKET
= 'BRACKET'
DOUBLE_QUOTE
public
mixed
DOUBLE_QUOTE
= 'DOUBLE_QUOTE'
MYSQL
Constants for database types
public
mixed
MYSQL
= 'MYSQL'
NO_QUOTE
public
mixed
NO_QUOTE
= 'NO_QUOTE'
PGSQL
public
mixed
PGSQL
= 'PGSQL'
SQLITE
public
mixed
SQLITE
= 'SQLITE'
SQLSRV
public
mixed
SQLSRV
= 'SQLSRV'
Properties
$closeQuote
ID close quote
protected
string|null
$closeQuote
= null
$db
Database object
protected
AbstractAdapter|null
$db
= null
$dbType
Database type
protected
string|null
$dbType
= null
$delete
Delete object
protected
Delete|null
$delete
= null
$idQuoteType
ID quote type
protected
string
$idQuoteType
= 'NO_QUOTE'
$insert
Insert object
protected
Insert|null
$insert
= null
$openQuote
ID open quote
protected
string|null
$openQuote
= null
$parameterCount
Parameter count
protected
int
$parameterCount
= 0
$placeholder
SQL placeholder
protected
string|null
$placeholder
= null
$select
Select object
protected
Select|null
$select
= null
$update
Update object
protected
Update|null
$update
= null
Methods
__construct()
Constructor
public
__construct(AbstractAdapter $db) : mixed
Instantiate the SQL object
Parameters
- $db : AbstractAdapter
__toString()
Render the SQL statement
public
__toString() : string
Return values
stringdb()
Get the current database adapter object (alias method)
public
db() : AbstractAdapter|null
Return values
AbstractAdapter|nulldecrementParameterCount()
Decrement parameter count
public
decrementParameterCount() : AbstractSql
Return values
AbstractSqldelete()
Access the delete object
public
delete([string|null $table = null ]) : Delete|null
Parameters
- $table : string|null = null
Return values
Delete|nullgetCloseQuote()
Get close quote
public
getCloseQuote() : string|null
Return values
string|nullgetDb()
Get the current database adapter object
public
getDb() : AbstractAdapter|null
Return values
AbstractAdapter|nullgetDbType()
Get the current database type
public
getDbType() : string|null
Return values
string|nullgetIdQuoteType()
Get the quote ID type
public
getIdQuoteType() : string
Return values
stringgetOpenQuote()
Get open quote
public
getOpenQuote() : string|null
Return values
string|nullgetParameter()
Get parameter placeholder value
public
getParameter(mixed $value[, string|null $column = null ]) : string
Parameters
- $value : mixed
- $column : string|null = null
Return values
stringgetParameterCount()
Get parameter count
public
getParameterCount() : int
Return values
intgetPlaceholder()
Get the SQL placeholder
public
getPlaceholder() : string|null
Return values
string|nullhasDelete()
Determine if SQL object has a delete object
public
hasDelete() : bool
Return values
boolhasInsert()
Determine if SQL object has a insert object
public
hasInsert() : bool
Return values
boolhasSelect()
Determine if SQL object has a select object
public
hasSelect() : bool
Return values
boolhasUpdate()
Determine if SQL object has a update object
public
hasUpdate() : bool
Return values
boolincrementParameterCount()
Increment parameter count
public
incrementParameterCount() : AbstractSql
Return values
AbstractSqlinsert()
Access the insert object
public
insert([string|null $table = null ]) : Insert|null
Parameters
- $table : string|null = null
Return values
Insert|nullisMysql()
Determine if the DB type is MySQL
public
isMysql() : bool
Return values
boolisParameter()
Check if value is parameter placeholder
public
isParameter(mixed $value[, string|null $column = null ]) : bool
Parameters
- $value : mixed
- $column : string|null = null
Return values
boolisPgsql()
Determine if the DB type is PostgreSQL
public
isPgsql() : bool
Return values
boolisSqlite()
Determine if the DB type is SQLite
public
isSqlite() : bool
Return values
boolisSqlsrv()
Determine if the DB type is SQL Server
public
isSqlsrv() : bool
Return values
boolquote()
Quote the value (if it is not a numeric value)
public
quote([string|null $value = null ][, bool $force = false ]) : float|int|string
Parameters
- $value : string|null = null
- $force : bool = false
Return values
float|int|stringquoteId()
Quote the identifier
public
quoteId(string $identifier) : string
Parameters
- $identifier : string
Return values
stringrender()
Render the SQL statement
public
render() : string
Return values
stringreset()
Reset and clear the SQL object
public
reset() : Sql
Return values
Sqlselect()
Access the select object
public
select([mixed $columns = null ]) : Select|null
Parameters
- $columns : mixed = null
Return values
Select|nullsetIdQuoteType()
Set the quote ID type
public
setIdQuoteType([string $type = self::NO_QUOTE ]) : AbstractSql
Parameters
- $type : string = self::NO_QUOTE
Return values
AbstractSqlsetPlaceholder()
Set the placeholder
public
setPlaceholder(string $placeholder) : AbstractSql
Parameters
- $placeholder : string
Return values
AbstractSqlupdate()
Access the update object
public
update([string|null $table = null ]) : Update|null
Parameters
- $table : string|null = null
Return values
Update|nullinit()
Initialize SQL object
protected
init(string $adapter) : void
Parameters
- $adapter : string
initQuoteType()
Initialize quite type
protected
initQuoteType() : void