WebDevStudios /
CMB2
Complex classes like CMB2_Sanitize 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 CMB2_Sanitize, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 15 | class CMB2_Sanitize { |
||
|
|
|||
| 16 | |||
| 17 | /** |
||
| 18 | * A CMB field object |
||
| 19 | * @var CMB2_Field object |
||
| 20 | */ |
||
| 21 | public $field; |
||
| 22 | |||
| 23 | /** |
||
| 24 | * Field's value |
||
| 25 | * @var mixed |
||
| 26 | */ |
||
| 27 | public $value; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * Setup our class vars |
||
| 31 | * @since 1.1.0 |
||
| 32 | * @param CMB2_Field $field A CMB2 field object |
||
| 33 | * @param mixed $value Field value |
||
| 34 | */ |
||
| 35 | 9 | public function __construct( CMB2_Field $field, $value ) { |
|
| 39 | |||
| 40 | /** |
||
| 41 | * Catchall method if field's 'sanitization_cb' is NOT defined, or field type does not have a corresponding validation method |
||
| 42 | * @since 1.0.0 |
||
| 43 | * @param string $name Non-existent method name |
||
| 44 | * @param array $arguments All arguments passed to the method |
||
| 45 | */ |
||
| 46 | 8 | public function __call( $name, $arguments ) { |
|
| 49 | |||
| 50 | /** |
||
| 51 | * Default fallback sanitization method. Applies filters. |
||
| 52 | * @since 1.0.2 |
||
| 53 | */ |
||
| 54 | 8 | public function default_sanitization() { |
|
| 55 | |||
| 56 | /** |
||
| 57 | * This exists for back-compatibility, but validation |
||
| 58 | * is not what happens here. |
||
| 59 | * @deprecated See documentation for "cmb2_sanitize_{$this->type()}". |
||
| 60 | */ |
||
| 61 | 8 | $override_value = apply_filters( "cmb2_validate_{$this->field->type()}", null, $this->value, $this->field->object_id, $this->field->args(), $this ); |
|
| 62 | |||
| 63 | 8 | if ( null !== $override_value ) { |
|
| 64 | return $override_value; |
||
| 65 | } |
||
| 66 | |||
| 67 | 8 | $sanitized_value = ''; |
|
| 68 | 8 | switch ( $this->field->type() ) { |
|
| 69 | 8 | case 'wysiwyg': |
|
| 70 | 8 | case 'textarea_small': |
|
| 71 | 8 | case 'oembed': |
|
| 72 | 2 | $sanitized_value = $this->textarea(); |
|
| 73 | 2 | break; |
|
| 74 | 8 | case 'taxonomy_select': |
|
| 75 | 8 | case 'taxonomy_radio': |
|
| 76 | 8 | case 'taxonomy_radio_inline': |
|
| 77 | 8 | case 'taxonomy_multicheck': |
|
| 78 | 8 | case 'taxonomy_multicheck_inline': |
|
| 79 | if ( $this->field->args( 'taxonomy' ) ) { |
||
| 80 | wp_set_object_terms( $this->field->object_id, $this->value, $this->field->args( 'taxonomy' ) ); |
||
| 81 | } else { |
||
| 82 | cmb2_utils()->log_if_debug( __METHOD__, __LINE__, "{$this->field->type()} {$this->field->_id()} is missing the 'taxonomy' parameter." ); |
||
| 83 | } |
||
| 84 | break; |
||
| 85 | 8 | case 'multicheck': |
|
| 86 | 8 | case 'multicheck_inline': |
|
| 87 | 8 | case 'file_list': |
|
| 88 | 8 | case 'group': |
|
| 89 | // no filtering |
||
| 90 | 2 | $sanitized_value = $this->value; |
|
| 91 | 2 | break; |
|
| 92 | 7 | default: |
|
| 93 | // Handle repeatable fields array |
||
| 94 | // We'll fallback to 'sanitize_text_field' |
||
| 95 | 7 | $sanitized_value = is_array( $this->value ) ? array_map( 'sanitize_text_field', $this->value ) : sanitize_text_field( $this->value ); |
|
| 96 | 7 | break; |
|
| 97 | 8 | } |
|
| 98 | |||
| 99 | 8 | return $this->_is_empty_array( $sanitized_value ) ? '' : $sanitized_value; |
|
| 100 | } |
||
| 101 | |||
| 102 | /** |
||
| 103 | * Simple checkbox validation |
||
| 104 | * @since 1.0.1 |
||
| 105 | * @return string|false 'on' or false |
||
| 106 | */ |
||
| 107 | public function checkbox() { |
||
| 110 | |||
| 111 | /** |
||
| 112 | * Validate url in a meta value |
||
| 113 | * @since 1.0.1 |
||
| 114 | * @return string Empty string or escaped url |
||
| 115 | */ |
||
| 116 | 1 | public function text_url() { |
|
| 117 | 1 | $protocols = $this->field->args( 'protocols' ); |
|
| 118 | // for repeatable |
||
| 119 | 1 | if ( is_array( $this->value ) ) { |
|
| 120 | foreach ( $this->value as $key => $val ) { |
||
| 121 | $this->value[ $key ] = $val ? esc_url_raw( $val, $protocols ) : $this->field->get_default(); |
||
| 122 | } |
||
| 123 | } else { |
||
| 124 | 1 | $this->value = $this->value ? esc_url_raw( $this->value, $protocols ) : $this->field->get_default(); |
|
| 125 | } |
||
| 126 | |||
| 127 | 1 | return $this->value; |
|
| 128 | } |
||
| 129 | |||
| 130 | public function colorpicker() { |
||
| 131 | // for repeatable |
||
| 132 | if ( is_array( $this->value ) ) { |
||
| 133 | $check = $this->value; |
||
| 134 | $this->value = array(); |
||
| 135 | foreach ( $check as $key => $val ) { |
||
| 136 | if ( $val && '#' != $val ) { |
||
| 137 | $this->value[ $key ] = esc_attr( $val ); |
||
| 138 | } |
||
| 139 | } |
||
| 140 | } else { |
||
| 141 | $this->value = ! $this->value || '#' == $this->value ? '' : esc_attr( $this->value ); |
||
| 142 | } |
||
| 143 | return $this->value; |
||
| 144 | } |
||
| 145 | |||
| 146 | /** |
||
| 147 | * Validate email in a meta value |
||
| 148 | * @since 1.0.1 |
||
| 149 | * @return string Empty string or sanitized email |
||
| 150 | */ |
||
| 151 | public function text_email() { |
||
| 152 | // for repeatable |
||
| 153 | if ( is_array( $this->value ) ) { |
||
| 154 | foreach ( $this->value as $key => $val ) { |
||
| 155 | $val = trim( $val ); |
||
| 156 | $this->value[ $key ] = is_email( $val ) ? $val : ''; |
||
| 157 | } |
||
| 158 | } else { |
||
| 159 | $this->value = trim( $this->value ); |
||
| 160 | $this->value = is_email( $this->value ) ? $this->value : ''; |
||
| 161 | } |
||
| 162 | |||
| 163 | return $this->value; |
||
| 164 | } |
||
| 165 | |||
| 166 | /** |
||
| 167 | * Validate money in a meta value |
||
| 168 | * @since 1.0.1 |
||
| 169 | * @return string Empty string or sanitized money value |
||
| 170 | */ |
||
| 171 | public function text_money() { |
||
| 172 | |||
| 173 | global $wp_locale; |
||
| 174 | |||
| 175 | $search = array( $wp_locale->number_format['thousands_sep'], $wp_locale->number_format['decimal_point'] ); |
||
| 176 | $replace = array( '', '.' ); |
||
| 177 | |||
| 178 | // for repeatable |
||
| 179 | if ( is_array( $this->value ) ) { |
||
| 180 | foreach ( $this->value as $key => $val ) { |
||
| 181 | $this->value[ $key ] = number_format_i18n( (float) str_ireplace( $search, $replace, $val ), 2 ); |
||
| 182 | } |
||
| 183 | } else { |
||
| 184 | $this->value = number_format_i18n( (float) str_ireplace( $search, $replace, $this->value ), 2 ); |
||
| 185 | } |
||
| 186 | |||
| 187 | return $this->value; |
||
| 188 | } |
||
| 189 | |||
| 190 | /** |
||
| 191 | * Converts text date to timestamp |
||
| 192 | * @since 1.0.2 |
||
| 193 | * @return string Timestring |
||
| 194 | */ |
||
| 195 | public function text_date_timestamp() { |
||
| 196 | return is_array( $this->value ) |
||
| 197 | ? array_map( array( $this->field, 'get_timestamp_from_value' ), $this->value ) |
||
| 198 | : $this->field->get_timestamp_from_value( $this->value ); |
||
| 199 | } |
||
| 200 | |||
| 201 | /** |
||
| 202 | * Datetime to timestamp |
||
| 203 | * @since 1.0.1 |
||
| 204 | * @return string Timestring |
||
| 205 | */ |
||
| 206 | public function text_datetime_timestamp( $repeat = false ) { |
||
| 207 | |||
| 208 | $test = is_array( $this->value ) ? array_filter( $this->value ) : ''; |
||
| 209 | if ( empty( $test ) ) { |
||
| 210 | return ''; |
||
| 211 | } |
||
| 212 | |||
| 213 | $repeat_value = $this->_check_repeat( __FUNCTION__, $repeat ); |
||
| 214 | if ( false !== $repeat_value ) { |
||
| 215 | return $repeat_value; |
||
| 216 | } |
||
| 217 | |||
| 218 | if ( isset( $this->value['date'], $this->value['time'] ) ) { |
||
| 219 | $this->value = $this->field->get_timestamp_from_value( $this->value['date'] . ' ' . $this->value['time'] ); |
||
| 220 | } |
||
| 221 | |||
| 222 | if ( $tz_offset = $this->field->field_timezone_offset() ) { |
||
| 223 | $this->value += (int) $tz_offset; |
||
| 224 | } |
||
| 225 | |||
| 226 | return $this->value; |
||
| 227 | } |
||
| 228 | |||
| 229 | /** |
||
| 230 | * Datetime to timestamp with timezone |
||
| 231 | * @since 1.0.1 |
||
| 232 | * @return string Timestring |
||
| 233 | */ |
||
| 234 | 1 | public function text_datetime_timestamp_timezone( $repeat = false ) { |
|
| 235 | 1 | static $utc_values = array(); |
|
| 236 | |||
| 237 | 1 | $test = is_array( $this->value ) ? array_filter( $this->value ) : ''; |
|
| 238 | 1 | if ( empty( $test ) ) { |
|
| 239 | 1 | return ''; |
|
| 240 | } |
||
| 241 | |||
| 242 | 1 | $utc_key = $this->field->_id() . '_utc'; |
|
| 243 | |||
| 244 | 1 | $repeat_value = $this->_check_repeat( __FUNCTION__, $repeat ); |
|
| 245 | 1 | if ( false !== $repeat_value ) { |
|
| 246 | 1 | if ( ! empty( $utc_values[ $utc_key ] ) ) { |
|
| 247 | $this->_save_utc_value( $utc_key, $utc_values[ $utc_key ] ); |
||
| 248 | unset( $utc_values[ $utc_key ] ); |
||
| 249 | } |
||
| 250 | |||
| 251 | 1 | return $repeat_value; |
|
| 252 | } |
||
| 253 | |||
| 254 | 1 | $tzstring = null; |
|
| 255 | |||
| 256 | 1 | if ( is_array( $this->value ) && array_key_exists( 'timezone', $this->value ) ) { |
|
| 257 | 1 | $tzstring = $this->value['timezone']; |
|
| 258 | 1 | } |
|
| 259 | |||
| 260 | 1 | if ( empty( $tzstring ) ) { |
|
| 261 | $tzstring = cmb2_utils()->timezone_string(); |
||
| 262 | } |
||
| 263 | |||
| 264 | 1 | $offset = cmb2_utils()->timezone_offset( $tzstring ); |
|
| 265 | |||
| 266 | 1 | if ( 'UTC' === substr( $tzstring, 0, 3 ) ) { |
|
| 267 | $tzstring = timezone_name_from_abbr( '', $offset, 0 ); |
||
| 268 | /* |
||
| 269 | * timezone_name_from_abbr() returns false if not found based on offset. |
||
| 270 | * Since there are currently some invalid timezones in wp_timezone_dropdown(), |
||
| 271 | * fallback to an offset of 0 (UTC+0) |
||
| 272 | * https://core.trac.wordpress.org/ticket/29205 |
||
| 273 | */ |
||
| 274 | $tzstring = false !== $tzstring ? $tzstring : timezone_name_from_abbr( '', 0, 0 ); |
||
| 275 | } |
||
| 276 | |||
| 277 | 1 | $full_format = $this->field->args['date_format'] . ' ' . $this->field->args['time_format']; |
|
| 278 | 1 | $full_date = $this->value['date'] . ' ' . $this->value['time']; |
|
| 279 | |||
| 280 | try { |
||
| 281 | |||
| 282 | 1 | $datetime = date_create_from_format( $full_format, $full_date ); |
|
| 283 | |||
| 284 | 1 | if ( ! is_object( $datetime ) ) { |
|
| 285 | $this->value = $utc_stamp = ''; |
||
| 286 | } else { |
||
| 287 | 1 | $timestamp = $datetime->setTimezone( new DateTimeZone( $tzstring ) )->getTimestamp(); |
|
| 288 | 1 | $utc_stamp = $timestamp - $offset; |
|
| 289 | 1 | $this->value = serialize( $datetime ); |
|
| 290 | } |
||
| 291 | |||
| 292 | 1 | if ( $this->field->group ) { |
|
| 293 | 1 | $this->value = array( |
|
| 294 | 1 | 'supporting_field_value' => $utc_stamp, |
|
| 295 | 1 | 'supporting_field_id' => $utc_key, |
|
| 296 | 1 | 'value' => $this->value, |
|
| 297 | ); |
||
| 298 | 1 | } else { |
|
| 299 | // Save the utc timestamp supporting field |
||
| 300 | if ( $repeat ) { |
||
| 301 | $utc_values[ $utc_key ][] = $utc_stamp; |
||
| 302 | } else { |
||
| 303 | $this->_save_utc_value( $utc_key, $utc_stamp ); |
||
| 304 | } |
||
| 305 | } |
||
| 306 | |||
| 307 | 1 | } catch ( Exception $e ) { |
|
| 308 | $this->value = ''; |
||
| 309 | cmb2_utils()->log_if_debug( __METHOD__, __LINE__, $e->getMessage() ); |
||
| 310 | } |
||
| 311 | |||
| 312 | 1 | return $this->value; |
|
| 313 | } |
||
| 314 | |||
| 315 | /** |
||
| 316 | * Sanitize textareas and wysiwyg fields |
||
| 317 | * @since 1.0.1 |
||
| 318 | * @return string Sanitized data |
||
| 319 | */ |
||
| 320 | 2 | public function textarea() { |
|
| 323 | |||
| 324 | /** |
||
| 325 | * Sanitize code textareas |
||
| 326 | * @since 1.0.2 |
||
| 327 | * @return string Sanitized data |
||
| 328 | */ |
||
| 329 | public function textarea_code( $repeat = false ) { |
||
| 330 | $repeat_value = $this->_check_repeat( __FUNCTION__, $repeat ); |
||
| 331 | if ( false !== $repeat_value ) { |
||
| 332 | return $repeat_value; |
||
| 333 | } |
||
| 334 | |||
| 335 | return htmlspecialchars_decode( stripslashes( $this->value ) ); |
||
| 336 | } |
||
| 337 | |||
| 338 | /** |
||
| 339 | * Handles saving of attachment post ID and sanitizing file url |
||
| 340 | * @since 1.1.0 |
||
| 341 | * @return string Sanitized url |
||
| 342 | */ |
||
| 343 | 1 | public function file() { |
|
| 344 | 1 | $file_id_key = $this->field->_id() . '_id'; |
|
| 345 | |||
| 346 | 1 | if ( $this->field->group ) { |
|
| 347 | // Return an array with url/id if saving a group field |
||
| 348 | 1 | $this->value = $this->_get_group_file_value_array( $file_id_key ); |
|
| 349 | 1 | } else { |
|
| 350 | $this->_save_file_id_value( $file_id_key ); |
||
| 351 | $this->text_url(); |
||
| 352 | } |
||
| 353 | |||
| 354 | 1 | return $this->value; |
|
| 355 | } |
||
| 356 | |||
| 357 | /** |
||
| 358 | * Gets the values for the `file` field type from the data being saved. |
||
| 359 | * @since 2.2.0 |
||
| 360 | */ |
||
| 361 | 1 | public function _get_group_file_value_array( $id_key ) { |
|
| 362 | 1 | $alldata = $this->field->group->data_to_save; |
|
| 363 | 1 | $base_id = $this->field->group->_id(); |
|
| 364 | 1 | $i = $this->field->group->index; |
|
| 365 | |||
| 366 | // Check group $alldata data |
||
| 367 | 1 | $id_val = isset( $alldata[ $base_id ][ $i ][ $id_key ] ) |
|
| 368 | 1 | ? absint( $alldata[ $base_id ][ $i ][ $id_key ] ) |
|
| 369 | 1 | : 0; |
|
| 370 | |||
| 371 | return array( |
||
| 372 | 1 | 'value' => $this->text_url(), |
|
| 373 | 1 | 'supporting_field_value' => $id_val, |
|
| 374 | 1 | 'supporting_field_id' => $id_key, |
|
| 375 | 1 | ); |
|
| 376 | } |
||
| 377 | |||
| 378 | /** |
||
| 379 | * Peforms saving of `file` attachement's ID |
||
| 380 | * @since 1.1.0 |
||
| 381 | */ |
||
| 382 | public function _save_file_id_value( $file_id_key ) { |
||
| 397 | |||
| 398 | /** |
||
| 399 | * Peforms saving of `text_datetime_timestamp_timezone` utc timestamp |
||
| 400 | * @since 2.2.0 |
||
| 401 | */ |
||
| 402 | public function _save_utc_value( $utc_key, $utc_stamp ) { |
||
| 405 | |||
| 406 | /** |
||
| 407 | * Returns a new, supporting, CMB2_Field object based on a new field id. |
||
| 408 | * @since 2.2.0 |
||
| 409 | */ |
||
| 410 | public function _new_supporting_field( $new_field_id ) { |
||
| 411 | return $this->field->get_field_clone( array( |
||
| 412 | 'id' => $new_field_id, |
||
| 413 | 'sanitization_cb' => false, |
||
| 414 | ) ); |
||
| 415 | } |
||
| 416 | |||
| 417 | /** |
||
| 418 | * If repeating, loop through and re-apply sanitization method |
||
| 419 | * @since 1.1.0 |
||
| 420 | * @param string $method Class method |
||
| 421 | * @param bool $repeat Whether repeating or not |
||
| 422 | * @return mixed Sanitized value |
||
| 423 | */ |
||
| 424 | 1 | public function _check_repeat( $method, $repeat ) { |
|
| 445 | |||
| 446 | /** |
||
| 447 | * Determine if passed value is an empty array |
||
| 448 | * @since 2.0.6 |
||
| 449 | * @param mixed $to_check Value to check |
||
| 450 | * @return boolean Whether value is an array that's empty |
||
| 451 | */ |
||
| 452 | 8 | public function _is_empty_array( $to_check ) { |
|
| 459 | |||
| 460 | } |
||
| 461 |
Loading history...
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.