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 |
||
| 22 | final class WP_Post { |
||
| 23 | |||
| 24 | /** |
||
| 25 | * Post ID. |
||
| 26 | * |
||
| 27 | * @var int |
||
| 28 | */ |
||
| 29 | public $ID; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * ID of post author. |
||
| 33 | * |
||
| 34 | * A numeric string, for compatibility reasons. |
||
| 35 | * |
||
| 36 | * @var string |
||
| 37 | */ |
||
| 38 | public $post_author = 0; |
||
| 39 | |||
| 40 | /** |
||
| 41 | * The post's local publication time. |
||
| 42 | * |
||
| 43 | * @var string |
||
| 44 | */ |
||
| 45 | public $post_date = '0000-00-00 00:00:00'; |
||
| 46 | |||
| 47 | /** |
||
| 48 | * The post's GMT publication time. |
||
| 49 | * |
||
| 50 | * @var string |
||
| 51 | */ |
||
| 52 | public $post_date_gmt = '0000-00-00 00:00:00'; |
||
| 53 | |||
| 54 | /** |
||
| 55 | * The post's content. |
||
| 56 | * |
||
| 57 | * @var string |
||
| 58 | */ |
||
| 59 | public $post_content = ''; |
||
| 60 | |||
| 61 | /** |
||
| 62 | * The post's title. |
||
| 63 | * |
||
| 64 | * @var string |
||
| 65 | */ |
||
| 66 | public $post_title = ''; |
||
| 67 | |||
| 68 | /** |
||
| 69 | * The post's excerpt. |
||
| 70 | * |
||
| 71 | * @var string |
||
| 72 | */ |
||
| 73 | public $post_excerpt = ''; |
||
| 74 | |||
| 75 | /** |
||
| 76 | * The post's status. |
||
| 77 | * |
||
| 78 | * @var string |
||
| 79 | */ |
||
| 80 | public $post_status = 'publish'; |
||
| 81 | |||
| 82 | /** |
||
| 83 | * Whether comments are allowed. |
||
| 84 | * |
||
| 85 | * @var string |
||
| 86 | */ |
||
| 87 | public $comment_status = 'open'; |
||
| 88 | |||
| 89 | /** |
||
| 90 | * Whether pings are allowed. |
||
| 91 | * |
||
| 92 | * @var string |
||
| 93 | */ |
||
| 94 | public $ping_status = 'open'; |
||
| 95 | |||
| 96 | /** |
||
| 97 | * The post's password in plain text. |
||
| 98 | * |
||
| 99 | * @var string |
||
| 100 | */ |
||
| 101 | public $post_password = ''; |
||
| 102 | |||
| 103 | /** |
||
| 104 | * The post's slug. |
||
| 105 | * |
||
| 106 | * @var string |
||
| 107 | */ |
||
| 108 | public $post_name = ''; |
||
| 109 | |||
| 110 | /** |
||
| 111 | * URLs queued to be pinged. |
||
| 112 | * |
||
| 113 | * @var string |
||
| 114 | */ |
||
| 115 | public $to_ping = ''; |
||
| 116 | |||
| 117 | /** |
||
| 118 | * URLs that have been pinged. |
||
| 119 | * |
||
| 120 | * @var string |
||
| 121 | */ |
||
| 122 | public $pinged = ''; |
||
| 123 | |||
| 124 | /** |
||
| 125 | * The post's local modified time. |
||
| 126 | * |
||
| 127 | * @var string |
||
| 128 | */ |
||
| 129 | public $post_modified = '0000-00-00 00:00:00'; |
||
| 130 | |||
| 131 | /** |
||
| 132 | * The post's GMT modified time. |
||
| 133 | * |
||
| 134 | * @var string |
||
| 135 | */ |
||
| 136 | public $post_modified_gmt = '0000-00-00 00:00:00'; |
||
| 137 | |||
| 138 | /** |
||
| 139 | * A utility DB field for post content. |
||
| 140 | * |
||
| 141 | * |
||
| 142 | * @var string |
||
| 143 | */ |
||
| 144 | public $post_content_filtered = ''; |
||
| 145 | |||
| 146 | /** |
||
| 147 | * ID of a post's parent post. |
||
| 148 | * |
||
| 149 | * @var int |
||
| 150 | */ |
||
| 151 | public $post_parent = 0; |
||
| 152 | |||
| 153 | /** |
||
| 154 | * The unique identifier for a post, not necessarily a URL, used as the feed GUID. |
||
| 155 | * |
||
| 156 | * @var string |
||
| 157 | */ |
||
| 158 | public $guid = ''; |
||
| 159 | |||
| 160 | /** |
||
| 161 | * A field used for ordering posts. |
||
| 162 | * |
||
| 163 | * @var int |
||
| 164 | */ |
||
| 165 | public $menu_order = 0; |
||
| 166 | |||
| 167 | /** |
||
| 168 | * The post's type, like post or page. |
||
| 169 | * |
||
| 170 | * @var string |
||
| 171 | */ |
||
| 172 | public $post_type = 'post'; |
||
| 173 | |||
| 174 | /** |
||
| 175 | * An attachment's mime type. |
||
| 176 | * |
||
| 177 | * @var string |
||
| 178 | */ |
||
| 179 | public $post_mime_type = ''; |
||
| 180 | |||
| 181 | /** |
||
| 182 | * Cached comment count. |
||
| 183 | * |
||
| 184 | * A numeric string, for compatibility reasons. |
||
| 185 | * |
||
| 186 | * @var string |
||
| 187 | */ |
||
| 188 | public $comment_count = 0; |
||
| 189 | |||
| 190 | /** |
||
| 191 | * Stores the post object's sanitization level. |
||
| 192 | * |
||
| 193 | * Does not correspond to a DB field. |
||
| 194 | * |
||
| 195 | * @var string |
||
| 196 | */ |
||
| 197 | public $filter; |
||
| 198 | |||
| 199 | /** |
||
| 200 | * Retrieve WP_Post instance. |
||
| 201 | * |
||
| 202 | * @static |
||
| 203 | * @access public |
||
| 204 | * |
||
| 205 | * @global wpdb $wpdb WordPress database abstraction object. |
||
| 206 | * |
||
| 207 | * @param int $post_id Post ID. |
||
| 208 | * @return WP_Post|false Post object, false otherwise. |
||
| 209 | */ |
||
| 210 | public static function get_instance( $post_id ) { |
||
| 233 | |||
| 234 | /** |
||
| 235 | * Constructor. |
||
| 236 | * |
||
| 237 | * @param WP_Post|object $post Post object. |
||
| 238 | */ |
||
| 239 | public function __construct( $post ) { |
||
| 243 | |||
| 244 | /** |
||
| 245 | * Isset-er. |
||
| 246 | * |
||
| 247 | * @param string $key Property to check if set. |
||
| 248 | * @return bool |
||
| 249 | */ |
||
| 250 | public function __isset( $key ) { |
||
| 265 | |||
| 266 | /** |
||
| 267 | * Getter. |
||
| 268 | * |
||
| 269 | * @param string $key Key to get. |
||
| 270 | * @return mixed |
||
| 271 | */ |
||
| 272 | public function __get( $key ) { |
||
| 308 | |||
| 309 | /** |
||
| 310 | * {@Missing Summary} |
||
| 311 | * |
||
| 312 | * @param string $filter Filter. |
||
| 313 | * @return self|array|bool|object|WP_Post |
||
| 314 | */ |
||
| 315 | public function filter( $filter ) { |
||
| 324 | |||
| 325 | /** |
||
| 326 | * Convert object to array. |
||
| 327 | * |
||
| 328 | * @return array Object as array. |
||
| 329 | */ |
||
| 330 | public function to_array() { |
||
| 340 | } |
||
| 341 |
If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:
If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.