gravityview /
GravityView
Complex classes like gravityview 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, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 12 | class gravityview extends \GV\Shortcode { |
||
| 13 | /** |
||
| 14 | * {@inheritDoc} |
||
| 15 | */ |
||
| 16 | public $name = 'gravityview'; |
||
| 17 | |||
| 18 | /** |
||
| 19 | * A stack of calls to track nested shortcodes. |
||
| 20 | */ |
||
| 21 | public static $callstack = array(); |
||
| 22 | |||
| 23 | /** |
||
| 24 | * Process and output the [gravityview] shortcode. |
||
| 25 | * |
||
| 26 | * @param array $passed_atts The attributes passed. |
||
| 27 | * @param string $content The content inside the shortcode. |
||
| 28 | * |
||
| 29 | * @return string|null The output. |
||
| 30 | */ |
||
| 31 | 7 | public function callback( $passed_atts, $content = null ) { |
|
| 32 | 7 | $request = gravityview()->request; |
|
| 33 | |||
| 34 | 7 | if ( $request->is_admin() ) { |
|
| 35 | return ''; |
||
| 36 | } |
||
| 37 | |||
| 38 | 7 | $atts = wp_parse_args( $passed_atts, array( |
|
| 39 | 7 | 'id' => 0, |
|
| 40 | 'view_id' => 0, |
||
| 41 | 'detail' => null, |
||
| 42 | ) ); |
||
| 43 | |||
| 44 | 7 | if ( ! $view_id = $atts['id'] ? : $atts['view_id'] ) { |
|
| 45 | if ( $atts['detail'] && $view = $request->is_view() ) { |
||
| 46 | $view_id = $view->ID; |
||
| 47 | } |
||
| 48 | } |
||
| 49 | |||
| 50 | 7 | $view = \GV\View::by_id( $view_id ); |
|
| 51 | |||
| 52 | 7 | if ( ! $view ) { |
|
| 53 | gravityview()->log->error( 'View does not exist #{view_id}', array( 'view_id' => $view_id ) ); |
||
| 54 | return ''; |
||
| 55 | } |
||
| 56 | |||
| 57 | 7 | gravityview()->views->set( $view ); |
|
| 58 | |||
| 59 | /** |
||
| 60 | * When this shortcode is embedded inside a View we can only display it as a directory. There's no other way. |
||
| 61 | * Try to detect that we're not embedded to allow edit and single contexts. |
||
| 62 | */ |
||
| 63 | 7 | $is_reembedded = false; // Assume not embedded unless detected otherwise. |
|
| 64 | 7 | if ( in_array( get_class( $request ), array( 'GV\Frontend_Request', 'GV\Mock_Request' ) ) ) { |
|
| 65 | |||
| 66 | 7 | if ( ( $_view = $request->is_view() ) && $_view->ID !== $view->ID ) { |
|
| 67 | $is_reembedded = true; |
||
| 68 | |||
| 69 | 7 | } elseif ( $request->is_entry() && self::$callstack ) { |
|
| 70 | 1 | $is_reembedded = true; |
|
| 71 | } |
||
| 72 | } |
||
| 73 | |||
| 74 | 7 | array_push( self::$callstack, true ); |
|
| 75 | |||
| 76 | /** |
||
| 77 | * Remove Widgets on a nested embedded View. |
||
| 78 | */ |
||
| 79 | 7 | if ( $is_reembedded ) { |
|
| 80 | 1 | $view->widgets = new \GV\Widget_Collection(); |
|
| 81 | } |
||
| 82 | |||
| 83 | 7 | $atts = $this->parse_and_sanitize_atts( $atts ); |
|
| 84 | |||
| 85 | 7 | $view->settings->update( $atts ); |
|
| 86 | 7 | $entries = $view->get_entries( $request ); |
|
| 87 | |||
| 88 | /** |
||
| 89 | * Check permissions. |
||
| 90 | */ |
||
| 91 | 7 | while ( $error = $view->can_render( array( 'shortcode' ), $request ) ) { |
|
| 92 | 7 | if ( ! is_wp_error( $error ) ) |
|
| 93 | 7 | break; |
|
| 94 | |||
| 95 | 1 | switch ( str_replace( 'gravityview/', '', $error->get_error_code() ) ) { |
|
| 96 | 1 | case 'post_password_required': |
|
| 97 | 1 | return self::_return( get_the_password_form( $view->ID ) ); |
|
| 98 | 1 | case 'no_form_attached': |
|
| 99 | /** |
||
| 100 | * This View has no data source. There's nothing to show really. |
||
| 101 | * ...apart from a nice message if the user can do anything about it. |
||
| 102 | */ |
||
| 103 | if ( \GVCommon::has_cap( array( 'edit_gravityviews', 'edit_gravityview' ), $view->ID ) ) { |
||
| 104 | return self::_return( __( sprintf( 'This View is not configured properly. Start by <a href="%s">selecting a form</a>.', esc_url( get_edit_post_link( $view->ID, false ) ) ), 'gravityview' ) ); |
||
| 105 | } |
||
| 106 | break; |
||
| 107 | 1 | case 'no_direct_access': |
|
| 108 | 1 | case 'embed_only': |
|
| 109 | 1 | case 'not_public': |
|
| 110 | 1 | return self::_return( __( 'You are not allowed to view this content.', 'gravityview' ) ); |
|
| 111 | } |
||
| 112 | } |
||
| 113 | |||
| 114 | 7 | $is_admin_and_can_view = $view->settings->get( 'admin_show_all_statuses' ) && \GVCommon::has_cap('gravityview_moderate_entries', $view->ID ); |
|
| 115 | |||
| 116 | /** |
||
| 117 | * View details. |
||
| 118 | */ |
||
| 119 | 7 | if ( $atts['detail'] ) { |
|
| 120 | 2 | return self::_return( $this->detail( $view, $entries, $atts ) ); |
|
| 121 | |||
| 122 | /** |
||
| 123 | * Editing a single entry. |
||
| 124 | */ |
||
| 125 | 6 | } else if ( ! $is_reembedded && ( $entry = $request->is_edit_entry() ) ) { |
|
| 126 | |||
| 127 | /** |
||
| 128 | * When editing an entry don't render multiple views. |
||
| 129 | */ |
||
| 130 | if ( ( $selected = \GV\Utils::_GET( 'gvid' ) ) && $view->ID != $selected ) { |
||
| 131 | gravityview()->log->notice( 'Entry ID #{entry_id} not rendered because another View ID was passed using `?gvid`: #{selected}', array( 'entry_id' => $entry->ID, 'selected' => $selected ) ); |
||
| 132 | return self::_return( '' ); |
||
| 133 | } |
||
| 134 | |||
| 135 | if ( $entry['status'] != 'active' ) { |
||
| 136 | gravityview()->log->notice( 'Entry ID #{entry_id} is not active', array( 'entry_id' => $entry->ID ) ); |
||
| 137 | return self::_return( __( 'You are not allowed to view this content.', 'gravityview' ) ); |
||
| 138 | } |
||
| 139 | |||
| 140 | if ( apply_filters( 'gravityview_custom_entry_slug', false ) && $entry->slug != get_query_var( \GV\Entry::get_endpoint_name() ) ) { |
||
| 141 | gravityview()->log->error( 'Entry ID #{entry_id} was accessed by a bad slug', array( 'entry_id' => $entry->ID ) ); |
||
| 142 | return self::_return( __( 'You are not allowed to view this content.', 'gravityview' ) ); |
||
| 143 | } |
||
| 144 | |||
| 145 | if ( $view->settings->get( 'show_only_approved' ) && ! $is_admin_and_can_view ) { |
||
| 146 | if ( ! \GravityView_Entry_Approval_Status::is_approved( gform_get_meta( $entry->ID, \GravityView_Entry_Approval::meta_key ) ) ) { |
||
| 147 | gravityview()->log->error( 'Entry ID #{entry_id} is not approved for viewing', array( 'entry_id' => $entry->ID ) ); |
||
| 148 | return self::_return( __( 'You are not allowed to view this content.', 'gravityview' ) ); |
||
| 149 | } |
||
| 150 | } |
||
| 151 | |||
| 152 | $renderer = new \GV\Edit_Entry_Renderer(); |
||
| 153 | return self::_return( $renderer->render( $entry, $view, $request ) ); |
||
| 154 | |||
| 155 | /** |
||
| 156 | * Viewing a single entry. |
||
| 157 | */ |
||
| 158 | 6 | } else if ( ! $is_reembedded && ( $entry = $request->is_entry() ) ) { |
|
| 159 | /** |
||
| 160 | * When viewing an entry don't render multiple views. |
||
| 161 | */ |
||
| 162 | 3 | if ( ( $selected = \GV\Utils::_GET( 'gvid' ) ) && $view->ID != $selected ) { |
|
| 163 | return self::_return( '' ); |
||
| 164 | } |
||
| 165 | |||
| 166 | 3 | if ( $entry['status'] != 'active' ) { |
|
| 167 | 1 | gravityview()->log->notice( 'Entry ID #{entry_id} is not active', array( 'entry_id' => $entry->ID ) ); |
|
| 168 | 1 | return self::_return( __( 'You are not allowed to view this content.', 'gravityview' ) ); |
|
| 169 | } |
||
| 170 | |||
| 171 | 3 | if ( apply_filters( 'gravityview_custom_entry_slug', false ) && $entry->slug != get_query_var( \GV\Entry::get_endpoint_name() ) ) { |
|
| 172 | 1 | gravityview()->log->error( 'Entry ID #{entry_id} was accessed by a bad slug', array( 'entry_id' => $entry->ID ) ); |
|
| 173 | 1 | return self::_return( __( 'You are not allowed to view this content.', 'gravityview' ) ); |
|
| 174 | } |
||
| 175 | |||
| 176 | 3 | if ( $view->settings->get( 'show_only_approved' ) && ! $is_admin_and_can_view ) { |
|
| 177 | 1 | if ( ! \GravityView_Entry_Approval_Status::is_approved( gform_get_meta( $entry->ID, \GravityView_Entry_Approval::meta_key ) ) ) { |
|
| 178 | 1 | gravityview()->log->error( 'Entry ID #{entry_id} is not approved for viewing', array( 'entry_id' => $entry->ID ) ); |
|
| 179 | 1 | return self::_return( __( 'You are not allowed to view this content.', 'gravityview' ) ); |
|
| 180 | } |
||
| 181 | } |
||
| 182 | |||
| 183 | 3 | $error = \GVCommon::check_entry_display( $entry->as_entry() ); |
|
| 184 | |||
| 185 | 3 | if( is_wp_error( $error ) ) { |
|
| 186 | 1 | gravityview()->log->error( 'Entry ID #{entry_id} is not approved for viewing: {message}', array( 'entry_id' => $entry->ID, 'message' => $error->get_error_message() ) ); |
|
| 187 | 1 | return self::_return( __( 'You are not allowed to view this content.', 'gravityview' ) ); |
|
| 188 | } |
||
| 189 | |||
| 190 | 3 | $renderer = new \GV\Entry_Renderer(); |
|
| 191 | 3 | return self::_return( $renderer->render( $entry, $view, $request ) ); |
|
| 192 | |||
| 193 | /** |
||
| 194 | * Just this view. |
||
| 195 | */ |
||
| 196 | } else { |
||
| 197 | 4 | if ( $is_reembedded ) { |
|
| 198 | |||
| 199 | // Mock the request with the actual View, not the global one |
||
| 200 | 1 | $mock_request = new \GV\Mock_Request(); |
|
| 201 | 1 | $mock_request->returns['is_view'] = $view; |
|
| 202 | 1 | $mock_request->returns['is_entry'] = $request->is_entry(); |
|
| 203 | 1 | $mock_request->returns['is_edit_entry'] = $request->is_edit_entry(); |
|
| 204 | 1 | $mock_request->returns['is_search'] = $request->is_search(); |
|
| 205 | |||
| 206 | 1 | $request = $mock_request; |
|
| 207 | } |
||
| 208 | |||
| 209 | 4 | $renderer = new \GV\View_Renderer(); |
|
| 210 | 4 | return self::_return( $renderer->render( $view, $request ) ); |
|
| 211 | } |
||
| 212 | } |
||
| 213 | |||
| 214 | /** |
||
| 215 | * Validate attributes passed to the [gravityview] shortcode. Supports {get} Merge Tags values. |
||
| 216 | * |
||
| 217 | * Attributes passed to the shortcode are compared to registered attributes {@see \GV\View_Settings::defaults} |
||
| 218 | * Only attributes that are defined will be allowed through. |
||
| 219 | * |
||
| 220 | * Then, {get} merge tags are replaced with their $_GET values, if passed |
||
| 221 | * |
||
| 222 | * Then, attributes are sanitized based on the type of setting (number, checkbox, select, radio, text) |
||
| 223 | * |
||
| 224 | * @see \GV\View_Settings::defaults() Only attributes defined in default() are valid to be passed via the shortcode |
||
| 225 | * |
||
| 226 | * @param array $passed_atts Attribute pairs defined to render the View |
||
| 227 | * |
||
| 228 | * @return array Valid and sanitized attribute pairs |
||
| 229 | */ |
||
| 230 | 6 | private function parse_and_sanitize_atts( $passed_atts ) { |
|
| 289 | |||
| 290 | /** |
||
| 291 | * Output view details. |
||
| 292 | * |
||
| 293 | * @param \GV\View $view The View. |
||
| 294 | * @param \GV\Entry_Collection $entries The calculated entries. |
||
| 295 | * @param array $atts The shortcode attributes (with defaults). |
||
| 296 | * |
||
| 297 | * @return string The output. |
||
| 298 | */ |
||
| 299 | 1 | private function detail( $view, $entries, $atts ) { |
|
| 331 | |||
| 332 | /** |
||
| 333 | * Pop the callstack and return the value. |
||
| 334 | */ |
||
| 335 | 6 | private static function _return( $value ) { |
|
| 339 | } |
||
| 340 |
Loading history...
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.