Adding an alternate layout parameter to custom fields #18571

Bakual · 2017-11-14T20:17:33Z

Pull Request for Issue #18162 .

Summary of Changes

Adds a new parameter "Layout" to custom fields which allows to select a different field layout for the automatic display.

Testing Instructions

Create alternative layouts for a custom field. The original one is components/com_fields/layout/field/render.php, it can be overriden at component and template level, so for com_content in components/com_content/layout/field/, templates/your_template/html/layouts/com_content/field and templates/your_template/html/layouts/com_fields/field. The file isn't allowed to contain an underscore.
Create a custom field and change the layout for that field, assign some value to it
Check in frontend if that layout is used as expected.

Expected result

Layout is used as specified

Actual result

Not possible to choose a different layout

Documentation Changes Required

Since it is a new feature, it has to be documented.

brianteeman · 2017-11-14T20:26:06Z

administrator/language/en-GB/en-GB.com_fields.ini

@@ -22,6 +22,8 @@ COM_FIELDS_FIELD_DISPLAY_LABEL="Automatic Display"
 COM_FIELDS_FIELD_DISPLAY_NO_DISPLAY="Do not automatically display"
 COM_FIELDS_FIELD_GROUP_DESC="The group this field belongs to."
 COM_FIELDS_FIELD_GROUP_LABEL="Field Group"
+COM_FIELDS_FIELD_LAYOUT_DESC="Choose an alternate layout to be used with automatic display"


It is a sentence please add a . at the end

Sure thing!

Bakual · 2017-11-14T20:40:05Z

One thing I noted is that when you choose an override from a template which isn't active, the field will not show. JLayouts only work from the active template.

laoneo · 2017-11-14T21:16:19Z

administrator/manifests/packages/pkg_weblinks.xml

@@ -1,30 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>


Is this removal made on purpose in this pr?

Oops, no. That one sneaked it.

AndySDH · 2017-11-15T10:18:24Z

Hey there,
great job with doing this!

I'm testing it and it does work correctly :) There are a couple of issues to address though:

I noticed that you've put a "check" that hides the select input if Automatic Display is set to "No". However, you shouldn't do this, because this layout selection should (and indeed does) come into place also when you insert a field as part of a Field Group in the content with the content plugin, as described in [com_fields] Assign a "Default Render Layout" to Custom Fields #18162. So the select input field is always valid and doesn't need to be hidden away if Automatic Display is set to "No".
I had my layouts in templates/your_template/html/layouts/field (which worked fine for the Content Plugin) and they were not showing up here in the select, so I think this folder is missing from the list. Yes, I know, yet another folder to add... didn't realize there were so many. Not sure why both this and templates/your_template/html/layouts/com_fields/field are used...
Another thing, the "render" layout should probably not show up in the select list, as that equals to "Use Default". Unless by "Use Default" you mean the very default from the core which is not overriden? Because if you include an overridden render.php, then it should not be in the list. Maybe you could change the default option to "Use Default (render)"?

Also, a question, why is it that a filename cannot have an underscore? So far I've been using underscores for the filenames of my layouts manually used with the Content Plugin and they've been working normally. Not a big deal, just wondering.

Great job again!

ghost · 2017-11-15T11:07:11Z

@AndySDH please mark your Test as successfully:

open Issue Tracker
Login with your github-Account
Click on blue "Test this"-Button above Authors-Picture
mark your Test as successfully
hit "submit test result"

AndySDH · 2017-11-15T11:09:13Z

@franz-wohlkoenig Sure, thanks for the guidelines! I'll be waiting for @Bakual about the fixes above and then will do that :)

Bakual · 2017-11-15T11:19:18Z

because this layout selection should (and does come) into place also when you insert a field as part of a Field Group in the content with the content plugin

Ah true, didn't think of that. My though was to prevent misunderstanding when someones wants to insert a single field manually. I think then the layout doesn't apply (but haven't tested) and that could be confusing.

templates/your_template/html/layouts/field

That is then a lookup folder from JLayouts overriding mechanism itself. Looks indeed like I have to add that one as well. The com_fields one is because that is where the default layout actually is stored.

Another thing, the "render" layout should probably not show up in the select list

Yes, it should not. The "Use Default" should cover that. That was my plan. Do you have an override for that in your template (I think I didn't test that case)? Or why did it show up?

Also, a question, why is it that a filename cannot have an underscore?

Not really a technical reason. I based the formfield on the component layout one. In view layouts, we use underscore in layout files which should not appear in the select list. That allows to have "children" layouts. If you for example look at the article view, you see the default.php and a default_link.php file. The latter is a child layout of the former and doesn't appear in the article layout list.
I thought it makes sense to keep that naming convention to allow "hiding" certain layout files.

AndySDH · 2017-11-15T11:40:23Z

Ah true, didn't think of that. My though was to prevent misunderstanding when someones wants to insert a single field manually. I think then the layout doesn't apply (but haven't tested) and that could be confusing.

You have a point. Yeah, the layout indeed does not apply when you insert a single field manually. Maybe for clarity we could rename the option to "Automatic Layout", and in the option description, change it to "Choose an alternate layout to be used with Automatic Display or as part of a Field Group."

Unless... we want to actually make it work also for when inserting a single field manually? (if that is even possible). This way, the option could act as "Default/Base Layout", which is always used for that field unless otherwise overridden in the single field via content plugin.

That is then a lookup folder from JLayouts overriding mechanism itself. Looks indeed like I have to add that one as well. The com_fields one is because that is where the default layout actually is stored.

Yeah, figured so... One more folder to add, damn! Haha.

Yes, it should not. The "Use Default" should cover that. That was my plan. Do you have an override for that in your template (I think I didn't test that case)? Or why did it show up?

Yeah, I have an override for render.php now in templates/your_template/html/layouts/com_fields/field and it's showing up in the list, it looks like.

In view layouts, we use underscore in layout files which should not appear in the select list. I thought it makes sense to keep that naming convention to allow "hiding" certain layout files.

Gotcha, that makes sense to me too. Good idea/decision 👍

Bakual · 2017-11-15T13:36:38Z

Yeah, the layout indeed does not apply when you insert a single field manually.

I took another approach. The layout now applies also when you insert a single field 😄
You can still manually choose a different layout when inserting the field manually. You can even use the default one if you use "render" as layout option.

One more folder to add

Done.

Yeah, I have an override for render.php now in templates/your_template/html/layouts/com_fields/field and it's showing up in the list, it looks like.

Took care of them as well now.

AndySDH · 2017-11-15T13:40:31Z

@Bakual Fantastic! Saw all your latest commits, perfect stuff. Everything looks thorughly taken care of. I will test this all once again with the latest changes and officially mark as successful.

AndySDH · 2017-11-15T13:51:25Z

I have tested this item ✅ successfully on 2d7e71e

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/18571.}

AndySDH · 2017-11-23T15:18:18Z

Can others test this? :)

Quy · 2017-11-23T16:13:45Z

administrator/components/com_fields/models/fields/fieldlayout.php

+
+			return implode($html);
+		}
+		else


Remove the else clause and just have return '';

That's what I get by copy-pasting from JFormFieldComponentlayout 😄

Quy · 2017-11-23T17:16:06Z

I have tested this item ✅ successfully on ea054e2

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/18571.}

ghost · 2017-11-23T17:25:37Z

@AndySDH can you please retest?

ghost · 2017-11-23T17:42:11Z

Ready to Commit after two successful tests.

laoneo · 2017-11-23T17:52:36Z

Sorry for being late to the party, but com_contact needs to be adjusted too https://github.com/joomla/joomla-cms/blob/staging/components/com_contact/layouts/fields/render.php#L70.

Bakual · 2017-11-23T21:59:53Z

Thanks for the reminder @laoneo !

AndySDH · 2017-11-23T22:04:31Z

I have tested this item ✅ successfully on 8ba9ff9

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/18571.}

Quy · 2017-11-24T16:55:59Z

I have tested this item ✅ successfully on 8ba9ff9

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/18571.}

…older

Bakual · 2018-05-05T06:42:40Z

@zero-24 Rebased and fixed the conflicts

AndySDH · 2018-10-19T15:25:43Z

By the way, @laoneo, your comments from: #20243

I would rather see a new function in core to define a default layout for the > field and provide different layouts for the same field type. For the list it would mean to add a new file > here like /plugins/fields/list/tmpl/list_ul.php and then provide these layouts as option in the field.
What do you guys think?

For the people who are requesting a layout chooser per field, It got merged today by #18571.

This PR actually wasn't specifically about what you mentioned over there. This PR here added the ability to add and choose a Custom Layout at a FIELD level (so before even knowing what field type it's going to render). (override for: "components/com_fields/layouts/fields/render.php")

What you were proposing is to add and choose an even deeper Custom Layout at a VALUE level for specific field types, where you would be able to specify a layout for individual values for fields that have multiple values (such as list, checkboxes, repeatable) (override for "plugins/fields/list/tmpl/list.php"). Which is not possible right now and was not included in this PR, just so you know.

Bakual · 2018-11-22T07:26:50Z

@AndySDH Please don't post on closed/merged PRs. Nobody is going to read and answer that.
Open a new issue instead.

…8571)

joomla-cms-bot added Language Change This is for Translators PR-staging labels Nov 14, 2017

Bakual mentioned this pull request Nov 14, 2017

[com_fields] Assign a "Default Render Layout" to Custom Fields #18162

Closed

brianteeman reviewed Nov 14, 2017

View reviewed changes

Bakual added the Feature label Nov 14, 2017

laoneo reviewed Nov 14, 2017

View reviewed changes

AndySDH approved these changes Nov 15, 2017

View reviewed changes

Quy reviewed Nov 23, 2017

View reviewed changes

joomla-cms-bot added the RTC This Pull Request is Ready To Commit label Nov 23, 2017

mbabker added this to the Joomla 3.9.0 milestone Nov 24, 2017

Bakual mentioned this pull request Nov 26, 2017

Add list and table fieldgroup layout overrides to com_content #18367

Closed

Thomas Hunziker added 7 commits May 5, 2018 08:37

Add missing dot.

e7740d5

Restore the pkg_weblinks.xml

20a2d89

Remove "render" layout from list and include the html/layouts/field f…

15ea096

…older

Layout will now be used also when included by the plugin

05e072d

Adjust language string

47aeaee

Simplify if-else to if.

065670c

Take care of com_contact.

9fa014e

Bakual force-pushed the AlternateLayoutField branch from 8ba9ff9 to 9fa014e Compare May 5, 2018 06:38

Restore pkg_weblinks.xml again (wrong conflict solving)

00ff66a

Bakual force-pushed the AlternateLayoutField branch from f8ae563 to 00ff66a Compare May 5, 2018 06:42

brianteeman modified the milestones: Joomla 3.9.0, Joomla 3.10.0 May 8, 2018

mbabker modified the milestones: Joomla 3.10.0, Joomla 3.9.0 Jun 2, 2018

mbabker changed the base branch from staging to 3.9-dev June 2, 2018 15:38

mbabker added PR-3.9-dev and removed PR-staging labels Jun 2, 2018

mbabker merged commit 1fa4f9c into joomla:3.9-dev Jun 2, 2018

joomla-cms-bot removed the RTC This Pull Request is Ready To Commit label Jun 2, 2018

laoneo mentioned this pull request Jun 2, 2018

[FEATURE] A Repeatable Custom Field #20243

Closed

Bakual deleted the AlternateLayoutField branch June 2, 2018 21:30

zero-24 mentioned this pull request Jun 3, 2018

[3.9] Adding an alternate layout parameter to custom fields joomlagerman/joomla#430

Closed

AndySDH mentioned this pull request Nov 22, 2018

[com_fields] Ability to create and assign alternate layout to custom fields values #23138

Closed

webgras mentioned this pull request Nov 30, 2018

[com_fields] custom field layout overrides not implemented for com_users #23212

Open

piotr-cz added a commit to piotr-cz/Master3 that referenced this pull request Jul 24, 2021

Respect alternative layout for field (Joomla 3.9, joomla/joomla-cms#1…

b3398e2

…8571)

piotr-cz mentioned this pull request Jul 24, 2021

Respect alternative layout for custom field master3-blank-template/Master3#13

Merged

AlekVolsk pushed a commit to master3-blank-template/Master3 that referenced this pull request Aug 9, 2021

Respect alternative layout for field (Joomla 3.9, joomla/joomla-cms#1…

6ece471

…8571)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding an alternate layout parameter to custom fields #18571

Adding an alternate layout parameter to custom fields #18571

Bakual commented Nov 14, 2017 •

edited by joomla-cms-bot

brianteeman Nov 14, 2017

Bakual Nov 14, 2017

Bakual commented Nov 14, 2017

laoneo Nov 14, 2017

Bakual Nov 14, 2017

AndySDH commented Nov 15, 2017 •

edited

ghost commented Nov 15, 2017

AndySDH commented Nov 15, 2017 •

edited

Bakual commented Nov 15, 2017

AndySDH commented Nov 15, 2017 •

edited

Bakual commented Nov 15, 2017

AndySDH commented Nov 15, 2017 •

edited

AndySDH commented Nov 15, 2017

AndySDH commented Nov 23, 2017

Quy Nov 23, 2017 •

edited

Bakual Nov 23, 2017

Quy commented Nov 23, 2017

ghost commented Nov 23, 2017

ghost commented Nov 23, 2017

laoneo commented Nov 23, 2017

Bakual commented Nov 23, 2017

AndySDH commented Nov 23, 2017

Quy commented Nov 24, 2017

Bakual commented May 5, 2018

AndySDH commented Oct 19, 2018 •

edited

Bakual commented Nov 22, 2018

Adding an alternate layout parameter to custom fields #18571

Adding an alternate layout parameter to custom fields #18571

Conversation

Bakual commented Nov 14, 2017 • edited by joomla-cms-bot

Summary of Changes

Testing Instructions

Expected result

Actual result

Documentation Changes Required

brianteeman Nov 14, 2017

Choose a reason for hiding this comment

Bakual Nov 14, 2017

Choose a reason for hiding this comment

Bakual commented Nov 14, 2017

laoneo Nov 14, 2017

Choose a reason for hiding this comment

Bakual Nov 14, 2017

Choose a reason for hiding this comment

AndySDH commented Nov 15, 2017 • edited

ghost commented Nov 15, 2017

AndySDH commented Nov 15, 2017 • edited

Bakual commented Nov 15, 2017

AndySDH commented Nov 15, 2017 • edited

Bakual commented Nov 15, 2017

AndySDH commented Nov 15, 2017 • edited

AndySDH commented Nov 15, 2017

AndySDH commented Nov 23, 2017

Quy Nov 23, 2017 • edited

Choose a reason for hiding this comment

Bakual Nov 23, 2017

Choose a reason for hiding this comment

Quy commented Nov 23, 2017

ghost commented Nov 23, 2017

ghost commented Nov 23, 2017

laoneo commented Nov 23, 2017

Bakual commented Nov 23, 2017

AndySDH commented Nov 23, 2017

Quy commented Nov 24, 2017

Bakual commented May 5, 2018

AndySDH commented Oct 19, 2018 • edited

Bakual commented Nov 22, 2018

Bakual commented Nov 14, 2017 •

edited by joomla-cms-bot

AndySDH commented Nov 15, 2017 •

edited

AndySDH commented Nov 15, 2017 •

edited

AndySDH commented Nov 15, 2017 •

edited

AndySDH commented Nov 15, 2017 •

edited

Quy Nov 23, 2017 •

edited

AndySDH commented Oct 19, 2018 •

edited