Strategy11 /
formidable-forms
Complex classes like FrmEntry 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 FrmEntry, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 6 | class FrmEntry { |
||
| 7 | |||
| 8 | /** |
||
| 9 | * Create a new entry |
||
| 10 | * |
||
| 11 | * @param array $values |
||
| 12 | * @return int | boolean $entry_id |
||
| 13 | */ |
||
| 14 | public static function create( $values ) { |
||
| 19 | |||
| 20 | /** |
||
| 21 | * Create a new entry with some differences depending on type |
||
| 22 | * |
||
| 23 | * @param array $values |
||
| 24 | * @param string $type |
||
| 25 | * @return int | boolean $entry_id |
||
| 26 | */ |
||
| 27 | private static function create_entry( $values, $type ) { |
||
| 39 | |||
| 40 | /** |
||
| 41 | * check for duplicate entries created in the last minute |
||
| 42 | * @return boolean |
||
| 43 | */ |
||
| 44 | public static function is_duplicate( $new_values, $values ) { |
||
| 100 | |||
| 101 | /** |
||
| 102 | * Determine if an entry needs to be checked as a possible duplicate |
||
| 103 | * |
||
| 104 | * @since 2.0.23 |
||
| 105 | * @param array $values |
||
| 106 | * @param int $duplicate_entry_time |
||
| 107 | * @return bool |
||
| 108 | */ |
||
| 109 | private static function is_duplicate_check_needed( $values, $duplicate_entry_time ) { |
||
| 127 | |||
| 128 | public static function duplicate( $id ) { |
||
| 129 | global $wpdb; |
||
| 130 | |||
| 131 | $values = self::getOne( $id ); |
||
| 132 | |||
| 133 | $new_values = array(); |
||
| 134 | $new_values['item_key'] = FrmAppHelper::get_unique_key( '', $wpdb->prefix . 'frm_items', 'item_key' ); |
||
| 135 | $new_values['name'] = $values->name; |
||
| 136 | $new_values['is_draft'] = $values->is_draft; |
||
| 137 | $new_values['user_id'] = (int) $values->user_id; |
||
| 138 | $new_values['updated_by'] = (int) $values->user_id; |
||
| 139 | $new_values['form_id'] = $values->form_id ? (int) $values->form_id: null; |
||
| 140 | $new_values['created_at'] = current_time( 'mysql', 1 ); |
||
| 141 | $new_values['updated_at'] = $new_values['created_at']; |
||
| 142 | |||
| 143 | $query_results = $wpdb->insert( $wpdb->prefix . 'frm_items', $new_values ); |
||
| 144 | if ( ! $query_results ) { |
||
| 145 | return false; |
||
| 146 | } |
||
| 147 | |||
| 148 | $entry_id = $wpdb->insert_id; |
||
| 149 | |||
| 150 | global $frm_vars; |
||
| 151 | if ( ! isset($frm_vars['saved_entries']) ) { |
||
| 152 | $frm_vars['saved_entries'] = array(); |
||
| 153 | } |
||
| 154 | $frm_vars['saved_entries'][] = (int) $entry_id; |
||
| 155 | |||
| 156 | FrmEntryMeta::duplicate_entry_metas($id, $entry_id); |
||
| 157 | self::clear_cache(); |
||
| 158 | |||
| 159 | do_action( 'frm_after_duplicate_entry', $entry_id, $new_values['form_id'], array( 'old_id' => $id ) ); |
||
| 160 | return $entry_id; |
||
| 161 | } |
||
| 162 | |||
| 163 | /** |
||
| 164 | * Update an entry (not via XML) |
||
| 165 | * |
||
| 166 | * @param int $id |
||
| 167 | * @param array $values |
||
| 168 | * @return boolean|int $update_results |
||
| 169 | */ |
||
| 170 | public static function update( $id, $values ) { |
||
| 171 | $update_results = self::update_entry( $id, $values, 'standard' ); |
||
| 172 | |||
| 173 | return $update_results; |
||
| 174 | } |
||
| 175 | |||
| 176 | /** |
||
| 177 | * Update an entry with some differences depending on the update type |
||
| 178 | * |
||
| 179 | * @since 2.0.16 |
||
| 180 | * |
||
| 181 | * @param int $id |
||
| 182 | * @param array $values |
||
| 183 | * @return boolean|int $query_results |
||
| 184 | */ |
||
| 185 | private static function update_entry( $id, $values, $update_type ) { |
||
| 186 | global $wpdb; |
||
| 187 | |||
| 188 | $update = self::before_update_entry( $id, $values, $update_type ); |
||
| 189 | if ( ! $update ) { |
||
| 190 | return false; |
||
| 191 | } |
||
| 192 | |||
| 193 | $new_values = self::package_entry_to_update( $id, $values ); |
||
| 194 | |||
| 195 | $query_results = $wpdb->update( $wpdb->prefix . 'frm_items', $new_values, compact('id') ); |
||
| 196 | |||
| 197 | self::after_update_entry( $query_results, $id, $values, $new_values ); |
||
| 198 | |||
| 199 | return $query_results; |
||
| 200 | } |
||
| 201 | |||
| 202 | public static function destroy( $id ) { |
||
| 203 | global $wpdb; |
||
| 204 | $id = (int) $id; |
||
| 205 | |||
| 206 | $entry = self::getOne( $id ); |
||
| 207 | if ( ! $entry ) { |
||
| 208 | $result = false; |
||
| 209 | return $result; |
||
| 210 | } |
||
| 211 | |||
| 212 | do_action('frm_before_destroy_entry', $id, $entry); |
||
| 213 | |||
| 214 | $wpdb->query( $wpdb->prepare( 'DELETE FROM ' . $wpdb->prefix . 'frm_item_metas WHERE item_id=%d', $id ) ); |
||
| 215 | $result = $wpdb->query( $wpdb->prepare( 'DELETE FROM ' . $wpdb->prefix . 'frm_items WHERE id=%d', $id ) ); |
||
| 216 | |||
| 217 | self::clear_cache(); |
||
| 218 | |||
| 219 | return $result; |
||
| 220 | } |
||
| 221 | |||
| 222 | public static function update_form( $id, $value, $form_id ) { |
||
| 223 | global $wpdb; |
||
| 224 | $form_id = isset($value) ? $form_id : null; |
||
| 225 | $result = $wpdb->update( $wpdb->prefix . 'frm_items', array( 'form_id' => $form_id ), array( 'id' => $id ) ); |
||
| 226 | if ( $result ) { |
||
| 227 | self::clear_cache(); |
||
| 228 | } |
||
| 229 | return $result; |
||
| 230 | } |
||
| 231 | |||
| 232 | /** |
||
| 233 | * Clear entry caching |
||
| 234 | * Called when an entry is changed |
||
| 235 | * |
||
| 236 | * @since 2.0.5 |
||
| 237 | */ |
||
| 238 | public static function clear_cache() { |
||
| 239 | FrmAppHelper::cache_delete_group( 'frm_entry' ); |
||
| 240 | FrmAppHelper::cache_delete_group( 'frm_item' ); |
||
| 241 | FrmAppHelper::cache_delete_group( 'frm_entry_meta' ); |
||
| 242 | FrmAppHelper::cache_delete_group( 'frm_item_meta' ); |
||
| 243 | } |
||
| 244 | |||
| 245 | /** |
||
| 246 | * After switching to the wp_loaded hook for processing entries, |
||
| 247 | * we can no longer use 'name', but check it as a fallback |
||
| 248 | * @since 2.0.11 |
||
| 249 | */ |
||
| 250 | public static function get_new_entry_name( $values, $default = '' ) { |
||
| 251 | return isset( $values['item_name'] ) ? $values['item_name'] : ( isset( $values['name'] ) ? $values['name'] : $default ); |
||
| 252 | } |
||
| 253 | |||
| 254 | /** |
||
| 255 | * If $entry is numeric, get the entry object |
||
| 256 | * @param int|object $entry by reference |
||
| 257 | * @since 2.0.9 |
||
| 258 | */ |
||
| 259 | public static function maybe_get_entry( &$entry ) { |
||
| 260 | if ( $entry && is_numeric( $entry ) ) { |
||
| 261 | $entry = self::getOne( $entry ); |
||
| 262 | } |
||
| 263 | } |
||
| 264 | |||
| 265 | public static function getOne( $id, $meta = false ) { |
||
| 266 | global $wpdb; |
||
| 267 | |||
| 268 | $query = "SELECT it.*, fr.name as form_name, fr.form_key as form_key FROM {$wpdb->prefix}frm_items it |
||
| 269 | LEFT OUTER JOIN {$wpdb->prefix}frm_forms fr ON it.form_id=fr.id WHERE "; |
||
| 270 | |||
| 271 | $query .= is_numeric($id) ? 'it.id=%d' : 'it.item_key=%s'; |
||
| 272 | $query_args = array( $id ); |
||
| 273 | $query = $wpdb->prepare( $query, $query_args ); |
||
| 274 | |||
| 275 | if ( ! $meta ) { |
||
| 276 | $entry = FrmAppHelper::check_cache( $id . '_nometa', 'frm_entry', $query, 'get_row' ); |
||
| 277 | return stripslashes_deep($entry); |
||
| 278 | } |
||
| 279 | |||
| 280 | $entry = FrmAppHelper::check_cache( $id, 'frm_entry' ); |
||
| 281 | if ( $entry !== false ) { |
||
| 282 | return stripslashes_deep($entry); |
||
| 283 | } |
||
| 284 | |||
| 285 | $entry = $wpdb->get_row( $query ); |
||
| 286 | $entry = self::get_meta($entry); |
||
| 287 | |||
| 288 | return stripslashes_deep($entry); |
||
| 289 | } |
||
| 290 | |||
| 291 | public static function get_meta( $entry ) { |
||
| 292 | if ( ! $entry ) { |
||
| 293 | return $entry; |
||
| 294 | } |
||
| 295 | |||
| 296 | global $wpdb; |
||
| 297 | $metas = FrmDb::get_results( $wpdb->prefix . 'frm_item_metas m LEFT JOIN ' . $wpdb->prefix . 'frm_fields f ON m.field_id=f.id', array( 'item_id' => $entry->id, 'field_id !' => 0 ), 'field_id, meta_value, field_key, item_id' ); |
||
| 298 | |||
| 299 | $entry->metas = array(); |
||
| 300 | |||
| 301 | $include_key = apply_filters( 'frm_include_meta_keys', false, array( 'form_id' => $entry->form_id ) ); |
||
| 302 | foreach ( $metas as $meta_val ) { |
||
| 303 | if ( $meta_val->item_id == $entry->id ) { |
||
| 304 | $entry->metas[ $meta_val->field_id ] = maybe_unserialize( $meta_val->meta_value ); |
||
| 305 | if ( $include_key ) { |
||
| 306 | $entry->metas[ $meta_val->field_key ] = $entry->metas[ $meta_val->field_id ]; |
||
| 307 | } |
||
| 308 | continue; |
||
| 309 | } |
||
| 310 | |||
| 311 | // include sub entries in an array |
||
| 312 | if ( ! isset( $entry_metas[ $meta_val->field_id ] ) ) { |
||
| 313 | $entry->metas[ $meta_val->field_id ] = array(); |
||
| 314 | } |
||
| 315 | |||
| 316 | $entry->metas[ $meta_val->field_id ][] = maybe_unserialize( $meta_val->meta_value ); |
||
| 317 | |||
| 318 | unset($meta_val); |
||
| 319 | } |
||
| 320 | unset($metas); |
||
| 321 | |||
| 322 | FrmAppHelper::set_cache( $entry->id, $entry, 'frm_entry' ); |
||
| 323 | |||
| 324 | return $entry; |
||
| 325 | } |
||
| 326 | |||
| 327 | /** |
||
| 328 | * @param string $id |
||
| 329 | */ |
||
| 330 | public static function exists( $id ) { |
||
| 331 | global $wpdb; |
||
| 332 | |||
| 333 | if ( FrmAppHelper::check_cache( $id, 'frm_entry' ) ) { |
||
| 334 | $exists = true; |
||
| 335 | return $exists; |
||
| 336 | } |
||
| 337 | |||
| 338 | if ( is_numeric($id) ) { |
||
| 339 | $where = array( 'id' => $id ); |
||
| 340 | } else { |
||
| 341 | $where = array( 'item_key' => $id ); |
||
| 342 | } |
||
| 343 | $id = FrmDb::get_var( $wpdb->prefix . 'frm_items', $where ); |
||
| 344 | |||
| 345 | $exists = ($id && $id > 0) ? true : false; |
||
| 346 | return $exists; |
||
| 347 | } |
||
| 348 | |||
| 349 | public static function getAll( $where, $order_by = '', $limit = '', $meta = false, $inc_form = true ) { |
||
| 350 | global $wpdb; |
||
| 351 | |||
| 352 | $limit = FrmAppHelper::esc_limit($limit); |
||
| 353 | |||
| 354 | $cache_key = maybe_serialize($where) . $order_by . $limit . $inc_form; |
||
| 355 | $entries = wp_cache_get($cache_key, 'frm_entry'); |
||
| 356 | |||
| 357 | if ( false === $entries ) { |
||
| 358 | $fields = 'it.id, it.item_key, it.name, it.ip, it.form_id, it.post_id, it.user_id, it.parent_item_id, it.updated_by, it.created_at, it.updated_at, it.is_draft'; |
||
| 359 | $table = $wpdb->prefix . 'frm_items it '; |
||
| 360 | |||
| 361 | if ( $inc_form ) { |
||
| 362 | $fields = 'it.*, fr.name as form_name,fr.form_key as form_key'; |
||
| 363 | $table .= 'LEFT OUTER JOIN ' . $wpdb->prefix . 'frm_forms fr ON it.form_id=fr.id '; |
||
| 364 | } |
||
| 365 | |||
| 366 | if ( preg_match( '/ meta_([0-9]+)/', $order_by, $order_matches ) ) { |
||
| 367 | // sort by a requested field |
||
| 368 | $field_id = (int) $order_matches[1]; |
||
| 369 | $fields .= ', (SELECT meta_value FROM ' . $wpdb->prefix . 'frm_item_metas WHERE field_id = ' . $field_id . ' AND item_id = it.id) as meta_' . $field_id; |
||
| 370 | unset( $order_matches, $field_id ); |
||
| 371 | } |
||
| 372 | |||
| 373 | // prepare the query |
||
| 374 | $query = 'SELECT ' . $fields . ' FROM ' . $table . FrmAppHelper::prepend_and_or_where(' WHERE ', $where) . $order_by . $limit; |
||
| 375 | |||
| 376 | $entries = $wpdb->get_results($query, OBJECT_K); |
||
| 377 | unset($query); |
||
| 378 | |||
| 379 | FrmAppHelper::set_cache( $cache_key, $entries, 'frm_entry' ); |
||
| 380 | } |
||
| 381 | |||
| 382 | if ( ! $meta || ! $entries ) { |
||
| 383 | return stripslashes_deep($entries); |
||
| 384 | } |
||
| 385 | unset($meta); |
||
| 386 | |||
| 387 | if ( ! is_array( $where ) && preg_match('/^it\.form_id=\d+$/', $where) ) { |
||
| 388 | $where = array( 'it.form_id' => substr( $where, 11 ) ); |
||
| 389 | } |
||
| 390 | |||
| 391 | $meta_where = array( 'field_id !' => 0 ); |
||
| 392 | if ( $limit == '' && is_array($where) && count($where) == 1 && isset($where['it.form_id']) ) { |
||
| 393 | $meta_where['fi.form_id'] = $where['it.form_id']; |
||
| 394 | } else { |
||
| 395 | $meta_where['item_id'] = array_keys( $entries ); |
||
| 396 | } |
||
| 397 | |||
| 398 | $metas = FrmDb::get_results( $wpdb->prefix . 'frm_item_metas it LEFT OUTER JOIN ' . $wpdb->prefix . 'frm_fields fi ON (it.field_id = fi.id)', $meta_where, 'item_id, meta_value, field_id, field_key, form_id' ); |
||
| 399 | |||
| 400 | unset( $meta_where ); |
||
| 401 | |||
| 402 | if ( ! $metas ) { |
||
| 403 | return stripslashes_deep($entries); |
||
| 404 | } |
||
| 405 | |||
| 406 | foreach ( $metas as $m_key => $meta_val ) { |
||
| 407 | if ( ! isset( $entries[ $meta_val->item_id ] ) ) { |
||
| 408 | continue; |
||
| 409 | } |
||
| 410 | |||
| 411 | if ( ! isset( $entries[ $meta_val->item_id ]->metas ) ) { |
||
| 412 | $entries[ $meta_val->item_id ]->metas = array(); |
||
| 413 | } |
||
| 414 | |||
| 415 | $entries[ $meta_val->item_id ]->metas[ $meta_val->field_id ] = maybe_unserialize( $meta_val->meta_value ); |
||
| 416 | |||
| 417 | unset($m_key, $meta_val); |
||
| 418 | } |
||
| 419 | |||
| 420 | if ( ! FrmAppHelper::prevent_caching() ) { |
||
| 421 | foreach ( $entries as $entry ) { |
||
| 422 | FrmAppHelper::set_cache( $entry->id, $entry, 'frm_entry' ); |
||
| 423 | unset( $entry ); |
||
| 424 | } |
||
| 425 | } |
||
| 426 | |||
| 427 | return stripslashes_deep($entries); |
||
| 428 | } |
||
| 429 | |||
| 430 | // Pagination Methods |
||
| 431 | public static function getRecordCount( $where = '' ) { |
||
| 450 | |||
| 451 | public static function getPageCount( $p_size, $where = '' ) { |
||
| 452 | $p_size = (int) $p_size; |
||
| 453 | $count = 1; |
||
| 454 | if ( $p_size ) { |
||
| 455 | if ( ! is_numeric( $where ) ) { |
||
| 456 | $where = self::getRecordCount( $where ); |
||
| 457 | } |
||
| 458 | $count = ceil( (int) $where / $p_size ); |
||
| 459 | } |
||
| 460 | |||
| 461 | return $count; |
||
| 462 | } |
||
| 463 | |||
| 464 | /** |
||
| 465 | * Prepare the data before inserting it into the database |
||
| 466 | * |
||
| 467 | * @since 2.0.16 |
||
| 468 | * @param array $values |
||
| 469 | * @param string $type |
||
| 470 | * @return array $new_values |
||
| 471 | */ |
||
| 472 | private static function before_insert_entry_in_database( &$values, $type ) { |
||
| 484 | |||
| 485 | /** |
||
| 486 | * Create an entry and perform after create actions |
||
| 487 | * |
||
| 488 | * @since 2.0.16 |
||
| 489 | * @param array $values |
||
| 490 | * @param array $new_values |
||
| 491 | * @return boolean|int $entry_id |
||
| 492 | */ |
||
| 493 | private static function continue_to_create_entry( $values, $new_values ) { |
||
| 503 | |||
| 504 | /** |
||
| 505 | * Sanitize the POST values before we use them |
||
| 506 | * |
||
| 507 | * @since 2.0 |
||
| 508 | * @param array $values The POST values by reference |
||
| 509 | */ |
||
| 510 | public static function sanitize_entry_post( &$values ) { |
||
| 527 | |||
| 528 | /** |
||
| 529 | * Prepare the new values for inserting into the database |
||
| 530 | * |
||
| 531 | * @since 2.0.16 |
||
| 532 | * @param array $values |
||
| 533 | * @return array $new_values |
||
| 534 | */ |
||
| 535 | private static function package_entry_data( &$values ) { |
||
| 565 | |||
| 566 | /** |
||
| 567 | * Get the ip for a new entry. |
||
| 568 | * Allow the import to override the value. |
||
| 569 | * |
||
| 570 | * @since 2.03.10 |
||
| 571 | * @param array $values |
||
| 572 | * @return string |
||
| 573 | */ |
||
| 574 | private static function get_ip( $values ) { |
||
| 575 | $ip = FrmAppHelper::get_ip_address(); |
||
| 576 | if ( defined('WP_IMPORTING') && WP_IMPORTING ) { |
||
| 577 | $ip = isset( $values['ip'] ) ? $values['ip'] : $ip; |
||
| 578 | } |
||
| 581 | |||
| 582 | /** |
||
| 583 | * Get the is_draft value for a new entry |
||
| 584 | * |
||
| 585 | * @since 2.0.16 |
||
| 586 | * @param array $values |
||
| 587 | * @return int |
||
| 588 | */ |
||
| 589 | private static function get_is_draft_value( $values ) { |
||
| 592 | |||
| 593 | /** |
||
| 594 | * Get the form_id value for a new entry |
||
| 595 | * |
||
| 596 | * @since 2.0.16 |
||
| 597 | * @param array $values |
||
| 598 | * @return int|null |
||
| 599 | */ |
||
| 600 | private static function get_form_id( $values ) { |
||
| 603 | |||
| 604 | /** |
||
| 605 | * Get the post_id value for a new entry |
||
| 606 | * |
||
| 607 | * @since 2.0.16 |
||
| 608 | * @param array $values |
||
| 609 | * @return int |
||
| 610 | */ |
||
| 611 | private static function get_post_id( $values ) { |
||
| 614 | |||
| 615 | /** |
||
| 616 | * Get the parent_item_id value for a new entry |
||
| 617 | * |
||
| 618 | * @since 2.0.16 |
||
| 619 | * @param array $values |
||
| 620 | * @return int |
||
| 621 | */ |
||
| 622 | private static function get_parent_item_id( $values ) { |
||
| 625 | |||
| 626 | /** |
||
| 627 | * Get the created_at value for a new entry |
||
| 628 | * |
||
| 629 | * @since 2.0.16 |
||
| 630 | * @param array $values |
||
| 631 | * @return string |
||
| 632 | */ |
||
| 633 | private static function get_created_at( $values ) { |
||
| 636 | |||
| 637 | /** |
||
| 638 | * Get the updated_at value for a new entry |
||
| 639 | * |
||
| 640 | * @since 2.0.16 |
||
| 641 | * @param array $values |
||
| 642 | * @return string |
||
| 643 | */ |
||
| 644 | private static function get_updated_at( $values ) { |
||
| 653 | |||
| 654 | /** |
||
| 655 | * Get the description value for a new entry |
||
| 656 | * |
||
| 657 | * @since 2.0.16 |
||
| 658 | * @param array $values |
||
| 659 | * @return string |
||
| 660 | */ |
||
| 661 | private static function get_entry_description( $values ) { |
||
| 673 | |||
| 674 | /** |
||
| 675 | * Get the user_id value for a new entry |
||
| 676 | * |
||
| 677 | * @since 2.0.16 |
||
| 678 | * @param array $values |
||
| 679 | * @return int |
||
| 680 | */ |
||
| 681 | private static function get_entry_user_id( $values ) { |
||
| 691 | |||
| 692 | /** |
||
| 693 | * Insert new entry into the database |
||
| 694 | * |
||
| 695 | * @since 2.0.16 |
||
| 696 | * @param array $new_values |
||
| 697 | * @return int | boolean $entry_id |
||
| 698 | */ |
||
| 699 | private static function insert_entry_into_database( $new_values ) { |
||
| 712 | |||
| 713 | /** |
||
| 714 | * Add the new entry to global $frm_vars |
||
| 715 | * |
||
| 716 | * @since 2.0.16 |
||
| 717 | * @param int $entry_id |
||
| 718 | */ |
||
| 719 | private static function add_new_entry_to_frm_vars( $entry_id ) { |
||
| 728 | |||
| 729 | /** |
||
| 730 | * Add entry metas, if there are any |
||
| 731 | * |
||
| 732 | * @since 2.0.16 |
||
| 733 | * @param array $values |
||
| 734 | * @param int $entry_id |
||
| 735 | */ |
||
| 736 | private static function maybe_add_entry_metas( $values, $entry_id ) { |
||
| 741 | |||
| 742 | /** |
||
| 743 | * Trigger frm_after_create_entry hooks |
||
| 744 | * |
||
| 745 | * @since 2.0.16 |
||
| 746 | * @param int $entry_id |
||
| 747 | * @param array $new_values |
||
| 748 | */ |
||
| 749 | private static function after_entry_created_actions( $entry_id, $values, $new_values ) { |
||
| 756 | |||
| 757 | /** |
||
| 758 | * Actions to perform immediately after an entry is inserted in the frm_items database |
||
| 759 | * |
||
| 760 | * @since 2.0.16 |
||
| 761 | * @param array $values |
||
| 762 | * @param array $new_values |
||
| 763 | * @param int $entry_id |
||
| 764 | */ |
||
| 765 | private static function after_insert_entry_in_database( $values, $new_values, $entry_id ) { |
||
| 775 | |||
| 776 | /** |
||
| 777 | * Perform some actions right before updating an entry |
||
| 778 | * |
||
| 779 | * @since 2.0.16 |
||
| 780 | * @param int $id |
||
| 781 | * @param array $values |
||
| 782 | * @param string $update_type |
||
| 783 | * @return boolean $update |
||
| 784 | */ |
||
| 785 | private static function before_update_entry( $id, &$values, $update_type ) { |
||
| 800 | |||
| 801 | /** |
||
| 802 | * Package the entry data for updating |
||
| 803 | * |
||
| 804 | * @since 2.0.16 |
||
| 805 | * @param int $id |
||
| 806 | * @param array $values |
||
| 807 | * @return array $new_values |
||
| 808 | */ |
||
| 809 | private static function package_entry_to_update( $id, $values ) { |
||
| 840 | |||
| 841 | /** |
||
| 842 | * Perform some actions right after updating an entry |
||
| 843 | * |
||
| 844 | * @since 2.0.16 |
||
| 845 | * @param boolean|int $query_results |
||
| 846 | * @param int $id |
||
| 847 | * @param array $values |
||
| 848 | * @param array $new_values |
||
| 849 | */ |
||
| 850 | private static function after_update_entry( $query_results, $id, $values, $new_values ) { |
||
| 869 | |||
| 870 | /** |
||
| 871 | * Create entry from an XML import |
||
| 872 | * Certain actions aren't necessary when importing (like saving sub entries, checking for duplicates, etc.) |
||
| 873 | * |
||
| 874 | * @since 2.0.16 |
||
| 875 | * @param array $values |
||
| 876 | * @return int | boolean $entry_id |
||
| 877 | */ |
||
| 878 | public static function create_entry_from_xml( $values ) { |
||
| 883 | |||
| 884 | /** |
||
| 885 | * Update entry from an XML import |
||
| 886 | * Certain actions aren't necessary when importing (like saving sub entries and modifying other vals) |
||
| 887 | * |
||
| 888 | * @since 2.0.16 |
||
| 889 | * @param int $id |
||
| 890 | * @param array $values |
||
| 891 | * @return int | boolean $updated |
||
| 892 | */ |
||
| 893 | public static function update_entry_from_xml( $id, $values ) { |
||
| 898 | |||
| 899 | /** |
||
| 900 | * @param string $key |
||
| 901 | * @return int entry_id |
||
| 902 | */ |
||
| 903 | public static function get_id_by_key( $key ) { |
||
| 907 | |||
| 908 | public static function validate( $values, $exclude = false ) { |
||
| 912 | |||
| 913 | public static function validate_field( $posted_field, &$errors, $values, $args = array() ) { |
||
| 917 | |||
| 918 | public static function validate_url_field( &$errors, $field, &$value, $args ) { |
||
| 922 | |||
| 923 | public static function validate_email_field( &$errors, $field, $value, $args ) { |
||
| 927 | |||
| 928 | public static function validate_recaptcha( &$errors, $field, $args ) { |
||
| 932 | |||
| 933 | public static function spam_check( $exclude, $values, &$errors ) { |
||
| 937 | |||
| 938 | public static function blacklist_check( $values ) { |
||
| 942 | |||
| 943 | public static function akismet( $values ) { |
||
| 947 | } |
||
| 948 |
Loading history...
There are different options of fixing this problem.
If you want to be on the safe side, you can add an additional type-check:
If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:
Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.