ForeignKeyConstraint

API reference › yii › db › ForeignKeyConstraint

class	yii\db\ForeignKeyConstraint
Extends	Constraint » yii\base\BaseObject
Implements	yii\base\Configurable
Since	2.0.13
Source	framework/db/ForeignKeyConstraint.php

ForeignKeyConstraint represents the metadata of a table FOREIGN KEY constraint.

Properties

Property	Type	Description	Defined by
$columnNames	string[]|null	List of column names the constraint belongs to. Default: null.	Constraint
$foreignColumnNames	string[]	List of referenced table column names. Default: null.	ForeignKeyConstraint
$foreignSchemaName	string|null	Referenced table schema name. Default: null.	ForeignKeyConstraint
$foreignTableName	string	Referenced table name. Default: null.	ForeignKeyConstraint
$name	string|null	The constraint name. Default: null.	Constraint
$onDelete	string|null	Referential action if rows in a referenced table are to be deleted. Default: null.	ForeignKeyConstraint
$onUpdate	string|null	Referential action if rows in a referenced table are to be updated. Default: null.	ForeignKeyConstraint

Methods

Method	Description	Defined by
__construct()	Constructor.	yii\base\BaseObject
__call()	Calls the named method which is not a class method.	yii\base\BaseObject
__get()	Returns the value of an object property.	yii\base\BaseObject
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
__set()	Sets value of an object property.	yii\base\BaseObject
__unset()	Sets an object property to null.	yii\base\BaseObject
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\BaseObject
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\BaseObject
className() static	Returns the fully qualified name of this class.	yii\base\BaseObject
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\BaseObject
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\BaseObject
init()	Initializes the object.	yii\base\BaseObject