Class Table
A representation of a database table.
- ICanBoogie\Object
- ICanBoogie\ActiveRecord\Table
Direct known subclasses
Methods summary
protected
|
|
protected
string
|
|
protected
string
|
|
protected
array|null|string
|
|
protected
string
|
|
protected
|
|
protected
array
|
|
protected
|
|
protected
string
|
|
protected
string
|
|
protected
|
|
public
|
#
__construct( array $attributes )
|
public
|
#
__invoke( string $query, array $args = [], array $options = [] )
Alias to |
protected
|
|
protected
|
|
protected
|
|
protected
|
|
protected
|
|
protected
|
|
protected
|
|
protected
|
#
construct_with_parent(
Construct table with specified parent. |
public
|
|
public
|
|
public
boolean
|
|
public
string
|
|
public
|
|
public
string
|
|
public
mixed
|
|
public
|
|
protected
array
|
|
public
mixed
|
|
protected
|
|
public
mixed
|
|
public
boolean
|
|
public
boolean
|
|
public
mixed
|
|
public
mixed
|
Constants summary
string |
ALIAS
Alias of the table. |
#
'alias'
|
string |
CONNECTION
Connection. |
#
'connection'
|
string |
EXTENDING
Extended model. |
#
'extends'
|
string |
IMPLEMENTING
|
#
'implements'
|
string |
NAME
Unprefixed Name of the table. |
#
'name'
|
string |
SCHEMA
Schema of the table. |
#
'schema'
|
Properties summary
protected
|
$connection
A database connection. |
|
protected
string
|
$name
Name of the table, including the prefix defined by the model's connection. |
|
protected
|
$unprefixed_name
The unprefixed name of the table. |
|
protected
array|null|string
|
$primary
Primary key of the table, retrieved from the schema defined using the |
|
protected
string
|
$alias
Alias for the table's name, which can be defined using the |
|
protected
|
$schema
Schema for the table. |
|
protected
array
|
$schema_options
Schema options provided using |
|
protected
|
$parent
The parent is used when the table is in a hierarchy, which is the case if the table extends another table. |
|
protected
array
|
$implements
|
#
[]
|
protected
string
|
$update_join
SQL fragment for the FROM clause of the query, made of the table's name and alias and those of the hierarchy. |
|
protected
string
|
$select_join
SQL fragment for the FROM clause of the query, made of the table's name and alias and those of the related tables, inherited and implemented. |
Magic properties
public read-only
|
$connection
Connection used by the table. |
public read-only
|
$schema
The schema of the table. |
public read-only
array
|
$schema_options
The options used to create the |
public read-only
|
$extended_schema
The extended schema of the table. |
public read-only
string
|
$name
Name of the table, which might include a prefix. |
public read-only
string
|
$unprefixed_name
Unprefixed name of the table. |
public read-only
string|array|null
|
$primary
Primary key of the table, or |
public read-only
string
|
$alias
The alias name of the table. |
public read-only
|
$parent
The parent of the table. |