PHP Класс FluidTYPO3\Flux\Form\AbstractRelationFormField

Наследование: extends AbstractMultiValueFormField, implements FluidTYPO3\Flux\Form\RelationFieldInterface
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$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

Открытые методы

Метод Описание
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

Описание методов

getCondition() публичный Метод

public getCondition ( ) : string
Результат string

getDisableMovingChildrenWithParent() публичный Метод

public getDisableMovingChildrenWithParent ( ) : boolean
Результат boolean

getEmptyOption() публичный Метод

public getEmptyOption ( ) : boolean | string
Результат boolean | string

getFilter() публичный Метод

public getFilter ( ) : array
Результат array

getForeignDefaultSortby() публичный Метод

public getForeignDefaultSortby ( ) : string
Результат string

getForeignField() публичный Метод

public getForeignField ( ) : string
Результат string

getForeignLabel() публичный Метод

public getForeignLabel ( ) : string
Результат string

getForeignSelector() публичный Метод

public getForeignSelector ( ) : string
Результат string

getForeignSortby() публичный Метод

public getForeignSortby ( ) : string
Результат string

getForeignTableField() публичный Метод

public getForeignTableField ( ) : string
Результат string

getForeignUnique() публичный Метод

public getForeignUnique ( ) : string
Результат string

getItemListStyle() публичный Метод

public getItemListStyle ( ) : string
Результат string

getLocalizationMode() публичный Метод

public getLocalizationMode ( ) : string
Результат string

getLocalizeChildrenAtParentLocalization() публичный Метод

public getLocalizeChildrenAtParentLocalization ( ) : boolean
Результат boolean

getManyToMany() публичный Метод

public getManyToMany ( ) : null | string
Результат null | string

getMatchFields() публичный Метод

public getMatchFields ( ) : array
Результат array

getOppositeField() публичный Метод

public getOppositeField ( ) : string
Результат string

getSelectedListStyle() публичный Метод

public getSelectedListStyle ( ) : string
Результат string

getShowThumbnails() публичный Метод

public getShowThumbnails ( ) : boolean
Результат boolean

getSymmetricField() публичный Метод

public getSymmetricField ( ) : string
Результат string

getSymmetricLabel() публичный Метод

public getSymmetricLabel ( ) : string
Результат string

getSymmetricSortby() публичный Метод

public getSymmetricSortby ( ) : string
Результат string

getTable() публичный Метод

public getTable ( ) : string
Результат string

prepareConfiguration() публичный Метод

public prepareConfiguration ( string $type ) : array
$type string
Результат array

setCondition() публичный Метод

public setCondition ( string $condition ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$condition string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setDisableMovingChildrenWithParent() публичный Метод

public setDisableMovingChildrenWithParent ( boolean $disableMovingChildrenWithParent ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$disableMovingChildrenWithParent boolean
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setEmptyOption() публичный Метод

public setEmptyOption ( boolean | string $emptyOption ) : Select
$emptyOption boolean | string
Результат Select

setFilter() публичный Метод

public setFilter ( array $filter ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$filter array
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setForeignDefaultSortby() публичный Метод

public setForeignDefaultSortby ( string $foreignDefaultSortby ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$foreignDefaultSortby string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setForeignField() публичный Метод

public setForeignField ( string $foreignField ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$foreignField string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setForeignLabel() публичный Метод

public setForeignLabel ( string $foreignLabel ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$foreignLabel string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setForeignSelector() публичный Метод

public setForeignSelector ( string $foreignSelector ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$foreignSelector string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setForeignSortby() публичный Метод

public setForeignSortby ( string $foreignSortby ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$foreignSortby string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setForeignTableField() публичный Метод

public setForeignTableField ( string $foreignTableField ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$foreignTableField string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setForeignUnique() публичный Метод

public setForeignUnique ( string $foreignUnique ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$foreignUnique string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setItemListStyle() публичный Метод

public setItemListStyle ( string $itemListStyle ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$itemListStyle string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setLocalizationMode() публичный Метод

public setLocalizationMode ( string $localizationMode ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$localizationMode string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setLocalizeChildrenAtParentLocalization() публичный Метод

public setLocalizeChildrenAtParentLocalization ( boolean $localizeChildrenAtParentLocalization ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$localizeChildrenAtParentLocalization boolean
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setManyToMany() публичный Метод

public setManyToMany ( null | string $manyToMany ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$manyToMany null | string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setMatchFields() публичный Метод

public setMatchFields ( array $matchFields ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$matchFields array
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setOppositeField() публичный Метод

public setOppositeField ( string $oppositeField ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$oppositeField string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setSelectedListStyle() публичный Метод

public setSelectedListStyle ( string $selectedListStyle ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$selectedListStyle string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setShowThumbnails() публичный Метод

public setShowThumbnails ( boolean $showThumbnails ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$showThumbnails boolean
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setSymmetricField() публичный Метод

public setSymmetricField ( string $symmetricField ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$symmetricField string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setSymmetricLabel() публичный Метод

public setSymmetricLabel ( string $symmetricLabel ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$symmetricLabel string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setSymmetricSortby() публичный Метод

public setSymmetricSortby ( string $symmetricSortby ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$symmetricSortby string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

setTable() публичный Метод

public setTable ( string $table ) : FluidTYPO3\Flux\Form\RelationFieldInterface
$table string
Результат FluidTYPO3\Flux\Form\RelationFieldInterface

Описание свойств

$condition защищенное свойство

protected string $condition
Результат string

$disableMovingChildrenWithParent защищенное свойство

Disables that child records get moved along with their parent records.
protected bool $disableMovingChildrenWithParent
Результат boolean

$emptyOption защищенное свойство

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
Результат boolean | string

$filter защищенное свойство

Optional filter - as an array($userFunctionReferenceString, $parameters) - to further condition which records are allowed to be selected in this field.
protected array $filter
Результат array

$foreignDefaultSortby защищенное свойство

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
Результат string

$foreignField защищенное свойство

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
Результат string

$foreignLabel защищенное свойство

If set, it overrides the label set in TCA[foreign_table]['ctrl']['label'] for the foreign table view.
protected string $foreignLabel
Результат string

$foreignSelector защищенное свойство

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
Результат string

$foreignSortby защищенное свойство

Defines a field on the child record (or on the intermediate table) that stores the manual sorting information.
protected string $foreignSortby
Результат string

$foreignTableField защищенное свойство

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
Результат string

$foreignUnique защищенное свойство

Field which must be uniue for all children of a parent record.
protected string $foreignUnique
Результат string

$localizationMode защищенное свойство

Set whether children can be localizable ('select') or just inherit from default language ('keep'). Default is empty, meaning no particular behavior.
protected string $localizationMode
Результат string

$localizeChildrenAtParentLocalization защищенное свойство

Defines whether children should be localized when the localization of the parent gets created.
protected bool $localizeChildrenAtParentLocalization
Результат boolean

$manyToMany защищенное свойство

protected string|NULL $manyToMany
Результат string | null

$matchFields защищенное свойство

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
Результат array

$showThumbnails защищенное свойство

protected bool $showThumbnails
Результат boolean

$symmetricField защищенное свойство

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
Результат string

$symmetricLabel защищенное свойство

If set, this overrides the default label of the selected symmetric table.
protected string $symmetricLabel
Результат string

$symmetricSortby защищенное свойство

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
Результат string

$table защищенное свойство

protected string $table
Результат string