Constraint extends BaseObject
Class BaseObject Base class for all schema objects such as tables, columns, indexes, etc.
Table of Contents
Properties
- $body : mixed
- $columns : mixed
- $name : mixed
- $parent : BaseObject|null
Methods
- __construct() : mixed
- compareName() : int
- Compares name of the table with given.
- create() : Constraint
- Creates constraint object from tokens.
- getCompareName() : string
- Returns "normalized" name of the table.
- getCreateDdl() : array<string|int, mixed>|string
- Return DDL for constraint creation.
- getDropDdl() : array<string|int, mixed>|string
- Return DDL for constraint destruction.
- getLowercasedName() : string
- Returns "lowercased" name of the object.
- getModifyDdl() : array<string|int, mixed>|string
- Return DDL for constraint modification.
- getUnquotedName() : array<string|int, mixed>|string
- Returns "unquoted" name of the object.
- setBody() : BaseObject
- Sets source code for object.
- setParent() : BaseObject
- Sets parent for object.
Properties
$body
public
mixed
$body
= ''
$columns
public
mixed
$columns
= []
$name
public
mixed
$name
= ''
$parent
public
BaseObject|null
$parent
= null
Methods
__construct()
public
__construct([string $name = '' ]) : mixed
Parameters
- $name : string = ''
-
Name of the table.
compareName()
Compares name of the table with given.
public
final compareName(string $name) : int
If name has no quotes when comparison is case insensitive.
Parameters
- $name : string
-
Table name to compare.
Tags
Return values
intcreate()
Creates constraint object from tokens.
public
static create(Tokenizer $tokenizer[, string $constraintName = '' ]) : Constraint
If parameter $constraintName is not passed then current position should point to the name of the constraint.
Parameters
- $tokenizer : Tokenizer
-
Tokens collection.
- $constraintName : string = ''
-
Optional name of the constraint.
Return values
ConstraintgetCompareName()
Returns "normalized" name of the table.
public
final static getCompareName(string $name) : string
If name is not quoted then it made uppercase.
Parameters
- $name : string
-
Table name.
Return values
stringgetCreateDdl()
Return DDL for constraint creation.
public
getCreateDdl([string $dbType = '' ]) : array<string|int, mixed>|string
Parameters
- $dbType : string = ''
-
Database type (MYSQL, ORACLE or MSSQL).
Return values
array<string|int, mixed>|stringgetDropDdl()
Return DDL for constraint destruction.
public
getDropDdl([string $dbType = '' ]) : array<string|int, mixed>|string
Parameters
- $dbType : string = ''
-
Database type (MYSQL, ORACLE or MSSQL).
Return values
array<string|int, mixed>|stringgetLowercasedName()
Returns "lowercased" name of the object.
public
final getLowercasedName() : string
If name is not quoted then it made lowercase.
Return values
stringgetModifyDdl()
Return DDL for constraint modification.
public
getModifyDdl(BaseObject $target[, string $dbType = '' ]) : array<string|int, mixed>|string
Parameters
- $target : BaseObject
-
Target object.
- $dbType : string = ''
-
Database type (MYSQL, ORACLE or MSSQL).
Return values
array<string|int, mixed>|stringgetUnquotedName()
Returns "unquoted" name of the object.
public
final getUnquotedName([array<string|int, mixed>|string $name = null ]) : array<string|int, mixed>|string
Parameters
- $name : array<string|int, mixed>|string = null
-
Name or array of names to unquote.
Return values
array<string|int, mixed>|stringsetBody()
Sets source code for object.
public
setBody(string $body) : BaseObject
Parameters
- $body : string
-
The body.
Return values
BaseObjectsetParent()
Sets parent for object.
public
setParent([BaseObject $parent = null ]) : BaseObject
For example Table for Column.
Parameters
- $parent : BaseObject = null
-
Parent object.