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:
| 1 | <?php |
||
| 13 | class Health { |
||
| 14 | |||
| 15 | /** |
||
| 16 | * Prefix of the blog lock transient. |
||
| 17 | * |
||
| 18 | * @access public |
||
| 19 | * |
||
| 20 | * @var string |
||
| 21 | */ |
||
| 22 | const STATUS_OPTION = 'sync_health_status'; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * Status key in option array. |
||
| 26 | * |
||
| 27 | * @access public |
||
| 28 | * |
||
| 29 | * @var string |
||
| 30 | */ |
||
| 31 | const OPTION_STATUS_KEY = 'status'; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * Timestamp key in option array. |
||
| 35 | * |
||
| 36 | * @access public |
||
| 37 | * |
||
| 38 | * @var string |
||
| 39 | */ |
||
| 40 | const OPTION_TIMESTAMP_KEY = 'timestamp'; |
||
| 41 | |||
| 42 | /** |
||
| 43 | * Unknown status code. |
||
| 44 | * |
||
| 45 | * @access public |
||
| 46 | * |
||
| 47 | * @var string |
||
| 48 | */ |
||
| 49 | const STATUS_UNKNOWN = 'unknown'; |
||
| 50 | |||
| 51 | /** |
||
| 52 | * Disabled status code. |
||
| 53 | * |
||
| 54 | * @access public |
||
| 55 | * |
||
| 56 | * @var string |
||
| 57 | */ |
||
| 58 | const STATUS_DISABLED = 'disabled'; |
||
| 59 | |||
| 60 | /** |
||
| 61 | * Out of sync status code. |
||
| 62 | * |
||
| 63 | * @access public |
||
| 64 | * |
||
| 65 | * @var string |
||
| 66 | */ |
||
| 67 | const STATUS_OUT_OF_SYNC = 'out_of_sync'; |
||
| 68 | |||
| 69 | /** |
||
| 70 | * In sync status code. |
||
| 71 | * |
||
| 72 | * @access public |
||
| 73 | * |
||
| 74 | * @var string |
||
| 75 | */ |
||
| 76 | const STATUS_IN_SYNC = 'in_sync'; |
||
| 77 | |||
| 78 | /** |
||
| 79 | * Initializing status code. |
||
| 80 | * |
||
| 81 | * @access public |
||
| 82 | * |
||
| 83 | * @var string |
||
| 84 | */ |
||
| 85 | const STATUS_INITIALIZING = 'initializing'; |
||
| 86 | |||
| 87 | /** |
||
| 88 | * Gets health status code. |
||
| 89 | * |
||
| 90 | * @return string Sync Health Status |
||
| 91 | */ |
||
| 92 | public static function get_status() { |
||
| 110 | |||
| 111 | /** |
||
| 112 | * Sets sync health status to either STATUS_INITIALIZING or, if sync is disabled, |
||
| 113 | * to STATUS_DISABLED. This method is hooked to Jetpack's plugin activation and |
||
| 114 | * upgrade actions. |
||
| 115 | */ |
||
| 116 | public static function set_initial_status() { |
||
| 125 | |||
| 126 | /** |
||
| 127 | * Updates sync health status with either a valid status, or an unknown status. |
||
| 128 | * |
||
| 129 | * @param string $status Sync Status. |
||
| 130 | */ |
||
| 131 | public static function update_status( $status ) { |
||
| 149 | |||
| 150 | /** |
||
| 151 | * Check if Status has been previously set. |
||
| 152 | * |
||
| 153 | * @return bool is a Status defined |
||
| 154 | */ |
||
| 155 | public static function is_status_defined() { |
||
| 164 | |||
| 165 | } |
||
| 166 |