woothemes /
sensei
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Sensei_Settings_API often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Sensei_Settings_API, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 15 | class Sensei_Settings_API { |
||
| 16 | public $token; |
||
| 17 | public $page_slug; |
||
| 18 | public $name; |
||
| 19 | public $menu_label; |
||
| 20 | public $settings; |
||
| 21 | public $sections; |
||
| 22 | public $fields; |
||
| 23 | public $errors; |
||
| 24 | |||
| 25 | public $has_range; |
||
| 26 | public $has_imageselector; |
||
| 27 | public $has_tabs; |
||
| 28 | private $tabs; |
||
| 29 | public $settings_version; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * Constructor. |
||
| 33 | * @access public |
||
| 34 | * @since 1.0.0 |
||
| 35 | * @return void |
||
|
|
|||
| 36 | */ |
||
| 37 | public function __construct () { |
||
| 53 | |||
| 54 | /** |
||
| 55 | * Setup the settings screen and necessary functions. |
||
| 56 | * @access public |
||
| 57 | * @since 1.0.0 |
||
| 58 | * @return void |
||
| 59 | */ |
||
| 60 | public function register_hook_listener() { |
||
| 67 | |||
| 68 | /** |
||
| 69 | * Initialise settings sections, settings fields and create tabs, if applicable. |
||
| 70 | * @access public |
||
| 71 | * @since 1.0.3 |
||
| 72 | * @return void |
||
| 73 | */ |
||
| 74 | public function general_init() { |
||
| 82 | |||
| 83 | /** |
||
| 84 | * Register the settings sections. |
||
| 85 | * @access public |
||
| 86 | * @since 1.0.0 |
||
| 87 | * @return void |
||
| 88 | */ |
||
| 89 | public function init_sections () { |
||
| 93 | |||
| 94 | /** |
||
| 95 | * Register the settings fields. |
||
| 96 | * @access public |
||
| 97 | * @since 1.0.0 |
||
| 98 | * @return void |
||
| 99 | */ |
||
| 100 | public function init_fields () { |
||
| 104 | |||
| 105 | /** |
||
| 106 | * Construct and output HTML markup for the settings tabs. |
||
| 107 | * @access public |
||
| 108 | * @since 1.1.0 |
||
| 109 | * @return void |
||
| 110 | */ |
||
| 111 | public function settings_tabs () { |
||
| 142 | |||
| 143 | /** |
||
| 144 | * Create settings tabs based on the settings sections. |
||
| 145 | * @access private |
||
| 146 | * @since 1.1.0 |
||
| 147 | * @return void |
||
| 148 | */ |
||
| 149 | private function create_tabs () { |
||
| 159 | |||
| 160 | /** |
||
| 161 | * Create settings sections. |
||
| 162 | * @access public |
||
| 163 | * @since 1.0.0 |
||
| 164 | * @return void |
||
| 165 | */ |
||
| 166 | public function create_sections () { |
||
| 173 | |||
| 174 | /** |
||
| 175 | * Create settings fields. |
||
| 176 | * @access public |
||
| 177 | * @since 1.0.0 |
||
| 178 | * @return void |
||
| 179 | */ |
||
| 180 | public function create_fields () { |
||
| 195 | |||
| 196 | /** |
||
| 197 | * Determine the method to use for outputting a field, validating a field or checking a field. |
||
| 198 | * @access protected |
||
| 199 | * @since 1.0.0 |
||
| 200 | * @param array $data |
||
| 201 | * @return callable, array or string |
||
| 202 | */ |
||
| 203 | protected function determine_method ( $data, $type = 'form' ) { |
||
| 245 | |||
| 246 | /** |
||
| 247 | * Parse the fields into an array index on the sections property. |
||
| 248 | * @access public |
||
| 249 | * @since 1.0.0 |
||
| 250 | * @param array $fields |
||
| 251 | * @return void |
||
| 252 | */ |
||
| 253 | public function parse_fields ( $fields ) { |
||
| 266 | |||
| 267 | /** |
||
| 268 | * Register the settings screen within the WordPress admin. |
||
| 269 | * @access public |
||
| 270 | * @since 1.0.0 |
||
| 271 | * @return void |
||
| 272 | */ |
||
| 273 | public function register_settings_screen () { |
||
| 288 | |||
| 289 | /** |
||
| 290 | * The markup for the settings screen. |
||
| 291 | * @access public |
||
| 292 | * @since 1.0.0 |
||
| 293 | * @return void |
||
| 294 | */ |
||
| 295 | public function settings_screen () { |
||
| 313 | |||
| 314 | /** |
||
| 315 | * Retrieve the settings from the database. |
||
| 316 | * @access public |
||
| 317 | * @since 1.0.0 |
||
| 318 | * @return array |
||
| 319 | */ |
||
| 320 | public function get_settings () { |
||
| 336 | |||
| 337 | /** |
||
| 338 | * Register the settings fields. |
||
| 339 | * @access public |
||
| 340 | * @since 1.0.0 |
||
| 341 | * @return void |
||
| 342 | */ |
||
| 343 | public function settings_fields () { |
||
| 348 | |||
| 349 | /** |
||
| 350 | * Display settings errors. |
||
| 351 | * @access public |
||
| 352 | * @since 1.0.0 |
||
| 353 | * @return void |
||
| 354 | */ |
||
| 355 | public function settings_errors () { |
||
| 358 | |||
| 359 | /** |
||
| 360 | * Display the description for a settings section. |
||
| 361 | * @access public |
||
| 362 | * @since 1.0.0 |
||
| 363 | * @return void |
||
| 364 | */ |
||
| 365 | public function section_description ( $section ) { |
||
| 370 | |||
| 371 | /** |
||
| 372 | * Generate text input field. |
||
| 373 | * @access public |
||
| 374 | * @since 1.0.0 |
||
| 375 | * @param array $args |
||
| 376 | * @return void |
||
| 377 | */ |
||
| 378 | View Code Duplication | public function form_field_text ( $args ) { |
|
| 386 | |||
| 387 | /** |
||
| 388 | * Generate color picker field. |
||
| 389 | * @access public |
||
| 390 | * @since 1.6.0 |
||
| 391 | * @param array $args |
||
| 392 | * @return void |
||
| 393 | */ |
||
| 394 | View Code Duplication | public function form_field_color ( $args ) { |
|
| 403 | |||
| 404 | /** |
||
| 405 | * Generate checkbox field. |
||
| 406 | * @access public |
||
| 407 | * @since 1.0.0 |
||
| 408 | * @param array $args |
||
| 409 | * @return void |
||
| 410 | */ |
||
| 411 | public function form_field_checkbox ( $args ) { |
||
| 429 | |||
| 430 | /** |
||
| 431 | * Generate textarea field. |
||
| 432 | * @access public |
||
| 433 | * @since 1.0.0 |
||
| 434 | * @param array $args |
||
| 435 | * @return void |
||
| 436 | */ |
||
| 437 | View Code Duplication | public function form_field_textarea ( $args ) { |
|
| 445 | |||
| 446 | /** |
||
| 447 | * Generate select box field. |
||
| 448 | * @access public |
||
| 449 | * @since 1.0.0 |
||
| 450 | * @param array $args |
||
| 451 | * @return void |
||
| 452 | */ |
||
| 453 | View Code Duplication | public function form_field_select ( $args ) { |
|
| 470 | |||
| 471 | /** |
||
| 472 | * Generate radio button field. |
||
| 473 | * @access public |
||
| 474 | * @since 1.0.0 |
||
| 475 | * @param array $args |
||
| 476 | * @return void |
||
| 477 | */ |
||
| 478 | View Code Duplication | public function form_field_radio ( $args ) { |
|
| 493 | |||
| 494 | /** |
||
| 495 | * Generate multicheck field. |
||
| 496 | * @access public |
||
| 497 | * @since 1.0.0 |
||
| 498 | * @param array $args |
||
| 499 | * @return void |
||
| 500 | */ |
||
| 501 | public function form_field_multicheck ( $args ) { |
||
| 526 | |||
| 527 | /** |
||
| 528 | * Generate range field. |
||
| 529 | * @access public |
||
| 530 | * @since 1.0.0 |
||
| 531 | * @param array $args |
||
| 532 | * @return void |
||
| 533 | */ |
||
| 534 | View Code Duplication | public function form_field_range ( $args ) { |
|
| 551 | |||
| 552 | /** |
||
| 553 | * Generate image-based selector form field. |
||
| 554 | * @access public |
||
| 555 | * @since 1.0.0 |
||
| 556 | * @param array $args |
||
| 557 | * @return void |
||
| 558 | */ |
||
| 559 | View Code Duplication | public function form_field_images ( $args ) { |
|
| 574 | |||
| 575 | /** |
||
| 576 | * Generate information box field. |
||
| 577 | * @access public |
||
| 578 | * @since 1.0.0 |
||
| 579 | * @param array $args |
||
| 580 | * @return void |
||
| 581 | */ |
||
| 582 | public function form_field_info ( $args ) { |
||
| 598 | |||
| 599 | |||
| 600 | /** |
||
| 601 | * Generate button field. |
||
| 602 | * @access public |
||
| 603 | * @since 1.9.0 |
||
| 604 | * @param array $args |
||
| 605 | */ |
||
| 606 | public function form_field_button( $args ) { |
||
| 617 | |||
| 618 | |||
| 619 | /** |
||
| 620 | * Validate registered settings fields. |
||
| 621 | * @access public |
||
| 622 | * @since 1.0.0 |
||
| 623 | * @param array $input |
||
| 624 | * @uses $this->parse_errors() |
||
| 625 | * @return array $options |
||
| 626 | */ |
||
| 627 | public function validate_fields ( $input ) { |
||
| 683 | |||
| 684 | /** |
||
| 685 | * Validate text fields. |
||
| 686 | * @access public |
||
| 687 | * @since 1.0.0 |
||
| 688 | * @param string $input |
||
| 689 | * @return string |
||
| 690 | */ |
||
| 691 | public function validate_field_text ( $input ) { |
||
| 694 | |||
| 695 | /** |
||
| 696 | * Validate checkbox fields. |
||
| 697 | * @access public |
||
| 698 | * @since 1.0.0 |
||
| 699 | * @param string $input |
||
| 700 | * @return string |
||
| 701 | */ |
||
| 702 | public function validate_field_checkbox ( $input ) { |
||
| 709 | |||
| 710 | /** |
||
| 711 | * Validate multicheck fields. |
||
| 712 | * @access public |
||
| 713 | * @since 1.0.0 |
||
| 714 | * @param string $input |
||
| 715 | * @return string |
||
| 716 | */ |
||
| 717 | public function validate_field_multicheck ( $input ) { |
||
| 724 | |||
| 725 | /** |
||
| 726 | * Validate range fields. |
||
| 727 | * @access public |
||
| 728 | * @since 1.0.0 |
||
| 729 | * @param string $input |
||
| 730 | * @return string |
||
| 731 | */ |
||
| 732 | public function validate_field_range ( $input ) { |
||
| 737 | |||
| 738 | /** |
||
| 739 | * Validate URL fields. |
||
| 740 | * @access public |
||
| 741 | * @since 1.0.0 |
||
| 742 | * @param string $input |
||
| 743 | * @return string |
||
| 744 | */ |
||
| 745 | public function validate_field_url ( $input ) { |
||
| 748 | |||
| 749 | /** |
||
| 750 | * Check and validate the input from text fields. |
||
| 751 | * @param string $input String of the value to be validated. |
||
| 752 | * @since 1.1.0 |
||
| 753 | * @return boolean Is the value valid? |
||
| 754 | */ |
||
| 755 | public function check_field_text ( $input ) { |
||
| 760 | |||
| 761 | /** |
||
| 762 | * Log an error internally, for processing later using $this->parse_errors(). |
||
| 763 | * @access protected |
||
| 764 | * @since 1.0.0 |
||
| 765 | * @param string $key |
||
| 766 | * @param array $data |
||
| 767 | * @return void |
||
| 768 | */ |
||
| 769 | protected function add_error ( $key, $data ) { |
||
| 777 | |||
| 778 | /** |
||
| 779 | * Parse logged errors. |
||
| 780 | * @access protected |
||
| 781 | * @since 1.0.0 |
||
| 782 | * @return void |
||
| 783 | */ |
||
| 784 | protected function parse_errors () { |
||
| 794 | |||
| 795 | /** |
||
| 796 | * Return an array of field types expecting an array value returned. |
||
| 797 | * @access protected |
||
| 798 | * @since 1.0.0 |
||
| 799 | * @return void |
||
| 800 | */ |
||
| 801 | protected function get_array_field_types () { |
||
| 804 | |||
| 805 | /** |
||
| 806 | * Load in JavaScripts where necessary. |
||
| 807 | * @access public |
||
| 808 | * @since 1.0.0 |
||
| 809 | * @return void |
||
| 810 | */ |
||
| 811 | public function enqueue_scripts () { |
||
| 830 | |||
| 831 | /** |
||
| 832 | * Load in CSS styles where necessary. |
||
| 833 | * @access public |
||
| 834 | * @since 1.0.0 |
||
| 835 | * @return void |
||
| 836 | */ |
||
| 837 | public function enqueue_styles () { |
||
| 846 | |||
| 847 | /** |
||
| 848 | * Load in CSS styles for field types where necessary. |
||
| 849 | * @access public |
||
| 850 | * @since 1.0.0 |
||
| 851 | * @return void |
||
| 852 | */ |
||
| 853 | public function enqueue_field_styles () { |
||
| 866 | } // End Class |
||
| 867 | |||
| 874 |
Loading history...
Adding a
@returnannotation to a constructor is not recommended, since a constructor does not have a meaningful return value.Please refer to the PHP core documentation on constructors.