Joomla! Issue Tracker - CMS

Download
Launch
Feeling Lucky

[#9797] - Improve modules scaffolding for custom fields

? Success

User tests: Successful: Unsuccessful:

avatar dgt41
dgt41
7 Apr 2016

This is a redo of #4294

Summary of Changes

Right now if you want to include some custom fields in your module you need to include a custom field path in the relative xml file, something like:

<fieldset addfieldpath="/modules/<module name>/field">

Documented here: https://docs.joomla.org/Creating_a_custom_form_field_type

This PR leverages this, so custom fields will happily reside inside a folder named field

Why field and not fields?
Singular word help us transition to autoload and namespace

Testing Instructions

Apply this patch with patch tester
edit modules/mod_custom/mod_custom.xml and paste after line 27

                <field name="testone" class="" type="testone" default="0"
                       label="test one"
                       description="test one" />

Create a folder named field inside modules/mod_custom/
copy testone.php to the folder you just created from https://gist.github.com/dgt41/ec0e2afe879c5d07ffadd2c8a639e1a7

Add a new Custom module and check the options tab:
screen shot 2016-04-08 at 00 16 57

If you see a dropdown you have success

B/C

No backwards compatibility break

Performance

We just add one more folder check to the whole stack, so performance degradation should be unnoticeable. (Joomla itself does that hundreds of times for core libraries)

d8ecbc6 7 Apr 2016 avatar dgt41 init
avatar dgt41 dgt41 - open - 7 Apr 2016
avatar dgt41 dgt41 - change - 7 Apr 2016
Status New ⇒ Pending
avatar joomla-cms-bot joomla-cms-bot - change - 7 Apr 2016
Labels Added: ?
avatar brianteeman brianteeman - change - 7 Apr 2016
Category ⇒ Fields Modules
avatar dgt41 dgt41 - change - 7 Apr 2016
The description was changed
avatar brianteeman brianteeman - test_item - 7 Apr 2016 - Tested successfully
avatar brianteeman
brianteeman - comment - 7 Apr 2016

I have tested this item :white_check_mark: successfully on d8ecbc6

This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/9797.

avatar MATsxm MATsxm - test_item - 7 Apr 2016 - Tested successfully
avatar MATsxm
MATsxm - comment - 7 Apr 2016

I have tested this item :white_check_mark: successfully on d8ecbc6

Thanks

This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/9797.

avatar brianteeman brianteeman - change - 8 Apr 2016
Status Pending ⇒ Ready to Commit
avatar brianteeman
brianteeman - comment - 8 Apr 2016

RTC - leaving it to the maintainers to decide the milestone

This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/9797.

avatar joomla-cms-bot joomla-cms-bot - change - 8 Apr 2016
Labels Added: ?
avatar wilsonge wilsonge - change - 8 Apr 2016
Milestone Added:
avatar wilsonge wilsonge - close - 9 Apr 2016
avatar wilsonge
wilsonge - comment - 9 Apr 2016

Merged into 3.6.x with ed80108 - thanks @dgt41

avatar wilsonge wilsonge - change - 9 Apr 2016
Status Ready to Commit ⇒ Closed
Closed_Date 0000-00-00 00:00:00 ⇒ 2016-04-09 13:55:55
Closed_By ⇒ wilsonge
avatar wilsonge wilsonge - close - 9 Apr 2016
avatar joomla-cms-bot joomla-cms-bot - close - 9 Apr 2016
avatar joomla-cms-bot joomla-cms-bot - change - 9 Apr 2016
Labels Removed: ?
avatar chrisdavenport
chrisdavenport - comment - 9 Apr 2016

Please update the documentation. Thanks.

avatar dgt41
dgt41 - comment - 9 Apr 2016

I will!

Add a Comment

Login with GitHub to post a comment