ForeignKey Class Reference

Public Member Functions
	__construct ($name, $columns, $referenceTable, $referenceColumn, $onDeleteRule=null, $onUpdateRule=null)
	setReferenceTable ($referenceTable)
	getReferenceTable ()
	setReferenceColumn ($referenceColumn)
	getReferenceColumn ()
	setOnDeleteRule ($onDeleteRule)
	getOnDeleteRule ()
	setOnUpdateRule ($onUpdateRule)
	getOnUpdateRule ()
	getExpressionData ()
Public Member Functions inherited from AbstractConstraint
	__construct ($columns=null, $name=null)
	setName ($name)
	getName ()
	setColumns ($columns)
	addColumn ($column)
	getColumns ()
	getExpressionData ()
	Returns array of array|string should return an array in the format: array ( // a sprintf formatted string string $specification,// the values for the above sprintf formatted string array $values,// an array of equal length of the $values array, with either TYPE_IDENTIFIER or TYPE_VALUE for each value array $types, )

Protected Attributes
	$onDeleteRule = 'NO ACTION'
	$onUpdateRule = 'NO ACTION'
	$referenceColumn = []
	$referenceTable = ''
	$columnSpecification = 'FOREIGN KEY (%s) '
	$referenceSpecification
Protected Attributes inherited from AbstractConstraint
	$columnSpecification = ' (%s)'
	$namedSpecification = 'CONSTRAINT %s '
	$specification = ''
	$name = ''
	$columns = []

Additional Inherited Members
Public Attributes inherited from ExpressionInterface
const	TYPE_IDENTIFIER = 'identifier'
const	TYPE_VALUE = 'value'
const	TYPE_LITERAL = 'literal'
const	TYPE_SELECT = 'select'

Constructor & Destructor Documentation

__construct	(		$name,
			$columns,
			$referenceTable,
			$referenceColumn,
			$onDeleteRule = null,
			$onUpdateRule = null
	)

Parameters

null | string	$name
null | string | array	$columns
string	$referenceTable
null | string | array	$referenceColumn
null | string	$onDeleteRule
null | string	$onUpdateRule

Member Function Documentation

getExpressionData

(

)

Returns

array

Implements ExpressionInterface.

getOnDeleteRule

(

)

Returns

string

getOnUpdateRule

(

)

Returns

string

getReferenceColumn

(

)

Returns

array

getReferenceTable

(

)

Returns

string

setOnDeleteRule

(

$onDeleteRule

)

Parameters

string

$onDeleteRule

Returns

self

setOnUpdateRule

(

$onUpdateRule

)

Parameters

string

$onUpdateRule

Returns

self

setReferenceColumn

(

$referenceColumn

)

Parameters

null | string | array

$referenceColumn

Returns

self

setReferenceTable

(

$referenceTable

)

Parameters

string

$referenceTable

Returns

self

Member Data Documentation

$columnSpecification = 'FOREIGN KEY (%s) '

protected

$onDeleteRule = 'NO ACTION'

protected

$onUpdateRule = 'NO ACTION'

protected

$referenceColumn = []

protected

$referenceSpecification

protected

Initial value:

= [
        'REFERENCES %s ',
        'ON DELETE %s ON UPDATE %s'
    ]

$referenceTable = ''

protected