Summary

Fully Qualified Name:

Laminas\Db\Metadata\Object\ConstraintObject

Description

Methods

Name	Description	Defined By
__construct()	Constructor	ConstraintObject
getCheckClause()	Get Check Clause.	ConstraintObject
getColumns()	Get Columns.	ConstraintObject
getDeleteRule()	Get Delete Rule.	ConstraintObject
getMatchOption()	Get Match Option.	ConstraintObject
getName()	Get name	ConstraintObject
getReferencedColumns()	Get Referenced Columns.	ConstraintObject
getReferencedTableName()	Get Referenced Table Name.	ConstraintObject
getReferencedTableSchema()	Get Referenced Table Schema.	ConstraintObject
getSchemaName()	Get schema name	ConstraintObject
getTableName()	Get table name	ConstraintObject
getType()	Get type	ConstraintObject
getUpdateRule()	Get Update Rule.	ConstraintObject
hasColumns()		ConstraintObject
isCheck()	Is foreign key	ConstraintObject
isForeignKey()	Is foreign key	ConstraintObject
isPrimaryKey()	Is primary key	ConstraintObject
isUnique()	Is unique key	ConstraintObject
setCheckClause()	Set Check Clause.	ConstraintObject
setColumns()	Set Columns.	ConstraintObject
setDeleteRule()	Set Delete Rule.	ConstraintObject
setMatchOption()	Set Match Option.	ConstraintObject
setName()	Set name	ConstraintObject
setReferencedColumns()	Set Referenced Columns.	ConstraintObject
setReferencedTableName()	Set Referenced Table Name.	ConstraintObject
setReferencedTableSchema()	Set Referenced Table Schema.	ConstraintObject
setSchemaName()	Set schema name	ConstraintObject
setTableName()	Set table name	ConstraintObject
setType()	Set type	ConstraintObject
setUpdateRule()	Set Update Rule.	ConstraintObject

Method Details

__construct()

Constructor

Parameter Name	Type	Description
$name	string
$tableName	string
$schemaName	string

Returns:

getCheckClause()

Get Check Clause.

Returns: string

getColumns()

Get Columns.

Returns: string[]

getDeleteRule()

Get Delete Rule.

Returns: string

getMatchOption()

Get Match Option.

Returns: string

getName()

Get name

Returns: string

getReferencedColumns()

Get Referenced Columns.

Returns: string[]

getReferencedTableName()

Get Referenced Table Name.

Returns: string

getReferencedTableSchema()

Get Referenced Table Schema.

Returns: string

getSchemaName()

Get schema name

Returns: string

getTableName()

Get table name

Returns: string

getType()

Get type

Returns: string

getUpdateRule()

Get Update Rule.

Returns: string

hasColumns()

Returns: void

isCheck()

Is foreign key

Returns: bool

isForeignKey()

Is foreign key

Returns: bool

isPrimaryKey()

Is primary key

Returns: bool

isUnique()

Is unique key

Returns: bool

setCheckClause()

Set Check Clause.

Parameter Name	Type	Description
$checkClause	string

Returns: self Provides a fluent interface

setColumns()

Set Columns.

Parameter Name	Type	Description
$columns	string[]

Returns: self Provides a fluent interface

setDeleteRule()

Set Delete Rule.

Parameter Name	Type	Description
$deleteRule	string

Returns: self Provides a fluent interface

setMatchOption()

Set Match Option.

Parameter Name	Type	Description
$matchOption	string

Returns: self Provides a fluent interface

setName()

Set name

Parameter Name	Type	Description
$name	string

Returns:

setReferencedColumns()

Set Referenced Columns.

Parameter Name	Type	Description
$referencedColumns	string[]

Returns: self Provides a fluent interface

setReferencedTableName()

Set Referenced Table Name.

Parameter Name	Type	Description
$referencedTableName	string

Returns: self Provides a fluent interface

setReferencedTableSchema()

Set Referenced Table Schema.

Parameter Name	Type	Description
$referencedTableSchema	string

Returns: self Provides a fluent interface

setSchemaName()

Set schema name

Parameter Name	Type	Description
$schemaName	string

Returns:

setTableName()

Set table name

Parameter Name	Type	Description
$tableName	string

Returns: self Provides a fluent interface

setType()

Set type

Parameter Name	Type	Description
$type	string

Returns:

setUpdateRule()

Set Update Rule.

Parameter Name	Type	Description
$updateRule	string

Returns: self Provides a fluent interface