PHP Class FluidTYPO3\Flux\Form\AbstractRelationFormField

Inheritance: extends AbstractMultiValueFormField, implements FluidTYPO3\Flux\Form\RelationFieldInterface
Afficher le fichier Open project: fluidtypo3/flux Class Usage Examples

Protected Properties

Свойство Type Description
$condition string
$disableMovingChildrenWithParent boolean Disables that child records get moved along with their parent records.
$emptyOption boolean | string If not-FALSE, adds one empty option/value pair to the generated selector box and tries to use this property's value (cast to string) as label.
$filter array Optional filter - as an array($userFunctionReferenceString, $parameters) - to further condition which records are allowed to be selected in this field.
$foreignDefaultSortby string If a fieldname for foreign_sortby is defined, then this is ignored. Otherwise this is used as the "ORDER BY" statement to sort the records in the table when listed.
$foreignField string The foreign_field is the field of the child record pointing to the parent record. This defines where to store the uid of the parent record.
$foreignLabel string If set, it overrides the label set in TCA[foreign_table]['ctrl']['label'] for the foreign table view.
$foreignSelector string A selector is used to show all possible child records that could be used to create a relation with the parent record. It will be rendered as a multi-select-box. On clicking on an item inside the selector a new relation is created. The foreign_selector points to a field of the foreign_table that is responsible for providing a selector-box – this field on the foreign_table usually has the type "select" and also has a "foreign_table" defined.
$foreignSortby string Defines a field on the child record (or on the intermediate table) that stores the manual sorting information.
$foreignTableField string The field of the child record pointing to the parent record. This defines where to store the table name of the parent record. On setting this configuration key together with foreign_field, the child record knows what its parent record is – so the child record could also be used on other parent tables.
$foreignUnique string Field which must be uniue for all children of a parent record.
$localizationMode string Set whether children can be localizable ('select') or just inherit from default language ('keep'). Default is empty, meaning no particular behavior.
$localizeChildrenAtParentLocalization boolean Defines whether children should be localized when the localization of the parent gets created.
$manyToMany string | null
$matchFields array When using many-to-many mode you can specify an array of field=>value pairs which must also match in the relation table when the relation is resolved.
$showThumbnails boolean
$symmetricField string In case of bidirectional symmetric relations, this defines the field name on the foreign table which contains the UID of this side of the relation.
$symmetricLabel string If set, this overrides the default label of the selected symmetric table.
$symmetricSortby string This works like foreign_sortby, but defines the field on foreign_table where the "other" sort order is stored (this order is then used only in the reverse symmetric relation).
$table string

Méthodes publiques

Méthode Description
getCondition ( ) : string
getDisableMovingChildrenWithParent ( ) : boolean
getEmptyOption ( ) : boolean | string
getFilter ( ) : array
getForeignDefaultSortby ( ) : string
getForeignField ( ) : string
getForeignLabel ( ) : string
getForeignSelector ( ) : string
getForeignSortby ( ) : string
getForeignTableField ( ) : string
getForeignUnique ( ) : string
getItemListStyle ( ) : string
getLocalizationMode ( ) : string
getLocalizeChildrenAtParentLocalization ( ) : boolean
getManyToMany ( ) : null | string
getMatchFields ( ) : array
getOppositeField ( ) : string
getSelectedListStyle ( ) : string
getShowThumbnails ( ) : boolean
getSymmetricField ( ) : string
getSymmetricLabel ( ) : string
getSymmetricSortby ( ) : string
getTable ( ) : string
prepareConfiguration ( string $type ) : array
setCondition ( string $condition ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setDisableMovingChildrenWithParent ( boolean $disableMovingChildrenWithParent ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setEmptyOption ( boolean | string $emptyOption ) : Select
setFilter ( array $filter ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setForeignDefaultSortby ( string $foreignDefaultSortby ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setForeignField ( string $foreignField ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setForeignLabel ( string $foreignLabel ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setForeignSelector ( string $foreignSelector ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setForeignSortby ( string $foreignSortby ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setForeignTableField ( string $foreignTableField ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setForeignUnique ( string $foreignUnique ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setItemListStyle ( string $itemListStyle ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setLocalizationMode ( string $localizationMode ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setLocalizeChildrenAtParentLocalization ( boolean $localizeChildrenAtParentLocalization ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setManyToMany ( null | string $manyToMany ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setMatchFields ( array $matchFields ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setOppositeField ( string $oppositeField ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setSelectedListStyle ( string $selectedListStyle ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setShowThumbnails ( boolean $showThumbnails ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setSymmetricField ( string $symmetricField ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setSymmetricLabel ( string $symmetricLabel ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setSymmetricSortby ( string $symmetricSortby ) : FluidTYPO3\Flux\Form\RelationFieldInterface
setTable ( string $table ) : FluidTYPO3\Flux\Form\RelationFieldInterface

Method Details

getCondition() public méthode

public getCondition ( ) : string
Résultat string

getDisableMovingChildrenWithParent() public méthode

getEmptyOption() public méthode

public getEmptyOption ( ) : boolean | string
Résultat boolean | string

getFilter() public méthode

public getFilter ( ) : array
Résultat array

getForeignDefaultSortby() public méthode

public getForeignDefaultSortby ( ) : string
Résultat string

getForeignField() public méthode

public getForeignField ( ) : string
Résultat string

getForeignLabel() public méthode

public getForeignLabel ( ) : string
Résultat string

getForeignSelector() public méthode

public getForeignSelector ( ) : string
Résultat string

getForeignSortby() public méthode

public getForeignSortby ( ) : string
Résultat string

getForeignTableField() public méthode

public getForeignTableField ( ) : string
Résultat string

getForeignUnique() public méthode

public getForeignUnique ( ) : string
Résultat string

getItemListStyle() public méthode

public getItemListStyle ( ) : string
Résultat string

getLocalizationMode() public méthode

public getLocalizationMode ( ) : string
Résultat string

getLocalizeChildrenAtParentLocalization() public méthode

getManyToMany() public méthode

public getManyToMany ( ) : null | string
Résultat null | string

getMatchFields() public méthode

public getMatchFields ( ) : array
Résultat array

getOppositeField() public méthode

public getOppositeField ( ) : string
Résultat string

getSelectedListStyle() public méthode

public getSelectedListStyle ( ) : string
Résultat string

getShowThumbnails() public méthode

public getShowThumbnails ( ) : boolean
Résultat boolean

getSymmetricField() public méthode

public getSymmetricField ( ) : string
Résultat string

getSymmetricLabel() public méthode

public getSymmetricLabel ( ) : string
Résultat string

getSymmetricSortby() public méthode

public getSymmetricSortby ( ) : string
Résultat string

getTable() public méthode

public getTable ( ) : string
Résultat string

prepareConfiguration() public méthode

public prepareConfiguration ( string $type ) : array
$type string
Résultat array

setCondition() public méthode

public setCondition ( string $condition ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$condition string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setDisableMovingChildrenWithParent() public méthode

public setDisableMovingChildrenWithParent ( boolean $disableMovingChildrenWithParent ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$disableMovingChildrenWithParent boolean
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setEmptyOption() public méthode

public setEmptyOption ( boolean | string $emptyOption ) : Select
$emptyOption boolean | string
Résultat Select

setFilter() public méthode

public setFilter ( array $filter ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$filter array
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setForeignDefaultSortby() public méthode

public setForeignDefaultSortby ( string $foreignDefaultSortby ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$foreignDefaultSortby string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setForeignField() public méthode

public setForeignField ( string $foreignField ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$foreignField string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setForeignLabel() public méthode

public setForeignLabel ( string $foreignLabel ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$foreignLabel string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setForeignSelector() public méthode

public setForeignSelector ( string $foreignSelector ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$foreignSelector string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setForeignSortby() public méthode

public setForeignSortby ( string $foreignSortby ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$foreignSortby string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setForeignTableField() public méthode

public setForeignTableField ( string $foreignTableField ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$foreignTableField string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setForeignUnique() public méthode

public setForeignUnique ( string $foreignUnique ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$foreignUnique string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setItemListStyle() public méthode

public setItemListStyle ( string $itemListStyle ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$itemListStyle string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setLocalizationMode() public méthode

public setLocalizationMode ( string $localizationMode ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$localizationMode string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setLocalizeChildrenAtParentLocalization() public méthode

public setLocalizeChildrenAtParentLocalization ( boolean $localizeChildrenAtParentLocalization ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$localizeChildrenAtParentLocalization boolean
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setManyToMany() public méthode

public setManyToMany ( null | string $manyToMany ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$manyToMany null | string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setMatchFields() public méthode

public setMatchFields ( array $matchFields ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$matchFields array
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setOppositeField() public méthode

public setOppositeField ( string $oppositeField ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$oppositeField string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setSelectedListStyle() public méthode

public setSelectedListStyle ( string $selectedListStyle ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$selectedListStyle string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setShowThumbnails() public méthode

public setShowThumbnails ( boolean $showThumbnails ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$showThumbnails boolean
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setSymmetricField() public méthode

public setSymmetricField ( string $symmetricField ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$symmetricField string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setSymmetricLabel() public méthode

public setSymmetricLabel ( string $symmetricLabel ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$symmetricLabel string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setSymmetricSortby() public méthode

public setSymmetricSortby ( string $symmetricSortby ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$symmetricSortby string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

setTable() public méthode

public setTable ( string $table ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$table string
Résultat FluidTYPO3\Flux\Form\RelationFieldInterface

Property Details

$condition protected_oe property

protected string $condition
Résultat string

$disableMovingChildrenWithParent protected_oe property

Disables that child records get moved along with their parent records.
protected bool $disableMovingChildrenWithParent
Résultat boolean

$emptyOption protected_oe property

If not-FALSE, adds one empty option/value pair to the generated selector box and tries to use this property's value (cast to string) as label.
protected bool|string $emptyOption
Résultat boolean | string

$filter protected_oe property

Optional filter - as an array($userFunctionReferenceString, $parameters) - to further condition which records are allowed to be selected in this field.
protected array $filter
Résultat array

$foreignDefaultSortby protected_oe property

If a fieldname for foreign_sortby is defined, then this is ignored. Otherwise this is used as the "ORDER BY" statement to sort the records in the table when listed.
protected string $foreignDefaultSortby
Résultat string

$foreignField protected_oe property

The foreign_field is the field of the child record pointing to the parent record. This defines where to store the uid of the parent record.
protected string $foreignField
Résultat string

$foreignLabel protected_oe property

If set, it overrides the label set in TCA[foreign_table]['ctrl']['label'] for the foreign table view.
protected string $foreignLabel
Résultat string

$foreignSelector protected_oe property

A selector is used to show all possible child records that could be used to create a relation with the parent record. It will be rendered as a multi-select-box. On clicking on an item inside the selector a new relation is created. The foreign_selector points to a field of the foreign_table that is responsible for providing a selector-box – this field on the foreign_table usually has the type "select" and also has a "foreign_table" defined.
protected string $foreignSelector
Résultat string

$foreignSortby protected_oe property

Defines a field on the child record (or on the intermediate table) that stores the manual sorting information.
protected string $foreignSortby
Résultat string

$foreignTableField protected_oe property

The field of the child record pointing to the parent record. This defines where to store the table name of the parent record. On setting this configuration key together with foreign_field, the child record knows what its parent record is – so the child record could also be used on other parent tables.
protected string $foreignTableField
Résultat string

$foreignUnique protected_oe property

Field which must be uniue for all children of a parent record.
protected string $foreignUnique
Résultat string

$localizationMode protected_oe property

Set whether children can be localizable ('select') or just inherit from default language ('keep'). Default is empty, meaning no particular behavior.
protected string $localizationMode
Résultat string

$localizeChildrenAtParentLocalization protected_oe property

Defines whether children should be localized when the localization of the parent gets created.
protected bool $localizeChildrenAtParentLocalization
Résultat boolean

$manyToMany protected_oe property

protected string|NULL $manyToMany
Résultat string | null

$matchFields protected_oe property

When using many-to-many mode you can specify an array of field=>value pairs which must also match in the relation table when the relation is resolved.
protected array $matchFields
Résultat array

$showThumbnails protected_oe property

protected bool $showThumbnails
Résultat boolean

$symmetricField protected_oe property

In case of bidirectional symmetric relations, this defines the field name on the foreign table which contains the UID of this side of the relation.
protected string $symmetricField
Résultat string

$symmetricLabel protected_oe property

If set, this overrides the default label of the selected symmetric table.
protected string $symmetricLabel
Résultat string

$symmetricSortby protected_oe property

This works like foreign_sortby, but defines the field on foreign_table where the "other" sort order is stored (this order is then used only in the reverse symmetric relation).
protected string $symmetricSortby
Résultat string

$table protected_oe property

protected string $table
Résultat string