PHP Class Jarves\Admin\FieldTypes\RelationDefinition

Inheritance: implements Jarves\Admin\FieldTypes\RelationDefinitionInterface
Show file Open project: jarves/jarves Class Usage Examples

Protected Properties

Property Type Description
$foreignObjectKey string
$name string The actual relation name.
$onDelete string cascade|setnull|restrict|none
$onUpdate string cascade|setnull|restrict|none
$refName string The relation name on the foreign object that points back.
$references Jarves\Admin\FieldTypes\RelationReferenceDefinitionInterface[]
$type string
$withConstraint boolean If the storage backend should also create a constraint so its not possible to pass a invalid reference id

Public Methods

Method Description
getForeignObjectKey ( ) : string
getName ( ) : string
getOnDelete ( ) : string
getOnUpdate ( ) : string
getRefName ( ) : string
getReferences ( ) : Jarves\Admin\FieldTypes\RelationReferenceDefinitionInterface[]
getType ( ) : string
getWithConstraint ( ) : boolean
setForeignObjectKey ( string $foreignObjectKey )
setName ( string $name )
setOnDelete ( string $onDelete )
setOnUpdate ( string $onUpdate )
setRefName ( string $refName )
setReferences ( Jarves\Admin\FieldTypes\RelationReferenceDefinitionInterface[] $references )
setType ( string $type )
setWithConstraint ( boolean $withConstraint ) If the storage backend should also create a constraint so its not possible to pass a invalid reference id.

Method Details

getForeignObjectKey() public method

public getForeignObjectKey ( ) : string
return string

getName() public method

public getName ( ) : string
return string

getOnDelete() public method

public getOnDelete ( ) : string
return string

getOnUpdate() public method

public getOnUpdate ( ) : string
return string

getRefName() public method

public getRefName ( ) : string
return string

getReferences() public method

public getReferences ( ) : Jarves\Admin\FieldTypes\RelationReferenceDefinitionInterface[]
return Jarves\Admin\FieldTypes\RelationReferenceDefinitionInterface[]

getType() public method

public getType ( ) : string
return string

getWithConstraint() public method

public getWithConstraint ( ) : boolean
return boolean

setForeignObjectKey() public method

public setForeignObjectKey ( string $foreignObjectKey )
$foreignObjectKey string

setName() public method

public setName ( string $name )
$name string

setOnDelete() public method

public setOnDelete ( string $onDelete )
$onDelete string

setOnUpdate() public method

public setOnUpdate ( string $onUpdate )
$onUpdate string

setRefName() public method

public setRefName ( string $refName )
$refName string

setReferences() public method

public setReferences ( Jarves\Admin\FieldTypes\RelationReferenceDefinitionInterface[] $references )
$references Jarves\Admin\FieldTypes\RelationReferenceDefinitionInterface[]

setType() public method

public setType ( string $type )
$type string

setWithConstraint() public method

If the storage backend should also create a constraint so its not possible to pass a invalid reference id.
public setWithConstraint ( boolean $withConstraint )
$withConstraint boolean

Property Details

$foreignObjectKey protected property

protected string $foreignObjectKey
return string

$name protected property

The actual relation name.
protected string $name
return string

$onDelete protected property

cascade|setnull|restrict|none
protected string $onDelete
return string

$onUpdate protected property

cascade|setnull|restrict|none
protected string $onUpdate
return string

$refName protected property

The relation name on the foreign object that points back.
protected string $refName
return string

$references protected property

protected RelationReferenceDefinitionInterface[],Jarves\Admin\FieldTypes $references
return Jarves\Admin\FieldTypes\RelationReferenceDefinitionInterface[]

$type protected property

protected string $type
return string

$withConstraint protected property

If the storage backend should also create a constraint so its not possible to pass a invalid reference id
protected bool $withConstraint
return boolean