API Documentation
\
Pop
Acl
Assertion
Audit
Adapter
Model
Auth
Bootstrap
Controller
Event
Model
Cache
Adapter
Code
Generator
Config
Console
Controller
Cookie
Css
Color
Csv
Db
Adapter
Profiler
Gateway
Parser
Record
Sql
Migration
Predicate
Schema
Debug
Handler
Storage
Dir
Dom
Event
Form
Element
Input
Select
Ftp
Http
Client
I18n
Format
Image
Adapter
Adjust
Color
Draw
Effect
Filter
Layer
Type
Loader
Log
Writer
Mail
Client
Message
Transport
Smtp
Auth
Stream
Byte
Filter
Model
Module
Nav
Paginator
Pdf
Build
Font
Standard
TrueType
Table
Cmap
Html
Image
PdfObject
Document
Page
Annotation
Color
Field
Router
Match
Service
Session
Validator
View
Template
Popcorn

\Pop\Db\SqlSchema

Sql schema table class

Summary

Methods
Properties
Constants
__construct()
isMysql()
isPgsql()
isSqlsrv()
isSqlite()
db()
getDb()
setIdQuoteType()
setPlaceholder()
getDbType()
getIdQuoteType()
getPlaceholder()
quoteId()
quote()
create()
createIfNotExists()
drop()
dropIfExists()
alter()
rename()
truncate()
enableForeignKeyCheck()
disableForeignKeyCheck()
render()
execute()
__toString()
No public properties found
MYSQL
PGSQL
SQLITE
SQLSRV
BACKTICK
BRACKET
DOUBLE_QUOTE
NO_QUOTE
getCreateTable()
getDropTable()
getAlterTable()
getRenameTable()
getTruncateTable()
$db
$dbType
$idQuoteType
$placeholder
$drop
$create
$alter
$rename
$truncate
$foreignKeyCheck
N/A
No private methods found
No private properties found
N/A

Constants

MYSQL

MYSQL

Constants for database types

PGSQL

PGSQL

SQLITE

SQLITE

SQLSRV

SQLSRV

BACKTICK

BACKTICK

Constants for id quote types

BRACKET

BRACKET

DOUBLE_QUOTE

DOUBLE_QUOTE

NO_QUOTE

NO_QUOTE

Properties

$dbType

$dbType : integer

Database type

Type

integer

$idQuoteType

$idQuoteType : string

ID quote type

Type

string

$placeholder

$placeholder : string

SQL placeholder

Type

string

$drop

$drop : array

DROP table schema objects

Type

array

$create

$create : array

CREATE table schema objects

Type

array

$alter

$alter : array

ALTER table schema objects

Type

array

$rename

$rename : array

RENAME table schema objects

Type

array

$truncate

$truncate : array

TRUNCATE table schema objects

Type

array

$foreignKeyCheck

$foreignKeyCheck : boolean

Foreign key check flag

Type

boolean

Methods

isMysql()

isMysql() : boolean

Determine if the DB type is MySQL

Returns

boolean

isPgsql()

isPgsql() : boolean

Determine if the DB type is PostgreSQL

Returns

boolean

isSqlsrv()

isSqlsrv() : boolean

Determine if the DB type is SQL Server

Returns

boolean

isSqlite()

isSqlite() : boolean

Determine if the DB type is SQLite

Returns

boolean

setIdQuoteType()

setIdQuoteType(string  $type = self::NO_QUOTE) : \Pop\Db\Sql\AbstractSql

Set the quote ID type

Parameters

string $type

Returns

\Pop\Db\Sql\AbstractSql

setPlaceholder()

setPlaceholder(string  $placeholder) : \Pop\Db\Sql\AbstractSql

Set the placeholder

Parameters

string $placeholder

Returns

\Pop\Db\Sql\AbstractSql

getDbType()

getDbType() : integer

Get the current database type

Returns

integer

getIdQuoteType()

getIdQuoteType() : integer

Get the quote ID type

Returns

integer

getPlaceholder()

getPlaceholder() : string

Get the SQL placeholder

Returns

string

quoteId()

quoteId(string  $identifier) : string

Quote the identifier

Parameters

string $identifier

Returns

string

quote()

quote(string  $value) : string

Quote the value (if it is not a numeric value)

Parameters

string $value

Returns

string

create()

create(string  $table) : \Pop\Db\Sql\Schema\Create

Access the CREATE table object

Parameters

string $table

Returns

\Pop\Db\Sql\Schema\Create

createIfNotExists()

createIfNotExists(string  $table) : \Pop\Db\Sql\Schema\Create

Access the CREATE table object, setting IF NOT EXISTS

Parameters

string $table

Returns

\Pop\Db\Sql\Schema\Create

drop()

drop(string  $table) : \Pop\Db\Sql\Schema\Drop

Access the DROP table object

Parameters

string $table

Returns

\Pop\Db\Sql\Schema\Drop

dropIfExists()

dropIfExists(string  $table) : \Pop\Db\Sql\Schema\Drop

Access the DROP table object, setting IF EXISTS

Parameters

string $table

Returns

\Pop\Db\Sql\Schema\Drop

alter()

alter(string  $table) : \Pop\Db\Sql\Schema\Alter

Access the ALTER table object

Parameters

string $table

Returns

\Pop\Db\Sql\Schema\Alter

rename()

rename(string  $table) : \Pop\Db\Sql\Schema\Rename

Access the RENAME table object

Parameters

string $table

Returns

\Pop\Db\Sql\Schema\Rename

truncate()

truncate(string  $table) : \Pop\Db\Sql\Schema\Truncate

Access the TRUNCATE table object

Parameters

string $table

Returns

\Pop\Db\Sql\Schema\Truncate

enableForeignKeyCheck()

enableForeignKeyCheck() : \Pop\Db\Sql\Schema

Enable the foreign key check

Returns

\Pop\Db\Sql\Schema

disableForeignKeyCheck()

disableForeignKeyCheck() : \Pop\Db\Sql\Schema

Disable the foreign key check

Returns

\Pop\Db\Sql\Schema

render()

render() : string

Render the schema

Returns

string

execute()

execute() : void

Execute the schema directly

__toString()

__toString() : string

Render the schema to string

Returns

string

getCreateTable()

getCreateTable(string  $table) : \Pop\Db\Sql\Schema\Create

Get the CREATE table object

Parameters

string $table

Returns

\Pop\Db\Sql\Schema\Create

getDropTable()

getDropTable(string  $table) : \Pop\Db\Sql\Schema\Drop

Get the DROP table object

Parameters

string $table

Returns

\Pop\Db\Sql\Schema\Drop

getAlterTable()

getAlterTable(string  $table) : \Pop\Db\Sql\Schema\Alter

Get the ALTER table object

Parameters

string $table

Returns

\Pop\Db\Sql\Schema\Alter

getRenameTable()

getRenameTable(string  $table) : \Pop\Db\Sql\Schema\Rename

Get the RENAME table object

Parameters

string $table

Returns

\Pop\Db\Sql\Schema\Rename

getTruncateTable()

getTruncateTable(string  $table) : \Pop\Db\Sql\Schema\Truncate

Get the TRUNCATE table object

Parameters

string $table

Returns

\Pop\Db\Sql\Schema\Truncate