ravinderk /
Give
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Give_Logging 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 Give_Logging, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 24 | class Give_Logging { |
||
| 25 | /** |
||
| 26 | * Logs data operation handler object. |
||
| 27 | * |
||
| 28 | * @since 2.0 |
||
| 29 | * @access private |
||
| 30 | * @var Give_DB_Logs |
||
| 31 | */ |
||
| 32 | public $log_db; |
||
| 33 | |||
| 34 | /** |
||
| 35 | * Log meta data operation handler object. |
||
| 36 | * |
||
| 37 | * @since 2.0 |
||
| 38 | * @access private |
||
| 39 | * @var Give_DB_Log_Meta |
||
| 40 | */ |
||
| 41 | public $logmeta_db; |
||
| 42 | |||
| 43 | /** |
||
| 44 | * Class Constructor |
||
| 45 | * |
||
| 46 | * Set up the Give Logging Class. |
||
| 47 | * |
||
| 48 | * @since 1.0 |
||
| 49 | * @access public |
||
| 50 | */ |
||
| 51 | public function __construct() { |
||
| 52 | /** |
||
| 53 | * Setup properties |
||
| 54 | */ |
||
| 55 | $this->log_db = Give()->log_db; |
||
| 56 | $this->logmeta_db = Give()->logmeta_db; |
||
| 57 | |||
| 58 | /** |
||
| 59 | * Setup hooks. |
||
| 60 | */ |
||
| 61 | |||
| 62 | add_action( 'save_post_give_payment', array( $this, 'background_process_delete_cache' ) ); |
||
| 63 | add_action( 'save_post_give_forms', array( $this, 'background_process_delete_cache' ) ); |
||
| 64 | add_action( 'save_post_give_log', array( $this, 'background_process_delete_cache' ) ); |
||
| 65 | add_action( 'give_delete_log_cache', array( $this, 'delete_cache' ) ); |
||
| 66 | add_action( 'update_log_metadata', array( $this, 'bc_200_set_payment_as_log_parent' ), 10, 4 ); |
||
| 67 | |||
| 68 | // Backward compatibility. |
||
| 69 | if ( ! give_has_upgrade_completed( 'v20_logs_upgrades' ) ) { |
||
| 70 | // Create the log post type |
||
| 71 | add_action( 'init', array( $this, 'register_post_type' ), -2 ); |
||
| 72 | } |
||
| 73 | |||
| 74 | // Create types taxonomy and default types |
||
| 75 | // @todo: remove this taxonomy, some addon use this taxonomy with there custom log post type for example: recurring |
||
| 76 | // Do not use this taxonomy with your log type because we will remove it in future releases. |
||
| 77 | add_action( 'init', array( $this, 'register_taxonomy' ), -2 ); |
||
| 78 | } |
||
| 79 | |||
| 80 | |||
| 81 | /** |
||
| 82 | * Log Post Type |
||
| 83 | * |
||
| 84 | * Registers the 'give_log' Post Type. |
||
| 85 | * |
||
| 86 | * @since 1.0 |
||
| 87 | * @access public |
||
| 88 | * |
||
| 89 | * @return void |
||
| 90 | */ |
||
| 91 | public function register_post_type() { |
||
| 92 | /* Logs post type */ |
||
| 93 | $log_args = array( |
||
| 94 | 'labels' => array( |
||
| 95 | 'name' => esc_html__( 'Logs', 'give' ), |
||
| 96 | ), |
||
| 97 | 'public' => false, |
||
| 98 | 'exclude_from_search' => true, |
||
| 99 | 'publicly_queryable' => false, |
||
| 100 | 'show_ui' => false, |
||
| 101 | 'query_var' => false, |
||
| 102 | 'rewrite' => false, |
||
| 103 | 'capability_type' => 'post', |
||
| 104 | 'supports' => array( 'title', 'editor' ), |
||
| 105 | 'can_export' => true, |
||
| 106 | ); |
||
| 107 | |||
| 108 | register_post_type( 'give_log', $log_args ); |
||
| 109 | } |
||
| 110 | |||
| 111 | /** |
||
| 112 | * Log Type Taxonomy |
||
| 113 | * |
||
| 114 | * Registers the "Log Type" taxonomy. Used to determine the type of log entry. |
||
| 115 | * |
||
| 116 | * @since 1.0 |
||
| 117 | * @access public |
||
| 118 | * |
||
| 119 | * @return void |
||
| 120 | */ |
||
| 121 | public function register_taxonomy() { |
||
| 122 | register_taxonomy( 'give_log_type', 'give_log', array( |
||
| 123 | 'public' => false, |
||
| 124 | ) ); |
||
| 125 | } |
||
| 126 | |||
| 127 | /** |
||
| 128 | * Log Types |
||
| 129 | * |
||
| 130 | * Sets up the default log types and allows for new ones to be created. |
||
| 131 | * |
||
| 132 | * @since 1.0 |
||
| 133 | * @access public |
||
| 134 | * |
||
| 135 | * @return array $terms |
||
| 136 | */ |
||
| 137 | public function log_types() { |
||
| 138 | $terms = array( |
||
| 139 | 'sale', |
||
| 140 | 'gateway_error', |
||
| 141 | 'api_request', |
||
| 142 | 'update', |
||
| 143 | ); |
||
| 144 | |||
| 145 | return apply_filters( 'give_log_types', $terms ); |
||
| 146 | } |
||
| 147 | |||
| 148 | /** |
||
| 149 | * Check if a log type is valid |
||
| 150 | * |
||
| 151 | * Checks to see if the specified type is in the registered list of types. |
||
| 152 | * |
||
| 153 | * @since 1.0 |
||
| 154 | * @access public |
||
| 155 | * |
||
| 156 | * @param string $type Log type. |
||
| 157 | * |
||
| 158 | * @return bool Whether log type is valid. |
||
| 159 | */ |
||
| 160 | public function valid_type( $type ) { |
||
| 163 | |||
| 164 | /** |
||
| 165 | * Create new log entry |
||
| 166 | * |
||
| 167 | * This is just a simple and fast way to log something. Use $this->insert_log() |
||
| 168 | * if you need to store custom meta data. |
||
| 169 | * |
||
| 170 | * @since 1.0 |
||
| 171 | * @access public |
||
| 172 | * |
||
| 173 | * @param string $title Log entry title. Default is empty. |
||
| 174 | * @param string $message Log entry message. Default is empty. |
||
| 175 | * @param int $parent Log entry parent. Default is 0. |
||
| 176 | * @param string $type Log type. Default is empty string. |
||
| 177 | * |
||
| 178 | * @return int Log ID. |
||
| 179 | */ |
||
| 180 | public function add( $title = '', $message = '', $parent = 0, $type = '' ) { |
||
| 190 | |||
| 191 | /** |
||
| 192 | * Get Logs |
||
| 193 | * |
||
| 194 | * Retrieves log items for a particular object ID. |
||
| 195 | * |
||
| 196 | * @since 1.0 |
||
| 197 | * @access public |
||
| 198 | * |
||
| 199 | * @param int $object_id Log object ID. Default is 0. |
||
| 200 | * @param string $type Log type. Default is empty string. |
||
| 201 | * @param int $paged Page number Default is null. |
||
| 202 | * |
||
| 203 | * @return array An array of the connected logs. |
||
| 204 | */ |
||
| 205 | public function get_logs( $object_id = 0, $type = '', $paged = null ) { |
||
| 212 | |||
| 213 | /** |
||
| 214 | * Stores a log entry |
||
| 215 | * |
||
| 216 | * @since 1.0 |
||
| 217 | * @access public |
||
| 218 | * |
||
| 219 | * @param array $log_data Log entry data. |
||
| 220 | * @param array $log_meta Log entry meta. |
||
| 221 | * |
||
| 222 | * @return int The ID of the newly created log item. |
||
| 223 | */ |
||
| 224 | public function insert_log( $log_data = array(), $log_meta = array() ) { |
||
| 268 | |||
| 269 | /** |
||
| 270 | * Update and existing log item |
||
| 271 | * |
||
| 272 | * @since 1.0 |
||
| 273 | * @access public |
||
| 274 | * |
||
| 275 | * @param array $log_data Log entry data. |
||
| 276 | * @param array $log_meta Log entry meta. |
||
| 277 | * |
||
| 278 | * @return bool|null True if successful, false otherwise. |
||
| 279 | */ |
||
| 280 | public function update_log( $log_data = array(), $log_meta = array() ) { |
||
| 339 | |||
| 340 | /** |
||
| 341 | * Retrieve all connected logs |
||
| 342 | * |
||
| 343 | * Used for retrieving logs related to particular items, such as a specific donation. |
||
| 344 | * For new table params check: Give_DB_Logs::get_column_defaults and Give_DB_Logs::get_sql#L262 |
||
| 345 | * |
||
| 346 | * @since 1.0 |
||
| 347 | * @since 2.0 Added new table logic. |
||
| 348 | * @access public |
||
| 349 | * |
||
| 350 | * @param array $args Query arguments. |
||
| 351 | * |
||
| 352 | * @return array|false Array if logs were found, false otherwise. |
||
| 353 | */ |
||
| 354 | public function get_connected_logs( $args = array() ) { |
||
| 379 | |||
| 380 | /** |
||
| 381 | * Retrieve Log Count |
||
| 382 | * |
||
| 383 | * Retrieves number of log entries connected to particular object ID. |
||
| 384 | * |
||
| 385 | * @since 1.0 |
||
| 386 | * @access public |
||
| 387 | * |
||
| 388 | * @param int $object_id Log object ID. Default is 0. |
||
| 389 | * @param string $type Log type. Default is empty string. |
||
| 390 | * @param array $meta_query Log meta query. Default is null. |
||
| 391 | * @param array $date_query Log data query. Default is null. |
||
| 392 | * |
||
| 393 | * @return int Log count. |
||
| 394 | */ |
||
| 395 | public function get_log_count( $object_id = 0, $type = '', $meta_query = null, $date_query = null ) { |
||
| 434 | |||
| 435 | /** |
||
| 436 | * Delete Logs |
||
| 437 | * |
||
| 438 | * Remove log entries connected to particular object ID. |
||
| 439 | * |
||
| 440 | * @since 1.0 |
||
| 441 | * @access public |
||
| 442 | * |
||
| 443 | * @param int $object_id Log object ID. Default is 0. |
||
| 444 | * @param string $type Log type. Default is empty string. |
||
| 445 | * @param array $meta_query Log meta query. Default is null. |
||
| 446 | * |
||
| 447 | * @return void |
||
| 448 | */ |
||
| 449 | public function delete_logs( $object_id = 0, $type = '', $meta_query = null ) { |
||
| 493 | |||
| 494 | /** |
||
| 495 | * Setup cron to delete log cache in background. |
||
| 496 | * |
||
| 497 | * @since 1.7 |
||
| 498 | * @access public |
||
| 499 | * |
||
| 500 | * @param int $post_id |
||
| 501 | */ |
||
| 502 | public function background_process_delete_cache( $post_id ) { |
||
| 506 | |||
| 507 | /** |
||
| 508 | * Delete all logging cache when form, log or payment updates |
||
| 509 | * |
||
| 510 | * @since 1.7 |
||
| 511 | * @access public |
||
| 512 | * |
||
| 513 | * @return bool |
||
| 514 | */ |
||
| 515 | public function delete_cache() { |
||
| 529 | |||
| 530 | /** |
||
| 531 | * Validate query params. |
||
| 532 | * |
||
| 533 | * @since 2.0 |
||
| 534 | * @access private |
||
| 535 | * |
||
| 536 | * @param array $log_query |
||
| 537 | * @param array $log_meta |
||
| 538 | */ |
||
| 539 | private function bc_200_validate_params( &$log_query, &$log_meta = array() ) { |
||
| 631 | |||
| 632 | /** |
||
| 633 | * Set new log properties. |
||
| 634 | * |
||
| 635 | * @since 2.0 |
||
| 636 | * @access private |
||
| 637 | * |
||
| 638 | * @param array $logs |
||
| 639 | */ |
||
| 640 | private function bc_200_add_new_properties( &$logs ) { |
||
| 683 | |||
| 684 | /** |
||
| 685 | * Change log parent to payment if set to form. |
||
| 686 | * |
||
| 687 | * @since 2.0 |
||
| 688 | * @access public |
||
| 689 | * |
||
| 690 | * @param mixed $check |
||
| 691 | * @param int $log_id |
||
| 692 | * @param array $meta_key |
||
| 693 | * @param array $meta_value |
||
| 694 | * |
||
| 695 | * @return mixed |
||
| 696 | */ |
||
| 697 | public function bc_200_set_payment_as_log_parent( $check, $log_id, $meta_key, $meta_value ) { |
||
| 743 | } |
||
| 744 |
Loading history...
This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.
Both the
$myVarassignment in line 1 and the$higherassignment in line 2 are dead. The first because$myVaris never used and the second because$higheris always overwritten for every possible time line.