gravityview /
GravityView
Complex classes like GravityView_Render_Settings 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_Render_Settings, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 14 | class GravityView_Render_Settings { |
||
| 15 | |||
| 16 | /** |
||
| 17 | * Get the default options for a standard field. |
||
| 18 | * |
||
| 19 | * @param string $field_type Type of field options to render (`field` or `widget`) |
||
| 20 | * @param string $template_id Table slug |
||
| 21 | * @param float $field_id GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by` |
||
| 22 | * @param string $context What context are we in? Example: `single` or `directory` |
||
| 23 | * @param string $input_type (textarea, list, select, etc.) |
||
| 24 | * @return array Array of field options with `label`, `value`, `type`, `default` keys |
||
| 25 | */ |
||
| 26 | public static function get_default_field_options( $field_type, $template_id, $field_id, $context, $input_type ) { |
||
| 102 | |||
| 103 | /** |
||
| 104 | * Get capabilities options for GravityView |
||
| 105 | * |
||
| 106 | * Parameters are only to pass to the filter. |
||
| 107 | * |
||
| 108 | * @param string $template_id Optional. View slug |
||
| 109 | * @param string $field_id Optional. GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by` |
||
| 110 | * @param string $context Optional. What context are we in? Example: `single` or `directory` |
||
| 111 | * @param string $input_type Optional. (textarea, list, select, etc.) |
||
| 112 | * @return array Associative array, with the key being the capability and the value being the label shown. |
||
| 113 | */ |
||
| 114 | static public function get_cap_choices( $template_id = '', $field_id = '', $context = '', $input_type = '' ) { |
||
| 143 | |||
| 144 | |||
| 145 | /** |
||
| 146 | * Render Field Options html (shown through a dialog box) |
||
| 147 | * |
||
| 148 | * @see GravityView_Ajax::get_field_options |
||
| 149 | * @see GravityView_Admin_Views::render_active_areas |
||
| 150 | * |
||
| 151 | * @access public |
||
| 152 | * @param string $field_type field / widget |
||
| 153 | * @param string $template_id |
||
| 154 | * @param string $field_id |
||
| 155 | * @param string $field_label |
||
| 156 | * @param string $area |
||
| 157 | * @param string $uniqid (default: '') |
||
| 158 | * @param string $current (default: '') |
||
| 159 | * @param string $context (default: 'single') |
||
| 160 | * @param array $item Field or widget array that's being rendered |
||
| 161 | * |
||
| 162 | * @return string HTML of dialog box |
||
| 163 | */ |
||
| 164 | public static function render_field_options( $field_type, $template_id, $field_id, $field_label, $area, $input_type = NULL, $uniqid = '', $current = '', $context = 'single', $item = array() ) { |
||
| 227 | |||
| 228 | |||
| 229 | |||
| 230 | /** |
||
| 231 | * Handle rendering a field option form element |
||
| 232 | * |
||
| 233 | * @param string $name Input `name` attribute |
||
| 234 | * @param array $option Associative array of options. See the $defaults variable for available keys. |
||
| 235 | * @param mixed $curr_value Current value of option |
||
| 236 | * @return string HTML output of option |
||
| 237 | */ |
||
| 238 | public static function render_field_option( $name = '', $option, $curr_value = NULL ) { |
||
| 239 | |||
| 240 | $output = ''; |
||
| 241 | |||
| 242 | /** |
||
| 243 | * @deprecated setting index 'default' was replaced by 'value' |
||
| 244 | * @see GravityView_FieldType::get_field_defaults |
||
| 245 | */ |
||
| 246 | if( !empty( $option['default'] ) && empty( $option['value'] ) ) { |
||
| 247 | $option['value'] = $option['default']; |
||
| 248 | _deprecated_function( 'GravityView_FieldType::get_field_defaults', '1.1.7', '[value] instead of [default] when defining the setting '. $name .' details' ); |
||
| 249 | } |
||
| 250 | |||
| 251 | // prepare to render option field type |
||
| 252 | if( isset( $option['type'] ) ) { |
||
| 253 | |||
| 254 | $type_class = self::load_type_class( $option ); |
||
| 255 | |||
| 256 | if( class_exists( $type_class ) ) { |
||
| 257 | |||
| 258 | $render_type = new $type_class( $name, $option, $curr_value ); |
||
| 259 | |||
| 260 | ob_start(); |
||
| 261 | |||
| 262 | $render_type->render_option(); |
||
| 263 | |||
| 264 | $output = ob_get_clean(); |
||
| 265 | |||
| 266 | /** |
||
| 267 | * @filter `gravityview/option/output/{option_type}` Modify the output for a GravityView setting.\n |
||
| 268 | * `$option_type` is the type of setting (`radio`, `text`, etc.) |
||
| 269 | * @param[in,out] string $output field class name |
||
| 270 | * @param[in] array $option option field data |
||
| 271 | */ |
||
| 272 | $output = apply_filters( "gravityview/option/output/{$option['type']}" , $output, $option ); |
||
| 273 | } |
||
|
1 ignored issue
–
show
|
|||
| 274 | |||
| 275 | } // isset option[type] |
||
| 276 | |||
| 277 | return $output; |
||
| 278 | } |
||
| 279 | |||
| 280 | |||
| 281 | |||
| 282 | |||
| 283 | |||
| 284 | |||
| 285 | /** |
||
| 286 | * Output a table row for view settings |
||
| 287 | * @param string $key The key of the input |
||
| 288 | * @param array $current_settings Associative array of current settings to use as input values, if set. If not set, the defaults are used. |
||
| 289 | * @param string $override_input [description] |
||
| 290 | * @param string $name [description] |
||
| 291 | * @param string $id [description] |
||
| 292 | * @return void [description] |
||
| 293 | */ |
||
| 294 | public static function render_setting_row( $key = '', $current_settings = array(), $override_input = null, $name = 'template_settings[%s]', $id = 'gravityview_se_%s' ) { |
||
| 295 | |||
| 296 | $setting = GravityView_View_Data::get_default_arg( $key, true ); |
||
| 297 | |||
| 298 | // If the key doesn't exist, there's something wrong. |
||
| 299 | if( empty( $setting ) ) { return; } |
||
| 300 | |||
| 301 | /** |
||
| 302 | * @deprecated setting index 'name' was replaced by 'label' |
||
| 303 | * @see GravityView_FieldType::get_field_defaults |
||
| 304 | */ |
||
| 305 | if( isset( $setting['name'] ) && empty( $setting['label'] ) ) { |
||
| 306 | $setting['label'] = $setting['name']; |
||
| 307 | _deprecated_function( 'GravityView_FieldType::get_field_defaults', '1.1.7', '[label] instead of [name] when defining the setting '. $key .' details' ); |
||
| 308 | } |
||
| 309 | |||
| 310 | $name = esc_attr( sprintf( $name, $key ) ); |
||
| 311 | $setting['id'] = esc_attr( sprintf( $id, $key ) ); |
||
| 312 | $setting['tooltip'] = 'gv_' . $key; |
||
| 313 | |||
| 314 | // Use default if current setting isn't set. |
||
| 315 | $curr_value = isset( $current_settings[ $key ] ) ? $current_settings[ $key ] : $setting['value']; |
||
| 316 | |||
| 317 | // default setting type = text |
||
| 318 | $setting['type'] = empty( $setting['type'] ) ? 'text' : $setting['type']; |
||
| 319 | |||
| 320 | // merge tags |
||
| 321 | if( !isset( $setting['merge_tags'] ) ) { |
||
| 322 | if( $setting['type'] === 'text' ) { |
||
| 323 | $setting['merge_tags'] = true; |
||
| 324 | } else { |
||
| 325 | $setting['merge_tags'] = false; |
||
| 326 | } |
||
| 327 | } |
||
| 328 | |||
| 329 | $output = ''; |
||
| 330 | |||
| 331 | // render the setting |
||
| 332 | $type_class = self::load_type_class( $setting ); |
||
| 333 | if( class_exists( $type_class ) ) { |
||
| 334 | /** @var GravityView_FieldType $render_type */ |
||
| 335 | $render_type = new $type_class( $name, $setting, $curr_value ); |
||
| 336 | ob_start(); |
||
| 337 | $render_type->render_setting( $override_input ); |
||
| 338 | $output = ob_get_clean(); |
||
| 339 | } |
||
| 340 | |||
| 341 | // Check if setting is specific for a template |
||
| 342 | if( !empty( $setting['show_in_template'] ) ) { |
||
| 343 | if( !is_array( $setting['show_in_template'] ) ) { |
||
| 344 | $setting['show_in_template'] = array( $setting['show_in_template'] ); |
||
| 345 | } |
||
| 346 | $show_if = ' data-show-if="'. implode( ' ', $setting['show_in_template'] ).'"'; |
||
| 347 | } else { |
||
| 348 | $show_if = ''; |
||
| 349 | } |
||
| 350 | |||
| 351 | // output |
||
| 352 | echo '<tr valign="top" '. $show_if .'>' . $output . '</tr>'; |
||
| 353 | |||
| 354 | } |
||
| 355 | |||
| 356 | |||
| 357 | /** |
||
| 358 | * Given a field type calculates the php class. If not found try to load it. |
||
| 359 | * @param array $field |
||
| 360 | * @return string type class name |
||
| 361 | */ |
||
| 362 | public static function load_type_class( $field = NULL ) { |
||
| 394 | |||
| 395 | |||
| 396 | |||
| 397 | |||
| 398 | |||
| 399 | /** |
||
| 400 | * @deprecated 1.2 |
||
| 401 | * Render the HTML for a checkbox input to be used on the field & widgets options |
||
| 402 | * @param string $name , name attribute |
||
| 403 | * @param string $current current value |
||
| 404 | * @return string html tags |
||
| 405 | */ |
||
| 406 | public static function render_checkbox_option( $name = '', $id = '', $current = '' ) { |
||
| 413 | |||
| 414 | |||
| 415 | /** |
||
| 416 | * @deprecated 1.2 |
||
| 417 | * Render the HTML for an input text to be used on the field & widgets options |
||
| 418 | * @param string $name Unique name of the field. Exampe: `fields[directory_list-title][5374ff6ab128b][custom_label]` |
||
| 419 | * @param string $current [current value] |
||
| 420 | * @param string $add_merge_tags Add merge tags to the input? |
||
| 421 | * @param array $args Field settings, including `class` key for CSS class |
||
| 422 | * @return string [html tags] |
||
| 423 | */ |
||
| 424 | public static function render_text_option( $name = '', $id = '', $current = '', $add_merge_tags = NULL, $args = array() ) { |
||
| 444 | |||
| 445 | /** |
||
| 446 | * @deprecated 1.2 |
||
| 447 | * Render the HTML for an textarea input to be used on the field & widgets options |
||
| 448 | * @param string $name Unique name of the field. Exampe: `fields[directory_list-title][5374ff6ab128b][custom_label]` |
||
| 449 | * @param string $current [current value] |
||
| 450 | * @param string|boolean $add_merge_tags Add merge tags to the input? |
||
| 451 | * @param array $args Field settings, including `class` key for CSS class |
||
| 452 | * @return string [html tags] |
||
| 453 | */ |
||
| 454 | public static function render_textarea_option( $name = '', $id = '', $current = '', $add_merge_tags = NULL, $args = array() ) { |
||
| 473 | |||
| 474 | /** |
||
| 475 | * |
||
| 476 | * Render the HTML for a select box to be used on the field & widgets options |
||
| 477 | * @deprecated 1.2 |
||
| 478 | * @param string $name [name attribute] |
||
| 479 | * @param array $choices [select options] |
||
| 480 | * @param string $current [current value] |
||
| 481 | * @return string [html tags] |
||
| 482 | */ |
||
| 483 | public static function render_select_option( $name = '', $id = '', $choices, $current = '' ) { |
||
| 493 | |||
| 494 | |||
| 495 | } |
||
| 496 |
Loading history...
