WordImpress /
Give
| Conditions | 2 |
| Paths | 2 |
| Total Lines | 77 |
| Code Lines | 33 |
| 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 |
||
| 39 | function give_dashboard_sales_widget() { |
||
| 40 | |||
| 41 | if ( ! current_user_can( apply_filters( 'give_dashboard_stats_cap', 'view_give_reports' ) ) ) { |
||
| 42 | return; |
||
| 43 | } |
||
| 44 | $stats = new Give_Payment_Stats; ?> |
||
| 45 | |||
| 46 | <div class="give-dashboard-widget"> |
||
| 47 | |||
| 48 | <div class="give-dashboard-today give-clearfix"> |
||
| 49 | <h3 class="give-dashboard-date-today"><?php echo date( _x( 'F j, Y', 'dashboard widget', 'give' ) ); ?></h3> |
||
| 50 | |||
| 51 | <p class="give-dashboard-happy-day"><?php |
||
| 52 | printf( |
||
| 53 | /* translators: %s: day of the week */ |
||
| 54 | esc_html__( 'Happy %s!', 'give' ), |
||
| 55 | date( 'l', current_time( 'timestamp' ) ) |
||
| 56 | ); |
||
| 57 | ?></p> |
||
| 58 | |||
| 59 | <p class="give-dashboard-today-earnings"><?php |
||
| 60 | $earnings_today = $stats->get_earnings( 0, 'today', false ); |
||
| 61 | echo give_currency_filter( give_format_amount( $earnings_today ) ); |
||
| 62 | ?></p> |
||
| 63 | |||
| 64 | <p class="give-orders-today"><?php |
||
| 65 | $donations_today = $stats->get_sales( 0, 'today', false ); |
||
| 66 | printf( |
||
| 67 | /* translators: %s: daily donation count */ |
||
| 68 | esc_html__( '%s donations today', 'give' ), |
||
| 69 | give_format_amount( $donations_today, false ) |
||
| 70 | ); |
||
| 71 | ?></p> |
||
| 72 | |||
| 73 | </div> |
||
| 74 | |||
| 75 | |||
| 76 | <table class="give-table-stats"> |
||
| 77 | <thead style="display: none;"> |
||
| 78 | <tr> |
||
| 79 | <th><?php esc_html_e( 'This Week', 'give' ); ?></th> |
||
| 80 | <th><?php esc_html_e( 'This Month', 'give' ); ?></th> |
||
| 81 | <th><?php esc_html_e( 'Past 30 Days', 'give' ); ?></th> |
||
| 82 | </tr> |
||
| 83 | </thead> |
||
| 84 | <tbody> |
||
| 85 | <tr id="give-table-stats-tr-1"> |
||
| 86 | <td> |
||
| 87 | <p class="give-dashboard-stat-total"><?php echo give_currency_filter( give_format_amount( $stats->get_earnings( 0, 'this_week' ) ) ); ?></p> |
||
| 88 | |||
| 89 | <p class="give-dashboard-stat-total-label"><?php esc_html_e( 'This Week', 'give' ); ?></p> |
||
| 90 | </td> |
||
| 91 | <td> |
||
| 92 | <p class="give-dashboard-stat-total"><?php echo give_currency_filter( give_format_amount( $stats->get_earnings( 0, 'this_month' ) ) ); ?></p> |
||
| 93 | |||
| 94 | <p class="give-dashboard-stat-total-label"><?php esc_html_e( 'This Month', 'give' ); ?></p> |
||
| 95 | </td> |
||
| 96 | </tr> |
||
| 97 | <tr id="give-table-stats-tr-2"> |
||
| 98 | <td> |
||
| 99 | <p class="give-dashboard-stat-total"><?php echo give_currency_filter( give_format_amount( $stats->get_earnings( 0, 'last_month' ) ) ) ?></p> |
||
| 100 | |||
| 101 | <p class="give-dashboard-stat-total-label"><?php esc_html_e( 'Last Month', 'give' ); ?></p> |
||
| 102 | </td> |
||
| 103 | <td> |
||
| 104 | <p class="give-dashboard-stat-total"><?php echo give_currency_filter( give_format_amount( $stats->get_earnings( 0, 'this_year', false ) ) ) ?></p> |
||
| 105 | |||
| 106 | <p class="give-dashboard-stat-total-label"><?php esc_html_e( 'This Year', 'give' ); ?></p> |
||
| 107 | </td> |
||
| 108 | </tr> |
||
| 109 | </tbody> |
||
| 110 | </table> |
||
| 111 | |||
| 112 | </div> |
||
| 113 | |||
| 114 | <?php |
||
| 115 | } |
||
| 116 | |||
| 152 |
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.