Commit Graph

22 Commits

Author SHA1 Message Date
Nestor Soriano 5a11d9e064
Refactor the settings pages, and add unit tests for them.
This commit fixes some inconsistencies in the settings pages, and
makes all the existing pages extensible by adding new sections
(that was possible in some pages, but not in others). Main changes:

1. Modify the 'get_sections' method so that it invokes a new protected
   'get_own_sections' method and then triggers the
   'woocommerce_get_sections_' . id filter.

This way the filter is triggered only in the base class
and not in each of the derived classes too.

2. Change the get_settings() method so that it has its signature
   changed to get_settings( $current_section = '' )
   in the base class and in all the derived class.

Some derived classes were already using this signature, but others
(those not having multiple sections natively) weren't, making then
effectively impossible to define multiple sections for these pages
via filters.

With this change all the section pages act consistently and allow
both adding new settings to the default "General" section
and creating new sections via filters.

3. Change the implementation of 'get_settings' in the base class
   so that it searches for a 'get_settings_for_{section_id}_section'
   method in the class and executes it, otherwise it executes the new
   protected method get_settings_for_section( $current_section ); then
   it triggers the 'woocommerce_get_settings_' . id filter.

This makes it easier to separate the code that returns the list
of filters in multiple methods, one per section, instead of using
one big if-else-else... block.

So now instead of overriding get_settings($current_section='') derived
classes need to implement get_settings_for_{$current_section}_section
for each section, or override get_settings_for_section($current_section)
or both. 'get_settings_for_section' returns an empty array by default.

Also, 'woocommerce_get_settings_' . id is triggered in one single
place too.

Other improvements:

* Remove duplicated code from 'output' in 'WC_Settings_Page' children.

Some classes inherited from 'WC_Settings_Page' override the 'output'
method with custom code, which in all cases ended up repeating the code
of the original method as a fallback. These repetitions have been
replaced with 'parent::output()'.

* Fix inconsistencies for 'save' and 'output' in WC_Settings_Tax/Emails

The 'WC_Settings_Tax' and 'WC_Settings_Emails' classes had some
inconsistencies in their 'save' and 'output' methods that prevented the
proper creation new sections and the addition of new settings via the
'woocommerce_get_sections_' and 'woocommerce_get_settings_' filters.
Now they work as expected.

* Deduplicate parts of 'save' in 'WC_Settings_Page' and children.

Two methods have been added to 'WC_Settings_Page' class:
'save_settings_for_current_section' and 'do_update_options_action'.
These are intended to be invoked by derived classes in their 'save'
methods, in order to remove code repetition.

* Add some helper methods to WC_Unit_Test_Case.

Methods added:
- assertOutputsHTML
- assertEqualsHTML
- normalize_html
- capture_output_from
2021-04-12 12:42:26 +02:00
Nestor Soriano 1b351a6685 Sanitize tax class and display errors in admin while creating tax classes 2021-03-30 11:08:35 +02:00
Claudio Sanches d48f1d4e2e Fixed package tag usage 2020-08-05 13:36:24 -03:00
Rodrigo Primo 23b69eba53 Use phpcbf to fix coding standard violations in includes/admin
After using phpcbf to fix the coding standard violations, I did some manual adjustments to the changes, especially in poorly indented files.
2018-03-05 16:21:35 -03:00
Rasmus Bengtsson 185934fad9 Fix phpdoc to include params and correct types 2017-05-15 13:50:52 +02:00
Claudio Sanches 59c2849736 Changed version 2.7 to 3.0 2017-03-15 13:36:53 -03:00
Mike Jolley bbf8e750ce Tidy up includes 2017-02-16 11:46:01 +00:00
Justin Shreve 3de423b5c2 Wrap up settings api 2016-07-26 10:24:15 -07:00
Fredrik Forsmo 72f062b452 Improve docblock comments in WC_Settings_* classes
* Added comments to properties that don’t have any.
2016-01-05 16:22:18 +01:00
Mike Jolley 1b38f380af Merge remote-tracking branch 'origin/master'
Conflicts:
	includes/emails/class-wc-email.php
2015-11-03 16:09:01 +00:00
Claudio Sanches 5893875b0c Removed period for file headers 2015-11-03 11:53:50 -02:00
Claudio Sanches ee30b5b308 Fixed php docs standards 2015-11-03 11:31:20 -02:00
Mike Jolley 5f65494e27 Restructure emails admin to avoid listing emails along the top
Moves emails to a table on the settings screen.

Also tweaks some section text and moves descriptions to tooltips for a
less cluttered interface.
2015-11-02 16:27:00 +00:00
Mike Jolley ce1a9b84c7 Redo construct and move settings/html to separate files 2014-11-20 15:03:45 +00:00
shivapoudel ab52b93592 Absolute path and Indentation fix for includes/admin/settings/*.php :) 2014-09-21 01:40:47 +05:45
Mike Jolley aee2b62c85 Added woocommerce_get_settings_ID filters.
Closes #6231
2014-09-12 12:20:06 +01:00
Tamara Zuk a0ce139f7d Coding Standards: Admin - Settings
* fixed indentation - swapped spaces for tabs at start of line, swapped
tabs for spaces min-line for alignment
* removed instances of `@return void` and `@access public`
* improved readability

@see http://make.wordpress.org/core/handbook/coding-standards/php/
2014-08-31 04:22:03 -04:00
Mike Jolley f9251084d9 woocommerce_get_sections_{id} filters Closes #4817 2014-02-17 14:30:42 +00:00
Mike Jolley 05d9c0e045 Rename menus, removed woocommerce_ 2013-10-22 17:26:18 +01:00
Coen Jacobs 930cd6125f Make sure end( gets a variable to work around strict notices 2013-08-07 14:15:53 +00:00
Mike Jolley 7ad7f31e3b Remove last pipe 2013-08-05 16:34:54 +01:00
Mike Jolley 9462dde581 Settings refactoring 2013-07-26 15:36:28 +01:00