Class ForeignKey

Summary

Fully Qualified Name: Laminas\Db\Sql\Ddl\Constraint\ForeignKey
Extends: AbstractConstraint

Description

Methods

Name Description Defined By
__construct() ForeignKey
addColumn() AbstractConstraint
getColumns() {@inheritDoc} AbstractConstraint
getExpressionData() ForeignKey
getName() AbstractConstraint
getOnDeleteRule() ForeignKey
getOnUpdateRule() ForeignKey
getReferenceColumn() ForeignKey
getReferenceTable() ForeignKey
setColumns() AbstractConstraint
setName() AbstractConstraint
setOnDeleteRule() ForeignKey
setOnUpdateRule() ForeignKey
setReferenceColumn() ForeignKey
setReferenceTable() ForeignKey

Method Details

__construct()

Parameter Name Type Description
$name null|string
$columns null|string|array
$referenceTable string
$referenceColumn null|string|array
$onDeleteRule null|string
$onUpdateRule null|string

Returns:

addColumn()

Parameter Name Type Description
$column string

Returns: self Provides a fluent interface

getColumns()

{@inheritDoc}

Returns:

getExpressionData()

Returns: array

getName()

Returns: string

getOnDeleteRule()

Returns: string

getOnUpdateRule()

Returns: string

getReferenceColumn()

Returns: array

getReferenceTable()

Returns: string

setColumns()

Parameter Name Type Description
$columns null|string|array

Returns: self Provides a fluent interface

setName()

Parameter Name Type Description
$name string

Returns: self Provides a fluent interface

setOnDeleteRule()

Parameter Name Type Description
$onDeleteRule string

Returns: self Provides a fluent interface

setOnUpdateRule()

Parameter Name Type Description
$onUpdateRule string

Returns: self Provides a fluent interface

setReferenceColumn()

Parameter Name Type Description
$referenceColumn null|string|array

Returns: self Provides a fluent interface

setReferenceTable()

Parameter Name Type Description
$referenceTable string

Returns: self Provides a fluent interface

Top