Documentation

AbstractTable extends AbstractSql
in package

Abstract schema table 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

Table of Contents

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'
$closeQuote  : string
ID close quote
$db  : AbstractAdapter
Database object
$dbType  : int
Database type
$idQuoteType  : string
ID quote type
$info  : array<string|int, mixed>
Table info
$openQuote  : string
ID open quote
$parameterCount  : int
Parameter count
$placeholder  : string
SQL placeholder
$table  : string
Table name
__construct()  : mixed
Constructor
__toString()  : string
Render the table schema to string
db()  : AbstractAdapter
Get the current database adapter object (alias method)
decrementParameterCount()  : static
Decrement parameter count
getCloseQuote()  : string
Get close quote
getDb()  : AbstractAdapter
Get the current database adapter object
getDbType()  : int
Get the current database type
getIdQuoteType()  : int
Get the quote ID type
getInfo()  : array<string|int, mixed>
Get the table info
getOpenQuote()  : string
Get open quote
getParameter()  : string
Get parameter placeholder value
getParameterCount()  : int
Get parameter count
getPlaceholder()  : string
Get the SQL placeholder
getTable()  : string
Get the table name
incrementParameterCount()  : static
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
quote()  : string
Quote the value (if it is not a numeric value)
quoteId()  : string
Quote the identifier
render()  : string
Render the table schema
renderToStatements()  : array<string|int, mixed>
Render the table schema to an array of statements
setIdQuoteType()  : AbstractSql
Set the quote ID type
setPlaceholder()  : AbstractSql
Set the placeholder
init()  : void
Initialize SQL object
initQuoteType()  : void
Initialize quite type

Constants

BACKTICK

Constants for id quote types

public mixed BACKTICK = 'BACKTICK'

DOUBLE_QUOTE

public mixed DOUBLE_QUOTE = 'DOUBLE_QUOTE'

MYSQL

Constants for database types

public mixed MYSQL = 'MYSQL'

Properties

$closeQuote

ID close quote

protected string $closeQuote = null

$idQuoteType

ID quote type

protected string $idQuoteType = 'NO_QUOTE'

$info

Table info

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

$openQuote

ID open quote

protected string $openQuote = null

$parameterCount

Parameter count

protected int $parameterCount = 0

$placeholder

SQL placeholder

protected string $placeholder = null

Methods

__toString()

Render the table schema to string

public abstract __toString() : string
Return values
string —

decrementParameterCount()

Decrement parameter count

public decrementParameterCount() : static
Return values
static —

getCloseQuote()

Get close quote

public getCloseQuote() : string
Return values
string —

getDbType()

Get the current database type

public getDbType() : int
Return values
int —

getIdQuoteType()

Get the quote ID type

public getIdQuoteType() : int
Return values
int —

getInfo()

Get the table info

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

getOpenQuote()

Get open quote

public getOpenQuote() : string
Return values
string —

getParameter()

Get parameter placeholder value

public getParameter(mixed $value[, string $column = null ]) : string
Parameters
$value : mixed
$column : string = null
Return values
string —

getParameterCount()

Get parameter count

public getParameterCount() : int
Return values
int —

getPlaceholder()

Get the SQL placeholder

public getPlaceholder() : string
Return values
string —

getTable()

Get the table name

public getTable() : string
Return values
string —

incrementParameterCount()

Increment parameter count

public incrementParameterCount() : static
Return values
static —

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 $column = null ]) : bool
Parameters
$value : mixed
$column : string = 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 —

quote()

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

public quote(string $value[, bool $force = false ]) : string
Parameters
$value : string
$force : bool = false
Return values
string —

quoteId()

Quote the identifier

public quoteId(string $identifier) : string
Parameters
$identifier : string
Return values
string —

render()

Render the table schema

public abstract render() : string
Return values
string —

renderToStatements()

Render the table schema to an array of statements

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

setIdQuoteType()

Set the quote ID type

public setIdQuoteType([string $type = self::NO_QUOTE ]) : AbstractSql
Parameters
$type : string = self::NO_QUOTE
Return values
AbstractSql —

init()

Initialize SQL object

protected init(string $adapter) : void
Parameters
$adapter : string
Return values
void —

initQuoteType()

Initialize quite type

protected initQuoteType() : void
Return values
void —

Search results