Skip to content

Commit c9fea2f

Browse files
nhovratovnhovratov
committed
[DOCS] Document missing properties for Folder and Relation FieldTypes
(cherry picked from commit 43b9363)
1 parent 951a4f5 commit c9fea2f

2 files changed

Lines changed: 330 additions & 0 deletions

File tree

‎Documentation/YamlReference/FieldTypes/Folder/Index.rst‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,90 @@ Settings
5454
be filled directly with the folder instead of a collection of folders. In
5555
addition, :yaml:`maxitems` will be automatically set to :yaml:`1`.
5656

57+
.. confval:: autoSizeMax
58+
:name: folder-autoSizeMax
59+
:required: false
60+
:type: integer
61+
62+
The field will never grow larger than this number of visible rows.
63+
64+
.. confval:: behaviour.allowLanguageSynchronization
65+
:name: folder-behaviour.allowLanguageSynchronization
66+
:required: false
67+
:type: boolean
68+
:default: false
69+
70+
Allows to select if localization uses custom or default language value.
71+
72+
.. confval:: default
73+
:name: folder-default
74+
:required: false
75+
:type: string
76+
77+
Default value set if a new record is created.
78+
79+
.. confval:: fieldControl
80+
:name: folder-fieldControl
81+
:required: false
82+
:type: object
83+
84+
See :ref:`TCA fieldControl <t3tca:tca_property_fieldControl>`. The
85+
:yaml:`elementBrowser` control can be disabled via
86+
:yaml:`fieldControl.elementBrowser.disabled: true`.
87+
88+
.. confval:: fieldInformation
89+
:name: folder-fieldInformation
90+
:required: false
91+
:type: object
92+
93+
See :ref:`TCA fieldInformation <t3tca:tca_property_fieldInformation>`.
94+
95+
.. confval:: fieldWizard
96+
:name: folder-fieldWizard
97+
:required: false
98+
:type: object
99+
100+
See :ref:`TCA fieldWizard <t3tca:tca_property_fieldWizard>`.
101+
102+
.. confval:: hideDeleteIcon
103+
:name: folder-hideDeleteIcon
104+
:required: false
105+
:type: boolean
106+
107+
Removes the delete icon next to the selector box.
108+
109+
.. confval:: hideMoveIcons
110+
:name: folder-hideMoveIcons
111+
:required: false
112+
:type: boolean
113+
114+
Removes the move icons next to the selector box.
115+
116+
.. confval:: multiple
117+
:name: folder-multiple
118+
:required: false
119+
:type: boolean
120+
:default: false
121+
122+
Allows the same folder to be selected more than once in the list.
123+
124+
.. confval:: readOnly
125+
:name: folder-readOnly
126+
:required: false
127+
:type: boolean
128+
:default: false
129+
130+
Renders the field in a way that the user can see the value but cannot edit it.
131+
132+
.. confval:: size
133+
:name: folder-size
134+
:required: false
135+
:type: integer
136+
:default: 1
137+
138+
Number of visible rows in the selector box. A value of 1 displays a
139+
drop-down.
140+
57141
Examples
58142
========
59143

‎Documentation/YamlReference/FieldTypes/Relation/Index.rst‎

Lines changed: 246 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,252 @@ Settings
5757
be filled directly with the record instead of a collection of records. In
5858
addition, :yaml:`maxitems` will be automatically set to :yaml:`1`.
5959

60+
.. confval:: autoSizeMax
61+
:name: relation-autoSizeMax
62+
:required: false
63+
:type: integer
64+
65+
The field will never grow larger than this number of visible rows.
66+
67+
.. confval:: behaviour.allowLanguageSynchronization
68+
:name: relation-behaviour.allowLanguageSynchronization
69+
:required: false
70+
:type: boolean
71+
:default: false
72+
73+
Allows to select if localization uses custom or default language value.
74+
75+
.. confval:: default
76+
:name: relation-default
77+
:required: false
78+
:type: string|integer
79+
80+
Default value set if a new record is created.
81+
82+
.. confval:: dontRemapTablesOnCopy
83+
:name: relation-dontRemapTablesOnCopy
84+
:required: false
85+
:type: array
86+
87+
A list of tables which should not be remapped to the new element uids if
88+
the field holds elements that are copied in the session.
89+
90+
.. confval:: elementBrowserEntryPoints
91+
:name: relation-elementBrowserEntryPoints
92+
:required: false
93+
:type: object
94+
95+
Changes the default starting point when opening the element browser. Use
96+
the key :yaml:`_default` to set the default page uid.
97+
98+
Example:
99+
100+
.. code-block:: yaml
101+
102+
elementBrowserEntryPoints:
103+
_default: 42
104+
105+
.. confval:: fieldControl
106+
:name: relation-fieldControl
107+
:required: false
108+
:type: object
109+
110+
Enables or disables individual controls next to the field. Each control
111+
accepts a :yaml:`disabled` boolean. Available controls:
112+
:yaml:`addRecord`, :yaml:`editPopup`, :yaml:`listModule`,
113+
:yaml:`elementBrowser`, :yaml:`insertClipboard`.
114+
115+
See :ref:`TCA fieldControl <t3tca:tca_property_fieldControl>`.
116+
117+
.. confval:: fieldInformation
118+
:name: relation-fieldInformation
119+
:required: false
120+
:type: object
121+
122+
See :ref:`TCA fieldInformation <t3tca:tca_property_fieldInformation>`.
123+
124+
.. confval:: fieldWizard
125+
:name: relation-fieldWizard
126+
:required: false
127+
:type: object
128+
129+
See :ref:`TCA fieldWizard <t3tca:tca_property_fieldWizard>`.
130+
131+
.. confval:: filter
132+
:name: relation-filter
133+
:required: false
134+
:type: array
135+
136+
Defines filters for item values. Each entry requires a :yaml:`userFunc`
137+
key and an optional :yaml:`parameters` object. Does not work in combination
138+
with a wizard.
139+
140+
.. confval:: foreign_table
141+
:name: relation-foreign_table
142+
:required: false
143+
:type: string
144+
145+
Restricts selectable records to a specific table. Can be used instead of
146+
or together with :yaml:`allowed`.
147+
148+
.. confval:: hideDeleteIcon
149+
:name: relation-hideDeleteIcon
150+
:required: false
151+
:type: boolean
152+
153+
Removes the delete icon next to the selector box.
154+
155+
.. confval:: hideMoveIcons
156+
:name: relation-hideMoveIcons
157+
:required: false
158+
:type: boolean
159+
160+
Removes the move icons next to the selector box.
161+
162+
.. confval:: hideSuggest
163+
:name: relation-hideSuggest
164+
:required: false
165+
:type: boolean
166+
167+
Disables the suggest (autocomplete) wizard.
168+
169+
.. confval:: localizeReferencesAtParentLocalization
170+
:name: relation-localizeReferencesAtParentLocalization
171+
:required: false
172+
:type: boolean
173+
174+
Defines whether referenced records should be localized when the current
175+
record gets localized. Only applies if references are not stored using MM
176+
tables.
177+
178+
.. confval:: MM
179+
:name: relation-MM
180+
:required: false
181+
:type: string
182+
183+
Table name for storing the MM relation. Used together with
184+
:yaml:`foreign_table`.
185+
186+
.. confval:: MM_match_fields
187+
:name: relation-MM_match_fields
188+
:required: false
189+
:type: object
190+
191+
Field-value pairs to both insert and match against when writing/reading MM
192+
relations.
193+
194+
.. confval:: MM_opposite_field
195+
:name: relation-MM_opposite_field
196+
:required: false
197+
:type: string
198+
199+
Enables bidirectional MM relations. Set to the field name on the local side
200+
when configuring the foreign side.
201+
202+
.. confval:: MM_oppositeUsage
203+
:name: relation-MM_oppositeUsage
204+
:required: false
205+
:type: object
206+
207+
Required on the opposite side of a bidirectional MM relation that uses match
208+
fields.
209+
210+
.. confval:: MM_table_where
211+
:name: relation-MM_table_where
212+
:required: false
213+
:type: string
214+
215+
Additional WHERE clause used when reading MM relations.
216+
217+
.. confval:: multiple
218+
:name: relation-multiple
219+
:required: false
220+
:type: boolean
221+
:default: false
222+
223+
Allows the same record to be selected more than once in the list.
224+
225+
.. confval:: prepend_tname
226+
:name: relation-prepend_tname
227+
:required: false
228+
:type: boolean
229+
230+
When enabled, the table name is prepended to the stored relation uids.
231+
232+
.. confval:: readOnly
233+
:name: relation-readOnly
234+
:required: false
235+
:type: boolean
236+
:default: false
237+
238+
Renders the field in a way that the user can see the value but cannot edit it.
239+
240+
.. confval:: size
241+
:name: relation-size
242+
:required: false
243+
:type: integer
244+
:default: 1
245+
246+
Number of visible rows in the selector box. A value of 1 displays a
247+
drop-down.
248+
249+
.. confval:: suggestOptions
250+
:name: relation-suggestOptions
251+
:required: false
252+
:type: object
253+
254+
Configuration for the suggest (autocomplete) wizard. Keys are table names
255+
or :yaml:`default` to apply to all tables. Each entry supports:
256+
257+
additionalSearchFields (string)
258+
Comma-separated list of extra fields to search in.
259+
260+
addWhere (string)
261+
Additional WHERE clause appended to the search query.
262+
263+
cssClass (string)
264+
CSS class added to every result list item.
265+
266+
maxItemsInResultList (integer, default 10)
267+
Maximum number of results to display.
268+
269+
maxPathTitleLength (integer)
270+
Maximum characters shown for a path element.
271+
272+
minimumCharacters (integer)
273+
Minimum characters required to trigger the search.
274+
275+
orderBy (string)
276+
ORDER BY clause for the search query.
277+
278+
pidList (string)
279+
Comma-separated page uids to limit the search scope.
280+
281+
pidDepth (integer)
282+
Number of sub-page levels to expand from :yaml:`pidList`.
283+
284+
receiverClass (string)
285+
Alternative PHP receiver class for the suggest wizard.
286+
287+
renderFunc (string)
288+
User function to manipulate the displayed results.
289+
290+
searchCondition (string)
291+
Additional WHERE clause (not prepended with AND).
292+
293+
searchWholePhrase (boolean)
294+
Searches for the whole phrase rather than only the beginning.
295+
296+
Example:
297+
298+
.. code-block:: yaml
299+
300+
suggestOptions:
301+
default:
302+
additionalSearchFields: 'nav_title, url'
303+
addWhere: 'AND pages.doktype = 1'
304+
minimumCharacters: 2
305+
60306
Examples
61307
========
62308

0 commit comments

Comments
 (0)