Property | 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 |
Method | 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 |
public getDisableMovingChildrenWithParent ( ) : boolean | ||
return | boolean |
public getLocalizeChildrenAtParentLocalization ( ) : boolean | ||
return | boolean |
public prepareConfiguration ( string $type ) : array | ||
$type | string | |
return | array |
public setCondition ( string $condition ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$condition | string | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setDisableMovingChildrenWithParent ( boolean $disableMovingChildrenWithParent ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$disableMovingChildrenWithParent | boolean | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setEmptyOption ( boolean | string $emptyOption ) : Select | ||
$emptyOption | boolean | string | |
return | Select |
public setForeignDefaultSortby ( string $foreignDefaultSortby ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$foreignDefaultSortby | string | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setForeignField ( string $foreignField ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$foreignField | string | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setForeignLabel ( string $foreignLabel ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$foreignLabel | string | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setForeignSelector ( string $foreignSelector ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$foreignSelector | string | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setForeignSortby ( string $foreignSortby ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$foreignSortby | string | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setForeignTableField ( string $foreignTableField ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$foreignTableField | string | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setForeignUnique ( string $foreignUnique ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$foreignUnique | string | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setItemListStyle ( string $itemListStyle ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$itemListStyle | string | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setLocalizationMode ( string $localizationMode ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$localizationMode | string | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setLocalizeChildrenAtParentLocalization ( boolean $localizeChildrenAtParentLocalization ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$localizeChildrenAtParentLocalization | boolean | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setManyToMany ( null | string $manyToMany ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$manyToMany | null | string | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setMatchFields ( array $matchFields ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$matchFields | array | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setOppositeField ( string $oppositeField ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$oppositeField | string | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setSelectedListStyle ( string $selectedListStyle ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$selectedListStyle | string | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setShowThumbnails ( boolean $showThumbnails ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$showThumbnails | boolean | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setSymmetricField ( string $symmetricField ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$symmetricField | string | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setSymmetricLabel ( string $symmetricLabel ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$symmetricLabel | string | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
public setSymmetricSortby ( string $symmetricSortby ) : FluidTYPO3\Flux\Form\RelationFieldInterface | ||
$symmetricSortby | string | |
return | FluidTYPO3\Flux\Form\RelationFieldInterface |
protected bool $disableMovingChildrenWithParent | ||
return | boolean |
protected array $filter | ||
return | array |
protected string $foreignDefaultSortby | ||
return | string |
protected string $foreignField | ||
return | string |
protected string $foreignLabel | ||
return | string |
protected string $foreignSelector | ||
return | string |
protected string $foreignSortby | ||
return | string |
protected string $foreignTableField | ||
return | string |
protected string $foreignUnique | ||
return | string |
protected string $localizationMode | ||
return | string |
protected bool $localizeChildrenAtParentLocalization | ||
return | boolean |
protected array $matchFields | ||
return | array |
protected string $symmetricField | ||
return | string |
protected string $symmetricLabel | ||
return | string |
protected string $symmetricSortby | ||
return | string |