ravinderk /
Give
| Conditions | 1 |
| Paths | 1 |
| Total Lines | 80 |
| Code Lines | 61 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 38 | public function define_fields() { |
||
| 39 | |||
| 40 | $create_form_link = sprintf( |
||
| 41 | /* translators: %s: create new form URL */ |
||
| 42 | __( '<a href="%s">Create</a> a new Donation Form.', 'give' ), |
||
| 43 | admin_url( 'post-new.php?post_type=give_forms' ) |
||
| 44 | ); |
||
| 45 | |||
| 46 | return array( |
||
| 47 | array( |
||
| 48 | 'type' => 'post', |
||
| 49 | 'query_args' => array( |
||
| 50 | 'post_type' => 'give_forms', |
||
| 51 | ), |
||
| 52 | 'name' => 'id', |
||
| 53 | 'tooltip' => esc_attr__( 'Select a Donation Form', 'give' ), |
||
| 54 | 'placeholder' => '- ' . esc_attr__( 'Select a Donation Form', 'give' ) . ' -', |
||
| 55 | 'required' => array( |
||
| 56 | 'alert' => esc_html__( 'You must first select a Form!', 'give' ), |
||
| 57 | 'error' => sprintf( '<p class="strong">%s</p><p class="no-margin">%s</p>', esc_html__( 'No forms found.', 'give' ), $create_form_link ), |
||
| 58 | ), |
||
| 59 | ), |
||
| 60 | array( |
||
| 61 | 'type' => 'container', |
||
| 62 | 'html' => sprintf( '<p class="strong margin-top">%s</p>', esc_html__( 'Optional settings', 'give' ) ), |
||
| 63 | ), |
||
| 64 | array( |
||
| 65 | 'type' => 'listbox', |
||
| 66 | 'name' => 'show_title', |
||
| 67 | 'label' => esc_attr__( 'Show Title', 'give' ), |
||
| 68 | 'tooltip' => esc_attr__( 'Do you want to display the form title?', 'give' ), |
||
| 69 | 'options' => array( |
||
| 70 | 'true' => esc_html__( 'Show', 'give' ), |
||
| 71 | 'false' => esc_html__( 'Hide', 'give' ), |
||
| 72 | ), |
||
| 73 | ), |
||
| 74 | array( |
||
| 75 | 'type' => 'listbox', |
||
| 76 | 'name' => 'show_goal', |
||
| 77 | 'label' => esc_attr__( 'Show Goal', 'give' ), |
||
| 78 | 'tooltip' => esc_attr__( 'Do you want to display the donation goal?', 'give' ), |
||
| 79 | 'options' => array( |
||
| 80 | 'true' => esc_html__( 'Show', 'give' ), |
||
| 81 | 'false' => esc_html__( 'Hide', 'give' ), |
||
| 82 | ), |
||
| 83 | ), |
||
| 84 | array( |
||
| 85 | 'type' => 'listbox', |
||
| 86 | 'name' => 'show_content', |
||
| 87 | 'minWidth' => 240, |
||
| 88 | 'label' => esc_attr__( 'Display Content', 'give' ), |
||
| 89 | 'tooltip' => esc_attr__( 'Do you want to display the form content?', 'give' ), |
||
| 90 | 'options' => array( |
||
| 91 | 'none' => esc_html__( 'No Content', 'give' ), |
||
| 92 | 'above' => esc_html__( 'Display content ABOVE the fields', 'give' ), |
||
| 93 | 'below' => esc_html__( 'Display content BELOW the fields', 'give' ), |
||
| 94 | ), |
||
| 95 | ), |
||
| 96 | array( |
||
| 97 | 'type' => 'listbox', |
||
| 98 | 'name' => 'display_style', |
||
| 99 | 'classes' => 'give-display-style', |
||
| 100 | 'label' => esc_attr__( 'Display Options', 'give' ), |
||
| 101 | 'tooltip' => esc_attr__( 'How would you like to display donation information?', 'give' ), |
||
| 102 | 'options' => array( |
||
| 103 | 'onpage' => esc_html__( 'All Fields', 'give' ), |
||
| 104 | 'modal' => esc_html__( 'Modal', 'give' ), |
||
| 105 | 'reveal' => esc_html__( 'Reveal', 'give' ), |
||
| 106 | 'button' => esc_html__( 'Button', 'give' ), |
||
| 107 | ), |
||
| 108 | ), |
||
| 109 | array( |
||
| 110 | 'type' => 'textbox', |
||
| 111 | 'classes' => 'give-hidden give-continue-button-title', |
||
| 112 | 'name' => 'continue_button_title', |
||
| 113 | 'label' => esc_attr__( 'Button Text', 'give' ), |
||
| 114 | 'tooltip' => esc_attr__( 'The button label for displaying the additional payment fields.', 'give' ), |
||
| 115 | ), |
||
| 116 | ); |
||
| 117 | } |
||
| 118 | } |
||
| 121 |
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.