Complex classes like GravityView_View 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 GravityView_View, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
23 | class GravityView_View extends \GV\Gamajo_Template_Loader { |
||
24 | |||
25 | /** |
||
26 | * Prefix for filter names. |
||
27 | * @var string |
||
28 | */ |
||
29 | protected $filter_prefix = 'gravityview'; |
||
30 | |||
31 | /** |
||
32 | * Directory name where custom templates for this plugin should be found in the theme. |
||
33 | * @var string |
||
34 | */ |
||
35 | protected $theme_template_directory = 'gravityview'; |
||
36 | |||
37 | /** |
||
38 | * Reference to the root directory path of this plugin. |
||
39 | * @var string |
||
40 | */ |
||
41 | protected $plugin_directory = GRAVITYVIEW_DIR; |
||
42 | |||
43 | /** |
||
44 | * Store templates locations that have already been located |
||
45 | * @var array |
||
46 | */ |
||
47 | protected $located_templates = array(); |
||
48 | |||
49 | /** |
||
50 | * The name of the template, like "list", "table", or "datatables" |
||
51 | * @var string |
||
52 | */ |
||
53 | protected $template_part_slug = ''; |
||
54 | |||
55 | /** |
||
56 | * The name of the file part, like "body" or "single" |
||
57 | * @var string |
||
58 | */ |
||
59 | protected $template_part_name = ''; |
||
60 | |||
61 | /** |
||
62 | * @var int Gravity Forms form ID |
||
63 | */ |
||
64 | protected $form_id = NULL; |
||
65 | |||
66 | /** |
||
67 | * @var int View ID |
||
68 | * @todo: this needs to be public until extensions support 1.7+ |
||
69 | */ |
||
70 | public $view_id = NULL; |
||
71 | |||
72 | /** |
||
73 | * @var array Fields for the form |
||
74 | */ |
||
75 | protected $fields = array(); |
||
76 | |||
77 | /** |
||
78 | * @var string Current screen. Defaults to "directory" or "single" |
||
79 | */ |
||
80 | protected $context = 'directory'; |
||
81 | |||
82 | /** |
||
83 | * @var int|null If in embedded post or page, the ID of it |
||
84 | */ |
||
85 | protected $post_id = NULL; |
||
86 | |||
87 | /** |
||
88 | * @var array Gravity Forms form array at ID $form_id |
||
89 | */ |
||
90 | protected $form = NULL; |
||
91 | |||
92 | /** |
||
93 | * @var array Configuration for the View |
||
94 | */ |
||
95 | protected $atts = array(); |
||
96 | |||
97 | /** |
||
98 | * @var array Entries for the current result. Single item in array for single entry View |
||
99 | */ |
||
100 | protected $entries = array(); |
||
101 | |||
102 | /** |
||
103 | * @var int Total entries count for the current result. |
||
104 | */ |
||
105 | protected $total_entries = 0; |
||
106 | |||
107 | /** |
||
108 | * @var string The label to display back links |
||
109 | */ |
||
110 | protected $back_link_label = ''; |
||
111 | |||
112 | /** |
||
113 | * @var array Array with `offset` and `page_size` keys |
||
114 | */ |
||
115 | protected $paging = array(); |
||
116 | |||
117 | /** |
||
118 | * @var array Array with `sort_field` and `sort_direction` keys |
||
119 | */ |
||
120 | protected $sorting = array(); |
||
121 | |||
122 | /** |
||
123 | * @var bool Whether to hide the results until a search is performed |
||
124 | * @since 1.5.4 |
||
125 | */ |
||
126 | protected $hide_until_searched = false; |
||
127 | |||
128 | /** |
||
129 | * Current entry in the loop |
||
130 | * @var array |
||
131 | */ |
||
132 | protected $_current_entry = array(); |
||
133 | |||
134 | /** |
||
135 | * @var array |
||
136 | */ |
||
137 | protected $_current_field = array(); |
||
138 | |||
139 | /** |
||
140 | * @var GravityView_View |
||
141 | */ |
||
142 | static $instance = NULL; |
||
143 | |||
144 | /** |
||
145 | * Construct the view object |
||
146 | * @param array $atts Associative array to set the data of |
||
147 | */ |
||
148 | 111 | function __construct( $atts = array() ) { |
|
183 | |||
184 | /** |
||
185 | * @param null $passed_post |
||
186 | * |
||
187 | * @return GravityView_View |
||
188 | */ |
||
189 | 150 | static function getInstance( $passed_post = NULL ) { |
|
197 | |||
198 | /** |
||
199 | * @param string|null $key The key to a specific attribute of the current field |
||
200 | * @return array|mixed|null If $key is set and attribute exists at $key, return that. If not set, return NULL. Otherwise, return current field array |
||
201 | */ |
||
202 | 101 | public function getCurrentField( $key = NULL ) { |
|
213 | |||
214 | public function setCurrentFieldSetting( $key, $value ) { |
||
221 | |||
222 | public function getCurrentFieldSetting( $key ) { |
||
231 | |||
232 | /** |
||
233 | * @param array $passed_field |
||
234 | */ |
||
235 | 101 | public function setCurrentField( $passed_field ) { |
|
249 | |||
250 | /** |
||
251 | * @param string|null $key The key to a specific field in the fields array |
||
252 | * @return array|mixed|null If $key is set and field exists at $key, return that. If not set, return NULL. Otherwise, return array of fields. |
||
253 | */ |
||
254 | 39 | public function getAtts( $key = NULL ) { |
|
265 | |||
266 | /** |
||
267 | * @param array $atts |
||
268 | */ |
||
269 | 38 | public function setAtts( $atts ) { |
|
272 | |||
273 | /** |
||
274 | * @return array |
||
275 | */ |
||
276 | 123 | public function getForm() { |
|
279 | |||
280 | /** |
||
281 | * @param array $form |
||
282 | */ |
||
283 | 39 | public function setForm( $form ) { |
|
286 | |||
287 | /** |
||
288 | * @return int|null |
||
289 | */ |
||
290 | 40 | public function getPostId() { |
|
293 | |||
294 | /** |
||
295 | * @param int|null $post_id |
||
296 | */ |
||
297 | 38 | public function setPostId( $post_id ) { |
|
300 | |||
301 | /** |
||
302 | * @return string |
||
303 | */ |
||
304 | 101 | public function getContext() { |
|
307 | |||
308 | /** |
||
309 | * @param string $context |
||
310 | */ |
||
311 | 38 | public function setContext( $context ) { |
|
314 | |||
315 | /** |
||
316 | * @param string|null $key The key to a specific field in the fields array |
||
317 | * @return array|mixed|null If $key is set and field exists at $key, return that. If not set, return NULL. Otherwise, return array of fields. |
||
318 | */ |
||
319 | 38 | public function getFields( $key = null ) { |
|
329 | |||
330 | /** |
||
331 | * Get the fields for a specific context |
||
332 | * |
||
333 | * @since 1.19.2 |
||
334 | * |
||
335 | * @param string $context [Optional] "directory", "single", or "edit" |
||
336 | * |
||
337 | * @return array Array of GravityView field layout configurations |
||
338 | */ |
||
339 | 2 | public function getContextFields( $context = '' ) { |
|
359 | |||
360 | /** |
||
361 | * @param array $fields |
||
362 | */ |
||
363 | 37 | public function setFields( $fields ) { |
|
366 | |||
367 | /** |
||
368 | * @param string $key The key to a specific field in the fields array |
||
369 | * @return array|mixed|null If $key is set and field exists at $key, return that. If not set, return NULL. Otherwise, return array of fields. |
||
370 | */ |
||
371 | 2 | public function getField( $key ) { |
|
381 | |||
382 | /** |
||
383 | * @param string $key The key to a specific field in the fields array |
||
384 | * @param mixed $value The value to set for the field |
||
385 | */ |
||
386 | public function setField( $key, $value ) { |
||
389 | |||
390 | /** |
||
391 | * @return int |
||
392 | */ |
||
393 | 62 | public function getViewId() { |
|
396 | |||
397 | /** |
||
398 | * @param int $view_id |
||
399 | */ |
||
400 | 38 | public function setViewId( $view_id ) { |
|
403 | |||
404 | /** |
||
405 | * @return int |
||
406 | */ |
||
407 | 38 | public function getFormId() { |
|
410 | |||
411 | /** |
||
412 | * @param int $form_id |
||
413 | */ |
||
414 | 38 | public function setFormId( $form_id ) { |
|
417 | |||
418 | /** |
||
419 | * @return array |
||
420 | */ |
||
421 | 78 | public function getEntries() { |
|
424 | |||
425 | /** |
||
426 | * @param array $entries |
||
427 | */ |
||
428 | 38 | public function setEntries( $entries ) { |
|
431 | |||
432 | /** |
||
433 | * @return int |
||
434 | */ |
||
435 | 39 | public function getTotalEntries() { |
|
438 | |||
439 | /** |
||
440 | * @param int $total_entries |
||
441 | */ |
||
442 | 39 | public function setTotalEntries( $total_entries ) { |
|
445 | |||
446 | /** |
||
447 | * @return array |
||
448 | */ |
||
449 | 39 | public function getPaging() { |
|
458 | |||
459 | /** |
||
460 | * @param array $paging |
||
461 | */ |
||
462 | 38 | public function setPaging( $paging ) { |
|
465 | |||
466 | /** |
||
467 | * Get an array with pagination information |
||
468 | * |
||
469 | * @since 1.13 |
||
470 | * |
||
471 | * @return array { |
||
472 | * @type int $first The starting entry number (counter, not ID) |
||
473 | * @type int $last The last displayed entry number (counter, not ID) |
||
474 | * @type int $total The total number of entries |
||
475 | * } |
||
476 | */ |
||
477 | 2 | public function getPaginationCounts() { |
|
504 | |||
505 | /** |
||
506 | * @return array |
||
507 | */ |
||
508 | 38 | public function getSorting() { |
|
518 | |||
519 | /** |
||
520 | * @param array $sorting |
||
521 | */ |
||
522 | 76 | public function setSorting( $sorting ) { |
|
525 | |||
526 | /** |
||
527 | * @param boolean $do_replace Perform merge tag and shortcode processing on the label. Default: true. |
||
528 | * @since 2.0 |
||
529 | * |
||
530 | * @deprecated Use $template->get_back_label(); |
||
531 | * |
||
532 | * @return string |
||
533 | */ |
||
534 | 39 | public function getBackLinkLabel( $do_replace = true ) { |
|
542 | |||
543 | /** |
||
544 | * @param string $back_link_label |
||
545 | */ |
||
546 | 39 | public function setBackLinkLabel( $back_link_label ) { |
|
549 | |||
550 | /** |
||
551 | * @return boolean |
||
552 | */ |
||
553 | 38 | public function isHideUntilSearched() { |
|
556 | |||
557 | /** |
||
558 | * @param boolean $hide_until_searched |
||
559 | */ |
||
560 | 38 | public function setHideUntilSearched( $hide_until_searched ) { |
|
561 | 38 | $this->hide_until_searched = $hide_until_searched; |
|
562 | 38 | } |
|
563 | |||
564 | /** |
||
565 | * @return string |
||
566 | */ |
||
567 | 2 | public function getTemplatePartSlug() { |
|
570 | |||
571 | /** |
||
572 | * @param string $template_part_slug |
||
573 | */ |
||
574 | 6 | public function setTemplatePartSlug( $template_part_slug ) { |
|
577 | |||
578 | /** |
||
579 | * @return string |
||
580 | */ |
||
581 | public function getTemplatePartName() { |
||
584 | |||
585 | /** |
||
586 | * @param string $template_part_name |
||
587 | */ |
||
588 | 6 | public function setTemplatePartName( $template_part_name ) { |
|
591 | |||
592 | /** |
||
593 | * Return the current entry. If in the loop, the current entry. If single entry, the currently viewed entry. |
||
594 | * @return array |
||
595 | */ |
||
596 | 101 | public function getCurrentEntry() { |
|
612 | |||
613 | /** |
||
614 | * @param array $current_entry |
||
615 | * @return void |
||
616 | */ |
||
617 | 39 | public function setCurrentEntry( $current_entry ) { |
|
620 | |||
621 | /** |
||
622 | * Clear the current entry after all entries in the loop have been displayed. |
||
623 | * |
||
624 | * @since 1.7.3 |
||
625 | * @return void |
||
626 | */ |
||
627 | 29 | public function clearCurrentEntry() { |
|
630 | |||
631 | /** |
||
632 | * Render an output zone, as configured in the Admin |
||
633 | * |
||
634 | * @since 1.16.4 Added $echo parameter |
||
635 | * |
||
636 | * @param string $zone The zone name, like 'footer-left' |
||
637 | * @param array $atts |
||
638 | * @param bool $echo Whether to print the output |
||
639 | * |
||
640 | * @deprecated This will never get called in new templates. |
||
641 | * |
||
642 | * @return string|null |
||
643 | */ |
||
644 | 2 | public function renderZone( $zone = '', $atts = array(), $echo = true ) { |
|
720 | |||
721 | /** |
||
722 | * In order to improve lookup times, we store located templates in a local array. |
||
723 | * |
||
724 | * This improves performance by up to 1/2 second on a 250 entry View with 7 columns showing |
||
725 | * |
||
726 | * @inheritdoc |
||
727 | * @see Gamajo_Template_Loader::locate_template() |
||
728 | * @return null|string NULL: Template not found; String: path to template |
||
729 | */ |
||
730 | 4 | function locate_template( $template_names, $load = false, $require_once = true ) { |
|
752 | |||
753 | /** |
||
754 | * Magic Method: Instead of throwing an error when a variable isn't set, return null. |
||
755 | * @param string $name Key for the data retrieval. |
||
756 | * @return mixed|null The stored data. |
||
757 | */ |
||
758 | 3 | public function __get( $name ) { |
|
765 | |||
766 | /** |
||
767 | * Enable overrides of GravityView templates on a granular basis |
||
768 | * |
||
769 | * The loading order is: |
||
770 | * |
||
771 | * - view-[View ID]-table-footer.php |
||
772 | * - form-[Form ID]-table-footer.php |
||
773 | * - page-[ID of post or page where view is embedded]-table-footer.php |
||
774 | * - table-footer.php |
||
775 | * |
||
776 | * @see Gamajo_Template_Loader::get_template_file_names() Where the filter is |
||
777 | * @param array $templates Existing list of templates. |
||
778 | * @param string $slug Name of the template base, example: `table`, `list`, `datatables`, `map` |
||
779 | * @param string $name Name of the template part, example: `body`, `footer`, `head`, `single` |
||
780 | * |
||
781 | * @return array $templates Modified template array, merged with existing $templates values |
||
782 | */ |
||
783 | 34 | function add_id_specific_templates( $templates, $slug, $name ) { |
|
808 | |||
809 | // Load the template |
||
810 | 4 | public function render( $slug, $name, $require_once = true ) { |
|
830 | |||
831 | /** |
||
832 | * Output the widgets on before/after hooks. |
||
833 | * |
||
834 | * @param int|\GV\Template_Context $view_id_or_context The View ID or the context. |
||
835 | * |
||
836 | * @return void |
||
837 | */ |
||
838 | 33 | public function render_widget_hooks( $view_id_or_context ) { |
|
953 | |||
954 | /** |
||
955 | * Include a file inside this context. |
||
956 | * |
||
957 | * @param string $path A path to the legacy template to include. |
||
958 | * |
||
959 | * @return void |
||
960 | */ |
||
961 | 2 | public function _include( $path ) { |
|
966 | |||
967 | } |
||
968 | |||
969 |
Adding explicit visibility (
private
,protected
, orpublic
) is generally recommend to communicate to other developers how, and from where this method is intended to be used.