Documentation

Schema extends AbstractSql
in package

Pop

Db

Sql schema table class

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

$aggregateFunctions : array<string|int, mixed>: Supported standard SQL aggregate functions
$alter : array<string|int, mixed>: ALTER table schema objects
$closeQuote : string|null: ID close quote
$create : array<string|int, mixed>: CREATE table schema objects
$dateTimeFunctions : array<string|int, mixed>: Supported standard SQL date-time functions
$db : AbstractAdapter|null: Database object
$dbType : string|null: Database type
$drop : array<string|int, mixed>: DROP table schema objects
$foreignKeyCheck : bool: Foreign key check flag
$idQuoteType : string: ID quote type
$mathFunctions : array<string|int, mixed>: Supported standard SQL math functions
$openQuote : string|null: ID open quote
$parameterCount : int: Parameter count
$placeholder : string|null: SQL placeholder
$rename : array<string|int, mixed>: RENAME table schema objects
$stringFunctions : array<string|int, mixed>: Supported standard SQL string functions
$truncate : array<string|int, mixed>: TRUNCATE table schema objects

Methods

__construct() : mixed: Constructor
__toString() : string: Render the schema to string
alter() : Alter: Access the ALTER table object
create() : Create: Access the CREATE table object
createIfNotExists() : Create: Access the CREATE table object, setting IF NOT EXISTS
db() : AbstractAdapter|null: Get the current database adapter object (alias method)
decrementParameterCount() : AbstractSql: Decrement parameter count
disableForeignKeyCheck() : Schema: Disable the foreign key check
drop() : Drop: Access the DROP table object
dropIfExists() : Drop: Access the DROP table object, setting IF EXISTS
enableForeignKeyCheck() : Schema: Enable the foreign key check
execute() : void: Execute the schema directly
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
incrementParameterCount() : AbstractSql: Increment parameter count
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
isSupportedFunction() : bool: Check if value contains a standard SQL supported function
quote() : float|int|string: Quote the value (if it is not a numeric value)
quoteId() : string: Quote the identifier
rename() : Rename: Access the RENAME table object
render() : string: Render the schema
reset() : Schema: Reset and clear the schema object
setIdQuoteType() : AbstractSql: Set the quote ID type
setPlaceholder() : AbstractSql: Set the placeholder
truncate() : Truncate: Access the TRUNCATE table object
getAlterTable() : Alter: Get the ALTER table object
getCreateTable() : Create: Get the CREATE table object
getDropTable() : Drop: Get the DROP table object
getRenameTable() : Rename: Get the RENAME table object
getTruncateTable() : Truncate: Get the TRUNCATE table object
init() : void: Initialize SQL object
initQuoteType() : void: Initialize quite type

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'

$aggregateFunctions

Supported standard SQL aggregate functions


    protected
    static    array<string|int, mixed>
    $aggregateFunctions
     = ['AVG', 'COUNT', 'MAX', 'MIN', 'SUM']

$alter

ALTER table schema objects


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

$closeQuote

ID close quote


    protected
        string|null
    $closeQuote
     = null

$create

CREATE table schema objects


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

$dateTimeFunctions

Supported standard SQL date-time functions


    protected
    static    array<string|int, mixed>
    $dateTimeFunctions
     = ['CURRENT_DATE', 'CURRENT_TIMESTAMP', 'CURRENT_TIME', 'CURDATE', 'CURTIME', 'DATE', 'DATETIME', 'DAY', 'EXTRACT', 'GETDATE', 'HOUR', 'LOCALTIME', 'LOCALTIMESTAMP', 'MINUTE', 'MONTH', 'NOW', 'SECOND', 'TIME', 'TIMEDIFF', 'TIMESTAMP', 'UNIX_TIMESTAMP', 'YEAR']

$db

Database object


    protected
        AbstractAdapter|null
    $db
     = null

$dbType

Database type


    protected
        string|null
    $dbType
     = null

$drop

DROP table schema objects


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

$foreignKeyCheck

Foreign key check flag


    protected
        bool
    $foreignKeyCheck
     = true

$idQuoteType

ID quote type


    protected
        string
    $idQuoteType
     = 'NO_QUOTE'

$mathFunctions

Supported standard SQL math functions


    protected
    static    array<string|int, mixed>
    $mathFunctions
     = ['ABS', 'RAND', 'SQRT', 'POW', 'POWER', 'EXP', 'LN', 'LOG', 'LOG10', 'GREATEST', 'LEAST', 'DIV', 'MOD', 'ROUND', 'TRUNC', 'CEIL', 'CEILING', 'FLOOR', 'COS', 'ACOS', 'ACOSH', 'SIN', 'SINH', 'ASIN', 'ASINH', 'TAN', 'TANH', 'ATANH', 'ATAN2']

$openQuote

ID open quote


    protected
        string|null
    $openQuote
     = null

$parameterCount

Parameter count


    protected
        int
    $parameterCount
     = 0

$placeholder

SQL placeholder


    protected
        string|null
    $placeholder
     = null

$rename

RENAME table schema objects


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

$stringFunctions

Supported standard SQL string functions


    protected
    static    array<string|int, mixed>
    $stringFunctions
     = ['CONCAT', 'FORMAT', 'INSTR', 'LCASE', 'LEFT', 'LENGTH', 'LOCATE', 'LOWER', 'LPAD', 'LTRIM', 'POSITION', 'QUOTE', 'REGEXP', 'REPEAT', 'REPLACE', 'REVERSE', 'RIGHT', 'RPAD', 'RTRIM', 'SPACE', 'STRCMP', 'SUBSTRING', 'SUBSTR', 'TRIM', 'UCASE', 'UPPER']

$truncate

TRUNCATE table schema objects


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

__construct()

Constructor


    public
                    __construct(AbstractAdapter $db) : mixed

Instantiate the SQL object

Parameters

$db : AbstractAdapter

__toString()

Render the schema to string


    public
                    __toString() : string

Return values

string

alter()

Access the ALTER table object


    public
                    alter(string $table) : Alter

Parameters

$table : string

Return values

Alter

create()

Access the CREATE table object


    public
                    create(string $table) : Create

Parameters

$table : string

Return values

Create

createIfNotExists()

Access the CREATE table object, setting IF NOT EXISTS


    public
                    createIfNotExists(string $table) : Create

Parameters

$table : string

Return values

Create

db()

Get the current database adapter object (alias method)


    public
                    db() : AbstractAdapter|null

Return values

AbstractAdapter|null

decrementParameterCount()

Decrement parameter count


    public
                    decrementParameterCount() : AbstractSql

Return values

AbstractSql

disableForeignKeyCheck()

Disable the foreign key check


    public
                    disableForeignKeyCheck() : Schema

Return values

Schema

drop()

Access the DROP table object


    public
                    drop(string $table) : Drop

Parameters

$table : string

Return values

Drop

dropIfExists()

Access the DROP table object, setting IF EXISTS


    public
                    dropIfExists(string $table) : Drop

Parameters

$table : string

Return values

Drop

enableForeignKeyCheck()

Enable the foreign key check


    public
                    enableForeignKeyCheck() : Schema

Return values

Schema

execute()

Execute the schema directly


    public
                    execute([bool $reset = true ]) : void

Parameters

$reset : bool = true

getCloseQuote()

Get close quote


    public
                    getCloseQuote() : string|null

Return values

string|null

getDb()

Get the current database adapter object


    public
                    getDb() : AbstractAdapter|null

Return values

AbstractAdapter|null

getDbType()

Get the current database type


    public
                    getDbType() : string|null

Return values

string|null

getIdQuoteType()

Get the quote ID type


    public
                    getIdQuoteType() : string

Return values

string

getOpenQuote()

Get open quote


    public
                    getOpenQuote() : string|null

Return values

string|null

getParameter()

Get parameter placeholder value


    public
                    getParameter(mixed $value[, string|null $column = null ]) : string

Parameters

$value : mixed
$column : string|null = null

Return values

string

getParameterCount()

Get parameter count


    public
                    getParameterCount() : int

Return values

int

getPlaceholder()

Get the SQL placeholder


    public
                    getPlaceholder() : string|null

Return values

string|null

incrementParameterCount()

Increment parameter count


    public
                    incrementParameterCount() : AbstractSql

Return values

AbstractSql

isMysql()

Determine if the DB type is MySQL


    public
                    isMysql() : bool

Return values

bool

isParameter()

Check if value is parameter placeholder


    public
                    isParameter(mixed $value[, string|null $column = null ]) : bool

Parameters

$value : mixed
$column : string|null = null

Return values

bool

isPgsql()

Determine if the DB type is PostgreSQL


    public
                    isPgsql() : bool

Return values

bool

isSqlite()

Determine if the DB type is SQLite


    public
                    isSqlite() : bool

Return values

bool

isSqlsrv()

Determine if the DB type is SQL Server


    public
                    isSqlsrv() : bool

Return values

bool

isSupportedFunction()

Check if value contains a standard SQL supported function


    public
            static        isSupportedFunction(string $value) : bool

Parameters

$value : string

Return values

bool

quote()

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|string

quoteId()

Quote the identifier


    public
                    quoteId(string $identifier) : string

Parameters

$identifier : string

Return values

string

rename()

Access the RENAME table object


    public
                    rename(string $table) : Rename

Parameters

$table : string

Return values

Rename

render()

Render the schema


    public
                    render() : string

Return values

string

reset()

Reset and clear the schema object


    public
                    reset() : Schema

Return values

Schema

setIdQuoteType()

Set the quote ID type


    public
                    setIdQuoteType([string $type = self::NO_QUOTE ]) : AbstractSql

Parameters

$type : string = self::NO_QUOTE

Return values

AbstractSql

setPlaceholder()

Set the placeholder


    public
                    setPlaceholder(string $placeholder) : AbstractSql

Parameters

$placeholder : string

Return values

AbstractSql

truncate()

Access the TRUNCATE table object


    public
                    truncate(string $table) : Truncate

Parameters

$table : string

Return values

Truncate

getAlterTable()

Get the ALTER table object


    protected
                    getAlterTable(string $table) : Alter

Parameters

$table : string

Return values

Alter

getCreateTable()

Get the CREATE table object


    protected
                    getCreateTable(string $table) : Create

Parameters

$table : string

Return values

Create

getDropTable()

Get the DROP table object


    protected
                    getDropTable(string $table) : Drop

Parameters

$table : string

Return values

Drop

getRenameTable()

Get the RENAME table object


    protected
                    getRenameTable(string $table) : Rename

Parameters

$table : string

Return values

Rename

getTruncateTable()

Get the TRUNCATE table object


    protected
                    getTruncateTable(string $table) : Truncate

Parameters

$table : string

Return values

Truncate

init()

Initialize SQL object


    protected
                    init(string $adapter) : void

Parameters

$adapter : string

initQuoteType()

Initialize quite type


    protected
                    initQuoteType() : void

Schema extends AbstractSql in package Pop Db

Tags

Table of Contents

Constants

Properties

Methods

Constants

BACKTICK

BRACKET

DOUBLE_QUOTE

MYSQL

NO_QUOTE

PGSQL

SQLITE

SQLSRV

Properties

$aggregateFunctions

$alter

$closeQuote

$create

$dateTimeFunctions

$db

$dbType

$drop

$foreignKeyCheck

$idQuoteType

$mathFunctions

$openQuote

$parameterCount

$placeholder

$rename

$stringFunctions

$truncate

Methods

__construct()

Parameters

__toString()

Return values

alter()

Parameters

Return values

create()

Parameters

Return values

createIfNotExists()

Parameters

Return values

db()

Return values

decrementParameterCount()

Return values

disableForeignKeyCheck()

Return values

drop()

Parameters

Return values

dropIfExists()

Parameters

Return values

enableForeignKeyCheck()

Return values

execute()

Parameters

getCloseQuote()

Return values

getDb()

Return values

getDbType()

Return values

getIdQuoteType()

Return values

getOpenQuote()

Return values

getParameter()

Parameters

Return values

getParameterCount()

Return values

getPlaceholder()

Return values

Schema extends AbstractSql
in package

Pop

Db