diff --git a/classes/controllers/FrmAddonsController.php b/classes/controllers/FrmAddonsController.php index 1074b35ce9..285a418843 100644 --- a/classes/controllers/FrmAddonsController.php +++ b/classes/controllers/FrmAddonsController.php @@ -512,6 +512,9 @@ public static function get_primary_license_info() { /** * @since 3.04.03 + * + * @param mixed $transient + * @return object */ public static function check_update( $transient ) { if ( ! FrmAppHelper::pro_is_installed() ) { @@ -744,6 +747,8 @@ public static function get_addon_for_license( $addons, $license ) { } /** + * @param array $addons + * * @return void */ protected static function prepare_addons( &$addons ) { @@ -808,6 +813,9 @@ protected static function prepare_addons( &$addons ) { } /** + * @param string $file_name + * @param string $slug + * * @return bool */ private static function is_plugin_active( $file_name, $slug ) { @@ -831,6 +839,8 @@ private static function get_active_views_version() { /** * @since 3.04.02 * + * @param string $link + * * @return void */ protected static function prepare_addon_link( &$link ) { @@ -852,6 +862,8 @@ protected static function prepare_addon_link( &$link ) { * * @since 3.04.02 * + * @param array $addon + * * @return void */ protected static function set_addon_status( &$addon ) { @@ -1490,6 +1502,8 @@ private static function allowed_external_urls() { * * @since 6.4.2 * + * @param int|string $addon_id + * * @return string Empty string if no plan is required for active license. */ public static function get_addon_required_plan( $addon_id ) { diff --git a/classes/controllers/FrmAppController.php b/classes/controllers/FrmAppController.php index 790c42d4b8..9dae1047b2 100644 --- a/classes/controllers/FrmAppController.php +++ b/classes/controllers/FrmAppController.php @@ -47,6 +47,9 @@ private static function menu_icon() { /** * @since 3.0 + * + * @param string $classes + * @return string */ public static function add_admin_class( $classes ) { if ( self::is_white_page() ) { diff --git a/classes/controllers/FrmDashboardController.php b/classes/controllers/FrmDashboardController.php index 0cebe1752f..6f94a7e4f5 100644 --- a/classes/controllers/FrmDashboardController.php +++ b/classes/controllers/FrmDashboardController.php @@ -428,6 +428,7 @@ private static function view_args_inbox() { /** * Prepare inbox messages data. * + * @param array $data * @return array */ private static function inbox_prepare_messages( $data ) { diff --git a/classes/controllers/FrmEntriesController.php b/classes/controllers/FrmEntriesController.php index f793df170b..9936499731 100644 --- a/classes/controllers/FrmEntriesController.php +++ b/classes/controllers/FrmEntriesController.php @@ -131,6 +131,11 @@ public static function route() { * editing or creating an entry * * @since 3.0 + * + * @param bool $show_screen Whether to show the screen options tab. + * @param object $screen The current screen object. + * + * @return bool */ public static function remove_screen_options( $show_screen, $screen ) { $menu_name = sanitize_title( FrmAppHelper::get_menu_name() ); @@ -209,6 +214,12 @@ private static function get_columns_for_form( $form_id, &$columns ) { /** * @since 3.01 + * + * @param object $field The field object. + * @param int|string $form_id The form ID. + * @param array $columns The columns array. + * + * @return void */ private static function add_subform_cols( $field, $form_id, &$columns ) { $sub_form_cols = FrmField::get_all_for_form( $field->field_options['form_select'] ); @@ -228,6 +239,12 @@ private static function add_subform_cols( $field, $form_id, &$columns ) { /** * @since 3.01 + * + * @param object $field The field object. + * @param int|string $form_id The form ID. + * @param array $columns The columns array. + * + * @return void */ private static function add_field_cols( $field, $form_id, &$columns ) { $col_id = $field->field_key; @@ -266,12 +283,27 @@ private static function maybe_format_field_name_for_column_title( $field, $inclu return sprintf( '%s (%s)', $field_name, $append_text ); } + /** + * @param int|string $form_id The form ID. + * @param array $columns The columns array. + * + * @return void + */ private static function maybe_add_ip_col( $form_id, &$columns ) { if ( FrmAppHelper::ips_saved() ) { $columns[ $form_id . '_ip' ] = 'IP'; } } + /** + * @param bool $check The check value. + * @param int $object_id The object ID. + * @param string $meta_key The meta key. + * @param mixed $meta_value The meta value. + * @param mixed $prev_value The previous value. + * + * @return bool + */ public static function check_hidden_cols( $check, $object_id, $meta_key, $meta_value, $prev_value ) { $this_page_name = self::hidden_column_key(); if ( $meta_key != $this_page_name || $meta_value == $prev_value ) { @@ -291,6 +323,13 @@ public static function check_hidden_cols( $check, $object_id, $meta_key, $meta_v /** * Add hidden columns back from other forms + * + * @param int $meta_id The meta ID. + * @param int $object_id The object ID. + * @param string $meta_key The meta key. + * @param array $meta_value The meta value. + * + * @return void */ public static function update_hidden_cols( $meta_id, $object_id, $meta_key, $meta_value ) { $this_page_name = self::hidden_column_key(); @@ -342,6 +381,10 @@ public static function update_hidden_cols( $meta_id, $object_id, $meta_key, $met /** * @since 2.05.07 + * + * @param string $menu_name + * + * @return string */ private static function hidden_column_key( $menu_name = '' ) { $base = self::base_column_key( $menu_name ); @@ -351,6 +394,10 @@ private static function hidden_column_key( $menu_name = '' ) { /** * @since 2.05.07 + * + * @param string $menu_name + * + * @return string */ private static function base_column_key( $menu_name = '' ) { if ( empty( $menu_name ) ) { @@ -362,6 +409,13 @@ private static function base_column_key( $menu_name = '' ) { return sanitize_title( $menu_name ) . ( $unread_count ? '-' . $unread_count : '' ) . '_page_formidable-entries'; } + /** + * @param int $save + * @param string $option + * @param string $value + * + * @return int + */ public static function save_per_page( $save, $option, $value ) { if ( $option === 'formidable_page_formidable_entries_per_page' ) { $save = (int) $value; @@ -445,6 +499,11 @@ public static function hidden_columns( $result ) { /** * @since 2.05.07 + * + * @param int|string $form_id + * @param mixed $result + * + * @return array */ private static function user_hidden_columns_for_form( $form_id, $result ) { $hidden = array(); @@ -536,6 +595,12 @@ public static function display_list( $message = '', $errors = array() ) { require FrmAppHelper::plugin_path() . '/classes/views/frm-entries/list.php'; } + /** + * @param object $form + * @param array $errors + * + * @return void + */ private static function get_delete_form_time( $form, &$errors ) { if ( 'trash' === $form->status ) { $delete_timestamp = time() - ( DAY_IN_SECONDS * EMPTY_TRASH_DAYS ); @@ -548,6 +613,9 @@ private static function get_delete_form_time( $form, &$errors ) { /** * Back End CRUD. + * + * @param int $id + * @return void */ public static function show( $id = 0 ) { FrmAppHelper::permission_check( 'frm_view_entries' ); @@ -691,6 +759,15 @@ public static function prepare_redirect_url( $url ) { return str_replace( array( ' ', '[', ']', '|', '@' ), array( '%20', '%5B', '%5D', '%7C', '%40' ), $url ); } + /** + * Delete entry if redirected. + * + * @param string $url + * @param object $form + * @param array $atts + * + * @return string + */ public static function delete_entry_before_redirect( $url, $form, $atts ) { self::_delete_entry( $atts['id'], $form ); @@ -701,11 +778,20 @@ public static function delete_entry_before_redirect( $url, $form, $atts ) { * Delete entry if not redirected. * * @param array $atts + * @return void */ public static function delete_entry_after_save( $atts ) { self::_delete_entry( $atts['entry_id'], $atts['form'] ); } + /** + * Delete entry if not redirected. + * + * @param int $entry_id + * @param object $form + * + * @return void + */ private static function _delete_entry( $entry_id, $form ) { if ( ! $form ) { return; @@ -720,6 +806,10 @@ private static function _delete_entry( $entry_id, $form ) { /** * Unlink entry from post + * + * @param int $entry_id + * + * @return void */ private static function unlink_post( $entry_id ) { global $wpdb; diff --git a/classes/controllers/FrmFieldsController.php b/classes/controllers/FrmFieldsController.php index 836006836d..82f67a322f 100644 --- a/classes/controllers/FrmFieldsController.php +++ b/classes/controllers/FrmFieldsController.php @@ -700,6 +700,9 @@ public static function get_default_value_from_name( $field ) { * in a dropdown. * * @since 4.04 + * + * @param array|object $field + * * @return bool True if placeholder was added. */ public static function add_placeholder_to_select( $field ) { diff --git a/classes/controllers/FrmFormActionsController.php b/classes/controllers/FrmFormActionsController.php index 2bab9e6eff..b437ce52e7 100644 --- a/classes/controllers/FrmFormActionsController.php +++ b/classes/controllers/FrmFormActionsController.php @@ -119,6 +119,10 @@ public static function email_settings( $values ) { * Add unknown actions to a group. * * @since 4.0 + * + * @param array $action_controls + * @param array $groups + * @return void */ private static function maybe_add_action_to_group( $action_controls, &$groups ) { $grouped = array(); @@ -224,6 +228,7 @@ private static function get_crm_actions() { * * @since 4.0 * + * @param array $action_controls * @return array */ private static function active_actions( $action_controls ) { @@ -322,6 +327,11 @@ public static function get_form_actions( $action = 'all' ) { /** * @since 2.0 + * + * @param object $form + * @param array $values + * + * @return void */ public static function list_actions( $form, $values ) { if ( empty( $form ) ) { @@ -457,6 +467,9 @@ public static function fill_action() { /** * @since 3.06.04 + * + * @param string $action_type + * * @return bool */ private static function should_show_log_message( $action_type ) { @@ -464,6 +477,12 @@ private static function should_show_log_message( $action_type ) { return in_array( $action_type, $logging, true ) && ! function_exists( 'frm_log_autoloader' ); } + /** + * @param int|string $form_id + * @param array $values + * + * @return object + */ private static function fields_to_values( $form_id, array &$values ) { $form = FrmForm::getOne( $form_id ); @@ -553,6 +572,13 @@ public static function delete_missing_actions( $old_actions ) { } } + /** + * @param int|string $entry_id + * @param int|string $form_id + * @param array $args + * + * @return void + */ public static function trigger_create_actions( $entry_id, $form_id, $args = array() ) { $filter_args = $args; $filter_args['entry_id'] = $entry_id; @@ -571,7 +597,13 @@ public static function trigger_create_actions( $entry_id, $form_id, $args = arra } /** - * @param string $event + * @param string $event + * @param int|object|string $form + * @param int|string $entry + * @param string $type + * @param array $args + * + * @return void */ public static function trigger_actions( $event, $form, $entry, $type = 'all', $args = array() ) { $action_status = array( diff --git a/classes/controllers/FrmFormsController.php b/classes/controllers/FrmFormsController.php index 31d7ab9b7f..5a96c6f052 100644 --- a/classes/controllers/FrmFormsController.php +++ b/classes/controllers/FrmFormsController.php @@ -77,6 +77,10 @@ public static function logic_tip() { * Now that won't do. * * @since 3.01 + * + * @param array $shortcodes List of shortcodes to process. + * + * @return array */ public static function prevent_divi_conflict( $shortcodes ) { $shortcodes[] = 'formidable'; @@ -194,6 +198,8 @@ private static function create_submit_button_field( $form ) { } /** + * @param array|false $values + * * @return void */ public static function edit( $values = false ) { @@ -272,6 +278,8 @@ private static function antispam_was_on( $form_id ) { } /** + * @param array $values + * * @return void */ public static function update( $values = array() ) { @@ -625,6 +633,9 @@ private static function should_try_getting_template( $template ) { * Set the page title for the theme preview page * * @since 3.0 + * + * @param string $title + * @return string */ public static function preview_page_title( $title ) { if ( in_the_loop() ) { @@ -1326,13 +1337,17 @@ private static function get_edit_vars( $id, $errors = array(), $message = '', $c * @param array $fields * @return array */ - public static function update_form_builder_fields( $fields, $form ) { + public static function update_form_builder_fields( $fields ) { foreach ( $fields as $field ) { $field->do_not_include_icons = true; } return $fields; } + /** + * @param string $message + * @return void + */ public static function maybe_update_form_builder_message( &$message ) { if ( 'form_duplicated' === FrmAppHelper::simple_get( 'message' ) ) { $message = __( 'Form was Successfully Copied', 'formidable' ); @@ -1412,6 +1427,9 @@ function () { /** * @since 4.0 + * + * @param array $atts + * @return void */ public static function form_publish_button( $atts ) { $values = $atts['values']; @@ -1645,6 +1663,9 @@ public static function mb_tags_box( $form_id, $class = '' ) { /** * @since 3.04.01 + * + * @param array $atts + * @return array */ private static function advanced_helpers( $atts ) { $advanced_helpers = array( @@ -1683,6 +1704,8 @@ private static function advanced_helpers( $atts ) { * of the customization panel * * @since 2.0.6 + * + * @return array */ private static function get_advanced_shortcodes() { $adv_shortcodes = array( @@ -1710,6 +1733,8 @@ private static function get_advanced_shortcodes() { /** * @since 3.04.01 + * + * @return array */ private static function user_shortcodes() { $options = array( @@ -1730,6 +1755,9 @@ private static function user_shortcodes() { * Get an array of the helper shortcodes to display in the customization panel * * @since 2.0.6 + * + * @param bool $settings_tab + * @return array */ private static function get_shortcode_helpers( $settings_tab ) { $entry_shortcodes = array( @@ -1755,6 +1783,9 @@ private static function get_shortcode_helpers( $settings_tab ) { * in the customization panel * * @since 2.0.6 + * + * @param array $entry_shortcodes + * @param bool $settings_tab */ $entry_shortcodes = apply_filters( 'frm_helper_shortcodes', $entry_shortcodes, $settings_tab ); @@ -2102,6 +2133,8 @@ public static function json_error( $errors ) { * * @since 4.07 * + * @param array $values + * * @return void */ public static function no_views( $values = array() ) { @@ -2117,6 +2150,7 @@ public static function no_views( $values = array() ) { * * @since 4.07 * + * @param array $values * @return void */ public static function no_reports( $values = array() ) { @@ -2192,6 +2226,9 @@ public static function add_menu_to_admin_bar() { /** * @since 2.05.07 + * + * @param array $actions + * @return void */ private static function add_forms_to_admin_bar( $actions ) { global $wp_admin_bar; @@ -2400,6 +2437,11 @@ public static function get_form_contents( $form, $title, $description, $atts ) { * If the form was processed earlier (init), get the generated errors * * @since 2.05 + * + * @param object $form + * @param array $params + * + * @return array */ private static function get_saved_errors( $form, $params ) { global $frm_vars; @@ -2423,6 +2465,9 @@ private static function get_saved_errors( $form, $params ) { /** * @since 2.2.7 + * + * @param int|string $form_id + * @return int */ public static function just_created_entry( $form_id ) { global $frm_vars; @@ -2778,6 +2823,9 @@ private static function get_run_success_action_args( $args, $action ) { /** * @since 3.0 + * + * @param array $args + * @return void */ private static function load_page_after_submit( $args ) { global $post; @@ -3013,6 +3061,10 @@ private static function get_redirect_fallback_message( $success_url, $args ) { * Prepare to show the success message and empty form after submit * * @since 2.05 + * + * @param array $atts + * + * @return void */ public static function show_message_after_save( $atts ) { $atts['message'] = self::prepare_submit_message( $atts['form'], $atts['entry_id'], $atts ); @@ -3038,6 +3090,10 @@ public static function show_message_after_save( $atts ) { * Show an empty form * * @since 2.05 + * + * @param array $args + * + * @return void */ private static function show_form_after_submit( $args ) { self::fill_atts_for_form_display( $args ); @@ -3106,6 +3162,10 @@ public static function message_placement( $form, $message ) { * Get all the values needed on the new.php entry page * * @since 2.05 + * + * @param array $args + * + * @return void */ private static function fill_atts_for_form_display( &$args ) { if ( ! isset( $args['title'] ) && isset( $args['show_title'] ) ) { @@ -3132,6 +3192,10 @@ private static function fill_atts_for_form_display( &$args ) { * Show the success message without the form * * @since 2.05 + * + * @param array $atts + * + * @return void */ private static function show_lone_success_message( $atts ) { global $frm_vars; @@ -3253,14 +3317,25 @@ private static function should_load_late() { return ! function_exists( 'aioseo' ); } + /** + * @param string $tag + * @param string $handle + * + * @return string + */ public static function defer_script_loading( $tag, $handle ) { - if ( 'captcha-api' == $handle && ! strpos( $tag, 'defer' ) ) { + if ( 'captcha-api' === $handle && ! strpos( $tag, 'defer' ) ) { $tag = str_replace( ' src', ' defer="defer" async="async" src', $tag ); } return $tag; } + /** + * @param string $location + * + * @return void + */ public static function footer_js( $location = 'footer' ) { global $frm_vars; @@ -3276,6 +3351,11 @@ public static function footer_js( $location = 'footer' ) { /** * @since 2.0.8 + * + * @param array $atts + * @param string $content + * + * @return void */ private static function maybe_minimize_form( $atts, &$content ) { // check if minimizing is turned on @@ -3286,6 +3366,8 @@ private static function maybe_minimize_form( $atts, &$content ) { /** * @since 2.0.8 + * + * @param array $atts * @return bool */ private static function is_minification_on( $atts ) { @@ -3410,6 +3492,9 @@ function () { /** * @deprecated 4.0 + * + * @param array $values + * @return void */ public static function create( $values = array() ) { _deprecated_function( __METHOD__, '4.0', 'FrmFormsController::update' ); diff --git a/classes/controllers/FrmHooksController.php b/classes/controllers/FrmHooksController.php index 43cd297cfb..b7ca1807be 100644 --- a/classes/controllers/FrmHooksController.php +++ b/classes/controllers/FrmHooksController.php @@ -151,7 +151,7 @@ public static function load_admin_hooks() { add_action( 'admin_menu', 'FrmFormsController::menu', 10 ); add_action( 'admin_head-toplevel_page_formidable', 'FrmFormsController::head' ); add_action( 'frm_after_field_options', 'FrmFormsController::logic_tip' ); - add_filter( 'frm_fields_in_form_builder', 'FrmFormsController::update_form_builder_fields', 10, 2 ); + add_filter( 'frm_fields_in_form_builder', 'FrmFormsController::update_form_builder_fields' ); add_filter( 'set-screen-option', 'FrmFormsController::save_per_page', 10, 3 ); add_action( 'admin_footer', 'FrmFormsController::insert_form_popup' ); diff --git a/classes/controllers/FrmInboxController.php b/classes/controllers/FrmInboxController.php index 1e2381cd9c..8e9fcb55f2 100644 --- a/classes/controllers/FrmInboxController.php +++ b/classes/controllers/FrmInboxController.php @@ -113,14 +113,4 @@ private static function remove_free_template_message() { $message->dismiss( 'free_templates' ); } } - - /** - * @since 4.06 - * @deprecated 6.16 - * - * @return void - */ - public static function dismiss_all_button( $atts ) { - _deprecated_function( __METHOD__, '6.16' ); - } } diff --git a/classes/controllers/FrmSMTPController.php b/classes/controllers/FrmSMTPController.php index 285d6297b4..00c74372fb 100644 --- a/classes/controllers/FrmSMTPController.php +++ b/classes/controllers/FrmSMTPController.php @@ -74,6 +74,8 @@ public static function load_hooks() { /** * Customize the upgrade link. * + * @param string $link + * * @return string */ public function link( $link ) { @@ -86,6 +88,10 @@ public function link( $link ) { * Don't nag people to install WPForms * * @since 4.04.04 + * + * @param array $upsell + * + * @return array */ public static function remove_wpforms_nag( $upsell ) { if ( is_array( $upsell ) ) { diff --git a/classes/controllers/FrmSettingsController.php b/classes/controllers/FrmSettingsController.php index e24ce50ee2..3b36c3f123 100644 --- a/classes/controllers/FrmSettingsController.php +++ b/classes/controllers/FrmSettingsController.php @@ -418,8 +418,10 @@ public static function route( $stop_load = false ) { * Add CTA to the bottom on the plugin settings pages. * * @since 3.04.02 + * + * @return void */ - public static function settings_cta( $view ) { + public static function settings_cta() { if ( get_option( 'frm_lite_settings_upgrade', false ) ) { return; } diff --git a/classes/controllers/FrmStylesController.php b/classes/controllers/FrmStylesController.php index f40ba77394..4f42f1b7c2 100644 --- a/classes/controllers/FrmStylesController.php +++ b/classes/controllers/FrmStylesController.php @@ -1196,7 +1196,8 @@ private static function maybe_add_rtl_class( $style, &$class ) { } /** - * @param string $val + * @param string $val Style setting key. + * @param int|string $form Form ID or 'default'. */ public static function get_style_val( $val, $form = 'default' ) { $style = self::get_form_style( $form ); @@ -1238,6 +1239,10 @@ public static function &important_style( $important, $field ) { * * @since 6.8.3 * + * @param string|WP_Screen $screen Screen ID or screen object. + * @param string $context Meta box context. + * @param mixed $data_object Data object passed to callbacks. + * * @return int */ public static function do_accordion_sections( $screen, $context, $data_object ) { diff --git a/classes/controllers/FrmUsageController.php b/classes/controllers/FrmUsageController.php index cdb8b7a0ec..d1b74740af 100644 --- a/classes/controllers/FrmUsageController.php +++ b/classes/controllers/FrmUsageController.php @@ -56,6 +56,9 @@ public static function schedule_send() { * Adds once weekly to the existing schedules. * * @since 3.06.04 + * + * @param array $schedules Schedules. + * @return array */ public static function add_schedules( $schedules = array() ) { $schedules['weekly'] = array( diff --git a/classes/controllers/FrmXMLController.php b/classes/controllers/FrmXMLController.php index 43fd6d068a..6fef5c2a51 100644 --- a/classes/controllers/FrmXMLController.php +++ b/classes/controllers/FrmXMLController.php @@ -158,6 +158,9 @@ private static function get_posted_form() { * * @since 4.06.02 * + * @param array $form The posted form values. + * @param string $url The URL to override. + * * @return void */ private static function override_url( $form, &$url ) { @@ -577,6 +580,9 @@ public static function get_parent_terms_slugs( $terms ) { } /** + * Prepare the types array. + * + * @param array $type * @return void */ private static function prepare_types_array( &$type ) { @@ -653,6 +659,9 @@ public static function generate_csv( $atts ) { * * @since 2.0.19 * + * @param false|int|string $form_id + * @param string $search + * @param string $fid * @return void */ public static function csv( $form_id = false, $search = '', $fid = '' ) { diff --git a/classes/factories/FrmFieldFactory.php b/classes/factories/FrmFieldFactory.php index ca3f722648..e0a750ee00 100644 --- a/classes/factories/FrmFieldFactory.php +++ b/classes/factories/FrmFieldFactory.php @@ -119,6 +119,9 @@ private static function get_field_type_class( $field_type ) { /** * @since 3.0 + * + * @param string $type + * @return mixed */ public static function field_has_html( $type ) { $has_html = self::field_has_property( $type, 'has_html' ); diff --git a/classes/helpers/FrmAppHelper.php b/classes/helpers/FrmAppHelper.php index 9eb1a7e676..25c596e91f 100644 --- a/classes/helpers/FrmAppHelper.php +++ b/classes/helpers/FrmAppHelper.php @@ -940,6 +940,8 @@ public static function strip_most_html( $value ) { * this MUST be done, else we'll be back to the '& entity' problem. * * @since 4.0.04 + * + * @param mixed $value Value to decode, passed by reference. */ public static function decode_specialchars( &$value ) { if ( is_array( $value ) ) { @@ -959,7 +961,7 @@ public static function decode_specialchars( &$value ) { * * @since 4.03.01 * - * @param string $string The string to prep. + * @param string $string The string to prep, passed by reference. */ private static function decode_amp( &$string ) { // Don't bother if there are no entities - saves a lot of processing @@ -1003,8 +1005,8 @@ private static function decode_amp( &$string ) { * * @since 2.0 * - * @param string $value - * @param array|string $allowed 'all' for everything included as defaults. + * @param string $value The value to sanitize. + * @param array|string $allowed Allowed HTML tags and attributes, or 'all' for defaults. * * @return string */ @@ -1095,6 +1097,9 @@ public static function add_allowed_submit_button_tags( $allowed_html ) { /** * @since 2.05.03 + * + * @param array|string $allowed + * @return array */ private static function allowed_html( $allowed ) { $html = self::safe_html(); @@ -1279,6 +1284,10 @@ public static function remove_get_action() { * Check the WP query for a parameter * * @since 2.0 + * + * @param array|string $value + * @param string $param + * * @return array|string */ public static function get_query_var( $value, $param ) { @@ -1612,6 +1621,9 @@ public static function add_new_item_link( $atts ) { /** * @since 3.06 + * + * @param array $atts + * @return void */ public static function show_search_box( $atts ) { $defaults = array( @@ -1671,7 +1683,8 @@ public static function show_search_box( $atts ) { } /** - * @param string $type + * @param string $type Hook type slug. + * @param object|null $object Optional related object. * @return void */ public static function trigger_hook_load( $type, $object = null ) { @@ -1949,6 +1962,12 @@ public static function wp_pages_dropdown( $args = array(), $page_id = '', $trunc * This is for reverse compatibility with switching 3 params to 1. * * @since 4.03.06 + * + * @param string $page_id Deprecated. + * @param bool $truncate Deprecated. + * @param mixed $args + * + * @return void */ private static function prep_page_dropdown_params( $page_id, $truncate, &$args ) { if ( ! is_array( $args ) ) { @@ -1967,6 +1986,9 @@ private static function prep_page_dropdown_params( $page_id, $truncate, &$args ) * * @since 4.03.06 * @since 4.10.01 Added `post_type` and `autocomplete_placeholder` to the arguments array. + * + * @param array $args + * @return array */ private static function preformat_selection_args( $args ) { $defaults = array( @@ -1981,6 +2003,11 @@ private static function preformat_selection_args( $args ) { return array_merge( $defaults, $args ); } + /** + * @param int $post_id + * + * @return string + */ public static function post_edit_link( $post_id ) { $post = get_post( $post_id ); if ( $post ) { @@ -2258,6 +2285,7 @@ public static function force_capability( $cap = 'frm_change_settings' ) { * @since 2.0 * * @param string $permission + * @param string $show_message */ public static function permission_check( $permission, $show_message = 'show' ) { $permission_error = self::permission_nonce_error( $permission ); @@ -2275,6 +2303,8 @@ public static function permission_check( $permission, $show_message = 'show' ) { * @since 2.0 * * @param string $permission + * @param string $nonce_name + * @param string $nonce * * @return false|string The permission message or false if allowed */ @@ -2299,12 +2329,24 @@ public static function permission_nonce_error( $permission, $nonce_name = '', $n return $error; } + /** + * @param array|string $values + * @param string $current + * + * @return void + */ public static function checked( $values, $current ) { if ( self::check_selected( $values, $current ) ) { echo ' checked="checked"'; } } + /** + * @param array|string $values + * @param string $current + * + * @return bool + */ public static function check_selected( $values, $current ) { $values = self::recursive_function_map( $values, 'trim' ); $values = self::recursive_function_map( $values, 'htmlspecialchars_decode' ); @@ -2361,6 +2403,11 @@ public static function is_assoc( $array ) { /** * Flatten a multi-dimensional array + * + * @param array $array + * @param string $keys + * + * @return array */ public static function array_flatten( $array, $keys = 'keep' ) { $return = array(); @@ -2414,6 +2461,9 @@ public static function esc_textarea( $text, $is_rich_text = false ) { * Add auto paragraphs to text areas * * @since 2.0 + * + * @param mixed $content + * @return mixed */ public static function use_wpautop( $content ) { if ( apply_filters( 'frm_use_wpautop', true ) && is_string( $content ) ) { @@ -2423,6 +2473,13 @@ public static function use_wpautop( $content ) { return $content; } + /** + * Replace quotes with their HTML entities. + * + * @param string $val + * + * @return string + */ public static function replace_quotes( $val ) { // Replace double quotes. $val = str_replace( array( '“', '”', '″' ), '"', $val ); @@ -2434,7 +2491,9 @@ public static function replace_quotes( $val ) { } /** - * @param string $handle + * @param string $handle + * @param int|string $default + * @return int|string */ public static function script_version( $handle, $default = 0 ) { global $wp_scripts; @@ -2810,6 +2869,11 @@ private static function fill_form_opts( $record, $table, $post_values, array &$v /** * Set to POST value or default + * + * @param array $post_values + * @param array $values + * + * @return void */ private static function fill_form_defaults( $post_values, array &$values ) { $form_defaults = FrmFormsHelper::get_default_opts(); @@ -2932,6 +2996,12 @@ private static function maybe_force_truncate_on_string_with_no_spaces( $sub, $le return substr( $sub, 0, $length + 10 ); } + /** + * @param array $function_names + * @param array $args + * + * @return mixed + */ public static function mb_function( $function_names, $args ) { $mb_function_name = $function_names[0]; $function_name = $function_names[1]; @@ -2942,6 +3012,13 @@ public static function mb_function( $function_names, $args ) { return call_user_func_array( $function_name, $args ); } + /** + * @param string $date + * @param string $date_format + * @param string $time_format + * + * @return string + */ public static function get_formatted_time( $date, $date_format = '', $time_format = '' ) { if ( empty( $date ) ) { return $date; @@ -2987,6 +3064,11 @@ private static function add_time_to_date( $time_format, $date ) { /** * @since 2.0.8 + * + * @param string $date_format + * @param string $date + * + * @return string */ public static function get_localized_date( $date_format, $date ) { $date = get_date_from_gmt( $date ); @@ -2997,8 +3079,9 @@ public static function get_localized_date( $date_format, $date ) { /** * Gets the time ago in words. * - * @param int $from In seconds. - * @param int|string $to In seconds. + * @param int $from In seconds. + * @param int|string $to In seconds. + * @param int|string $levels Number of time units to include or a specific unit. * * @return string $time_ago */ @@ -3054,6 +3137,11 @@ public static function human_time_diff( $from, $to = '', $levels = 1 ) { /** * @since 4.05.01 + * + * @param string $unit + * @param array $diff + * + * @return int */ private static function time_format( $unit, $diff ) { $return = array( @@ -3081,6 +3169,11 @@ private static function time_format( $unit, $diff ) { /** * @since 4.05.01 + * + * @param string $from + * @param string $to + * + * @return int */ private static function convert_time( $from, $to ) { $convert = array( @@ -3098,6 +3191,10 @@ private static function convert_time( $from, $to ) { /** * @since 4.05.01 + * + * @param string $unit + * + * @return int|string */ private static function get_unit( $unit ) { $units = self::get_time_strings(); @@ -3186,6 +3283,8 @@ public static function get_first_record_num( $r_count, $current_p, $p_size ) { } /** + * @param array $json_vars + * * @return array */ public static function json_to_array( $json_vars ) { @@ -3242,6 +3341,10 @@ public static function json_to_array( $json_vars ) { /** * @param string $name * @param string $l1 + * @param mixed $val + * @param array $vars + * + * @return void */ public static function add_value_to_array( $name, $l1, $val, &$vars ) { if ( $name == '' ) { @@ -3283,6 +3386,12 @@ public static function maybe_add_tooltip( $name, $class = 'closed', $form_name = /** * Add the current_page class to that page in the form nav + * + * @param int|string $page + * @param int|string $current_page + * @param array $action + * + * @return void */ public static function select_current_page( $page, $current_page, $action = array() ) { if ( $current_page != $page ) { @@ -3459,6 +3568,9 @@ public static function maybe_utf8_encode( $value ) { * Reformat the json serialized array in name => value array. * * @since 4.02.03 + * + * @param array $form + * @return void */ public static function format_form_data( &$form ) { $formatted = array(); @@ -3743,6 +3855,7 @@ public static function min_version_notice( $min_version ) { * * @since 4.0.01 * + * @param string $min_version * @return void */ public static function min_pro_version_notice( $min_version ) { @@ -4024,6 +4137,11 @@ private static function get_images_dropdown_input_attrs( $args ) { /** * @since 6.7.1 + * + * @param array $option Option data. + * @param array $args The arguments of images_dropdown() method. + * + * @return array */ public static function get_images_dropdown_atts( $option, $args ) { $image = self::get_images_dropdown_option_image( $option, $args ); @@ -4260,6 +4378,8 @@ public static function input_key_is_safe( $key, $context = 'display' ) { /** * @since 5.0.16 * + * @param string $medium + * * @return array */ public static function get_landing_page_upgrade_data_params( $medium = 'landing' ) { diff --git a/classes/helpers/FrmCSVExportHelper.php b/classes/helpers/FrmCSVExportHelper.php index 787c468cce..6bdb6b05a2 100644 --- a/classes/helpers/FrmCSVExportHelper.php +++ b/classes/helpers/FrmCSVExportHelper.php @@ -657,6 +657,10 @@ private static function get_separate_value_label( $field_value, $field ) { /** * @since 2.0.23 + * + * @param array $row + * @param array $atts + * @return void */ private static function add_array_values_to_columns( &$row, $atts ) { if ( is_array( $atts['field_value'] ) ) { diff --git a/classes/helpers/FrmDashboardHelper.php b/classes/helpers/FrmDashboardHelper.php index 09ee78fe44..cd2ed33fca 100644 --- a/classes/helpers/FrmDashboardHelper.php +++ b/classes/helpers/FrmDashboardHelper.php @@ -360,6 +360,7 @@ public static function load_entries_template( $template ) { /** * Dashboard - load the entries list template. * + * @param array $template * @return void */ private static function load_entries_list_template( $template ) { diff --git a/classes/helpers/FrmEmailSummaryHelper.php b/classes/helpers/FrmEmailSummaryHelper.php index a5258f5f41..a316a87de3 100644 --- a/classes/helpers/FrmEmailSummaryHelper.php +++ b/classes/helpers/FrmEmailSummaryHelper.php @@ -396,6 +396,8 @@ public static function get_heading2_style() { /** * Gets CSS for button. * + * @param bool $display_block Whether to display the button as block. + * * @return string */ public static function get_button_style( $display_block = false ) { diff --git a/classes/helpers/FrmEntriesHelper.php b/classes/helpers/FrmEntriesHelper.php index 02a52c1651..f951797e65 100644 --- a/classes/helpers/FrmEntriesHelper.php +++ b/classes/helpers/FrmEntriesHelper.php @@ -355,6 +355,12 @@ public static function set_posted_value( $field, $value, $args ) { * Init arrays if necessary, else we get fatal error. * * @since 4.01 + * + * @param object $field Field object. + * @param mixed $value Value to set. + * @param array $args Additional arguments. + * + * @return void */ private static function set_parent_field_posted_value( $field, $value, $args ) { if ( isset( $_POST['item_meta'][ $args['parent_field_id'] ] ) && is_array( $_POST['item_meta'][ $args['parent_field_id'] ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing @@ -398,6 +404,11 @@ public static function get_posted_value( $field, &$value, $args ) { /** * @since 4.02.04 + * + * @param int|string $field_id Field ID. + * @param array $args Additional arguments. + * + * @return mixed */ private static function get_posted_meta( $field_id, $args ) { if ( empty( $args['parent_field_id'] ) ) { @@ -414,9 +425,9 @@ private static function get_posted_meta( $field_id, $args ) { * * @since 2.0 * - * @param object $field - * @param array|string $value - * @param array $args + * @param object $field Field object. + * @param array|string $value Field value, passed by reference. + * @param array $args Arguments array, passed by reference. */ public static function maybe_set_other_validation( $field, &$value, &$args ) { $args['other'] = false; @@ -455,9 +466,9 @@ public static function maybe_set_other_validation( $field, &$value, &$args ) { * * @since 2.0 * - * @param object $field - * @param array|string $value - * @param array $args + * @param object $field Field object. + * @param array|string $value Field value, passed by reference. + * @param array $args Arguments array, passed by reference. */ public static function set_other_repeating_vals( $field, &$value, &$args ) { if ( ! $args['parent_field_id'] ) { @@ -642,6 +653,9 @@ public static function get_browser( $u_agent ) { /** * @since 3.0 + * + * @param array $atts Action dropdown attributes. + * @return void */ public static function actions_dropdown( $atts ) { $id = $atts['id'] ?? FrmAppHelper::get_param( 'id', 0, 'get', 'absint' ); @@ -675,6 +689,10 @@ public static function actions_dropdown( $atts ) { /** * @since 3.0 + * + * @param int $id Entry ID. + * @param array|object $entry Entry object. + * @return array */ private static function get_action_links( $id, $entry ) { $page = FrmAppHelper::get_param( 'frm_action' ); diff --git a/classes/helpers/FrmEntriesListHelper.php b/classes/helpers/FrmEntriesListHelper.php index 5f90b9b8ef..1eda6eec8b 100644 --- a/classes/helpers/FrmEntriesListHelper.php +++ b/classes/helpers/FrmEntriesListHelper.php @@ -216,6 +216,9 @@ public function no_items() { } /** + * @param string $text Text. + * @param string $input_id Input ID. + * * @return void */ public function search_box( $text, $input_id ) { @@ -223,6 +226,8 @@ public function search_box( $text, $input_id ) { } /** + * @param string $which + * * @return void */ protected function display_tablenav( $which ) { @@ -245,6 +250,8 @@ protected function display_tablenav( $which ) { } /** + * @param string $which + * * @return void */ protected function extra_tablenav( $which ) { @@ -301,6 +308,9 @@ private static function get_entry_label( $item ) { } /** + * @param object $item + * @param string $style + * * @return string */ public function single_row( $item, $style = '' ) { diff --git a/classes/helpers/FrmFieldsHelper.php b/classes/helpers/FrmFieldsHelper.php index 74dc7bfb62..3c66867125 100644 --- a/classes/helpers/FrmFieldsHelper.php +++ b/classes/helpers/FrmFieldsHelper.php @@ -78,9 +78,14 @@ private static function fill_field_array( $field, array &$field_array ) { } /** - * Prepare field while creating a new entry + * Prepare field while creating a new entry. * * @since 3.0 + * + * @param array $field_array Field values array, passed by reference. + * @param stdClass $field Field object. + * @param array $args Additional arguments. + * @return void */ public static function prepare_new_front_field( &$field_array, $field, $args = array() ) { $args['action'] = 'new'; @@ -88,9 +93,15 @@ public static function prepare_new_front_field( &$field_array, $field, $args = a } /** - * Prepare field while editing an entry + * Prepare field while editing an entry. * * @since 3.0 + * + * @param array $field_array Field values array, passed by reference. + * @param array|stdClass $field Field object or array. + * @param int $entry_id Entry ID. + * @param array $args Additional arguments. + * @return void */ public static function prepare_edit_front_field( &$field_array, $field, $entry_id = 0, $args = array() ) { $args['entry_id'] = $entry_id; @@ -538,6 +549,12 @@ public static function run_wpautop( $atts, &$value ) { * Get the class to use for the label position * * @since 2.05 + * + * @param string $position + * @param array $field + * @param bool|object|string $form + * + * @return string */ public static function &label_position( $position, $field, $form ) { if ( $position && $position != '' ) { @@ -792,6 +809,9 @@ public static function value_meets_condition( $observed_value, $cond, $hide_opt * Trim and sanitize the values * * @since 2.05 + * + * @param array|string $value + * @return string */ private static function get_value_for_comparison( $value ) { // Remove white space from hide_opt @@ -858,6 +878,11 @@ public static function array_value_condition( $observed_value, $cond, $hide_opt * Replace a few basic shortcodes and field ids * * @since 2.0 + * + * @param string $value + * @param object $form + * @param object $entry + * * @return string */ public static function basic_replace_shortcodes( $value, $form, $entry ) { @@ -1110,6 +1135,11 @@ private static function get_field_shortcode_value( $atts ) { * Get the value to replace a few standard shortcodes * * @since 2.0 + * + * @param string $tag + * @param array $atts + * @param bool $return_array + * * @return string */ public static function dynamic_default_values( $tag, $atts = array(), $return_array = false ) { @@ -1146,6 +1176,10 @@ public static function dynamic_default_values( $tag, $atts = array(), $return_ar * Process the [get] shortcode * * @since 2.0 + * + * @param array $atts + * @param bool $return_array + * * @return array|string */ public static function process_get_shortcode( $atts, $return_array = false ) { @@ -1208,6 +1242,10 @@ public static function get_unfiltered_display_value( $atts ) { * * @since 3.0 * + * @param int|string $user_id + * @param string $user_info + * @param array $args + * * @return string */ public static function get_user_display_name( $user_id, $user_info = 'display_name', $args = array() ) { @@ -2299,6 +2337,10 @@ public static function get_display_format_args( $field, $options ) { /** * @since 5.0.04 + * + * @param array $options Options. + * @param array $args Arguments. + * @return void */ private static function fill_image_setting_options( $options, &$args ) { foreach ( $options as $key => $option ) { @@ -2319,6 +2361,8 @@ private static function fill_image_setting_options( $options, &$args ) { /** * @since 5.0.04 * + * @param array $option Option. + * * @return array */ private static function fill_image_setting_addon_link( $option ) { diff --git a/classes/helpers/FrmFormActionsHelper.php b/classes/helpers/FrmFormActionsHelper.php index e69c529f33..9a4135fe4b 100644 --- a/classes/helpers/FrmFormActionsHelper.php +++ b/classes/helpers/FrmFormActionsHelper.php @@ -8,6 +8,10 @@ class FrmFormActionsHelper { /** * @deprecated 2.0.9 This is still referenced in our docs as of May 8, 2024. * @since 6.1.3 - Uncommented the deprecated message. + * + * @param int|string $form_id + * @param string $type + * @param int $limit */ public static function get_action_for_form( $form_id, $type = 'all', $limit = 99 ) { _deprecated_function( __FUNCTION__, '2.0.9', 'FrmFormAction::get_action_for_form' ); diff --git a/classes/helpers/FrmFormMigratorsHelper.php b/classes/helpers/FrmFormMigratorsHelper.php index a4d6a57ed0..f1538a90d1 100644 --- a/classes/helpers/FrmFormMigratorsHelper.php +++ b/classes/helpers/FrmFormMigratorsHelper.php @@ -6,6 +6,9 @@ class FrmFormMigratorsHelper { /** + * @param array $form + * @param array|null $dismissed + * * @return bool */ private static function is_dismissed( $form, $dismissed = null ) { diff --git a/classes/helpers/FrmFormsHelper.php b/classes/helpers/FrmFormsHelper.php index b29fdcfbf8..163418b05d 100644 --- a/classes/helpers/FrmFormsHelper.php +++ b/classes/helpers/FrmFormsHelper.php @@ -306,6 +306,10 @@ public static function get_success_message( $atts ) { /** * Used when a form is created + * + * @param array $values + * + * @return array */ public static function setup_new_vars( $values = array() ) { global $wpdb; @@ -356,6 +360,12 @@ public static function setup_new_vars( $values = array() ) { /** * Used when editing a form + * + * @param array $values + * @param object $record + * @param array $post_values + * + * @return array */ public static function setup_edit_vars( $values, $record, $post_values = array() ) { if ( empty( $post_values ) ) { @@ -789,6 +799,13 @@ public static function auto_add_end_section_fields( $form, $fields, &$reset_fiel /** * Create end section field if it doesn't exist. This is for migration from < 2.0 * Fix any ordering that may be messed up + * + * @param bool $open + * @param bool $reset_fields + * @param int $add_order + * @param array $end_section_values + * @param object $field + * @param string $move */ public static function maybe_create_end_section( &$open, &$reset_fields, &$add_order, $end_section_values, $field, $move = 'no' ) { if ( ! $open ) { @@ -890,6 +907,8 @@ public static function maybe_hide_inline() { } /** + * @param array|bool|int|object|string $form + * * @return string|null */ public static function get_form_style_class( $form = false ) { @@ -1098,6 +1117,10 @@ public static function get_scroll_js( $form_id ) { /** * @since 3.0 + * + * @param int|object|string $form_id + * @param mixed $form + * @return array */ public static function get_action_links( $form_id, $form ) { if ( ! is_object( $form ) ) { @@ -1200,6 +1223,12 @@ private static function get_form_name_from_data( $data ) { return $form_name; } + /** + * @param int $id + * @param string $status + * @param string $length + * @return string + */ public static function delete_trash_link( $id, $status, $length = 'label' ) { $link_details = self::delete_trash_info( $id, $status ); @@ -1208,6 +1237,11 @@ public static function delete_trash_link( $id, $status, $length = 'label' ) { /** * @since 3.0 + * + * @param array $link_details + * @param string $length + * + * @return string */ public static function format_link_html( $link_details, $length = 'label' ) { $link = ''; @@ -1235,6 +1269,11 @@ public static function format_link_html( $link_details, $length = 'label' ) { /** * @since 3.0 + * + * @param int $id + * @param string $status + * + * @return array */ public static function delete_trash_info( $id, $status ) { $labels = self::delete_trash_links( $id ); @@ -1256,6 +1295,9 @@ public static function delete_trash_info( $id, $status ) { /** * @since 3.0 + * + * @param int $id + * @return array */ public static function delete_trash_links( $id ) { $current_page = FrmAppHelper::get_simple_request( array( 'param' => 'form_type' ) ); @@ -1329,6 +1371,9 @@ public static function css_classes() { return apply_filters( 'frm_layout_classes', $classes ); } + /** + * @return array + */ public static function grid_classes() { return array( 'frm_half' => '1/2', @@ -1344,6 +1389,11 @@ public static function grid_classes() { /** * @since 3.0 + * + * @param mixed $style + * @param string $class + * + * @return string */ public static function style_class_label( $style, $class ) { $label = ''; @@ -1358,6 +1408,11 @@ public static function style_class_label( $style, $class ) { return $label; } + /** + * @param string $status + * + * @return string + */ public static function status_nice_name( $status ) { $nice_names = array( 'draft' => __( 'Draft', 'formidable' ), @@ -1524,6 +1579,10 @@ public static function plan_is_allowed( $args ) { * about which plan is required. * * @since 4.0 + * + * @param string $requires + * @param string $link + * @return void */ public static function show_plan_required( $requires, $link ) { if ( empty( $requires ) ) { diff --git a/classes/helpers/FrmFormsListHelper.php b/classes/helpers/FrmFormsListHelper.php index b233c95f48..70ba176f13 100644 --- a/classes/helpers/FrmFormsListHelper.php +++ b/classes/helpers/FrmFormsListHelper.php @@ -151,6 +151,8 @@ public function get_bulk_actions() { } /** + * @param string $which + * * @return void */ public function extra_tablenav( $which ) { diff --git a/classes/helpers/FrmListHelper.php b/classes/helpers/FrmListHelper.php index 176e189c30..813e40427d 100644 --- a/classes/helpers/FrmListHelper.php +++ b/classes/helpers/FrmListHelper.php @@ -100,6 +100,9 @@ class FrmListHelper { /** * Construct the table object + * + * @param array $args + * @return void */ public function __construct( $args ) { $args = wp_parse_args( @@ -169,6 +172,9 @@ public function prepare_items() { /** * @since 3.0 + * + * @param array $args + * @return array|string */ protected function get_param( $args ) { return FrmAppHelper::get_simple_request( @@ -1106,6 +1112,9 @@ protected function display_tablenav( $which ) { * When close together, it feels like duplicates. * * @since 4.07 + * + * @param int $limit + * @return bool */ protected function has_min_items( $limit = 5 ) { return $this->has_items() && ( $this->total_items === false || $this->total_items >= $limit ); diff --git a/classes/helpers/FrmOnSubmitHelper.php b/classes/helpers/FrmOnSubmitHelper.php index c5a3c2fb1a..aaa2e56f65 100644 --- a/classes/helpers/FrmOnSubmitHelper.php +++ b/classes/helpers/FrmOnSubmitHelper.php @@ -427,6 +427,8 @@ public static function get_fallback_action_after_open_in_new_tab( $event ) { * * @since 6.1.1 * + * @param array $atts + * * @return string */ public static function current_event( $atts ) { diff --git a/classes/helpers/FrmStylesHelper.php b/classes/helpers/FrmStylesHelper.php index d38d486aea..e1b99518ff 100644 --- a/classes/helpers/FrmStylesHelper.php +++ b/classes/helpers/FrmStylesHelper.php @@ -134,6 +134,11 @@ public static function arrow_icons() { /** * @since 2.0 + * + * @param int|string $key Icon key. + * @param string $icon Icon state, `+` or `-`. + * @param string $type Icon type, such as `arrow`. + * * @return string The class for this icon. */ public static function icon_key_to_class( $key, $icon = '+', $type = 'arrow' ) { @@ -253,6 +258,9 @@ private static function get_rgb_array_from_hex( $hex ) { /** * @since 4.0 + * + * @param string $hex Hex color string. + * @param float|int|string $a Alpha channel value. */ public static function hex2rgba( $hex, $a ) { $rgb = self::hex2rgb( $hex ); @@ -410,6 +418,7 @@ public static function get_color_brightness( $color ) { * * @since 6.0 * + * @param string $color Color value, passed by reference. * @return void */ private static function fill_hex( &$color ) { @@ -420,6 +429,9 @@ private static function fill_hex( &$color ) { /** * @since 4.05.02 + * + * @param array $vars CSS variable keys. + * @return array */ public static function get_css_vars( $vars = array() ) { $vars = apply_filters( 'frm_css_vars', $vars ); @@ -428,6 +440,11 @@ public static function get_css_vars( $vars = array() ) { /** * @since 4.05.02 + * + * @param array $settings Style settings. + * @param array $defaults Default style settings. + * @param array $vars CSS variable keys to output. + * @return void */ public static function output_vars( $settings, $defaults = array(), $vars = array() ) { if ( empty( $vars ) ) { @@ -655,6 +672,7 @@ public static function get_settings_for_output( $style ) { * @since 6.14 * * @param array $settings An array of css style. + * @param array $defaults Default style settings. * * @return array */ @@ -695,6 +713,10 @@ function ( $key ) use ( $defaults, $font_size, $base_font_size, &$settings ) { * * @since 6.14 * + * @param string $key Setting key. + * @param int $value Base font size value. + * @param array $defaults Default style settings. + * * @return float */ private static function get_base_font_size_scale( $key, $value, $defaults ) { @@ -707,6 +729,10 @@ private static function get_base_font_size_scale( $key, $value, $defaults ) { /** * @since 2.3 + * + * @param array $settings Style settings, passed by reference. + * @param bool $allow_transparent Whether transparent colors are allowed. + * @return void */ public static function prepare_color_output( &$settings, $allow_transparent = true ) { $colors = self::allow_color_override(); @@ -755,6 +781,10 @@ private static function allow_color_override() { /** * @since 2.3 + * + * @param string $default Default color value. + * @param string $color Color value, passed by reference. + * @return void */ private static function get_color_output( $default, &$color ) { $color = trim( $color ); @@ -799,6 +829,9 @@ private static function is_hex( $color ) { * adjust the field description margin at a different screen size * * @since 2.3 + * + * @param string $width Label width value. + * @return false|string */ private static function description_margin_for_screensize( $width ) { $temp_label_width = str_replace( 'px', '', $width ); diff --git a/classes/helpers/FrmXMLHelper.php b/classes/helpers/FrmXMLHelper.php index cc715c36b0..eead897256 100644 --- a/classes/helpers/FrmXMLHelper.php +++ b/classes/helpers/FrmXMLHelper.php @@ -357,6 +357,9 @@ private static function get_form_fields( $form_id ) { /** * Delete any fields attached to this form that were not included in the template + * + * @param array $form_fields + * @return void */ private static function delete_removed_fields( $form_fields ) { if ( ! empty( $form_fields ) ) { @@ -434,6 +437,12 @@ private static function maybe_update_child_form_parent_id( $imported_forms, $chi * @since 2.0.13 * * TODO: Cut down on params + * + * @param SimpleXMLElement $xml_fields + * @param int|string $form_id + * @param object $this_form + * @param array $form_fields + * @param array $imported */ private static function import_xml_fields( $xml_fields, $form_id, $this_form, &$form_fields, &$imported ) { $in_section = 0; @@ -550,6 +559,9 @@ private static function fill_field( $field, $form_id ) { /** * @since 4.06 + * + * @param array $f + * @return void */ private static function set_default_value( &$f ) { $has_default = array( @@ -578,6 +590,9 @@ private static function set_default_value( &$f ) { * Make sure the required indicator is set. * * @since 4.05 + * + * @param array $f + * @return void */ private static function maybe_add_required( &$f ) { if ( $f['required'] && ! isset( $f['field_options']['required_indicator'] ) ) { @@ -591,6 +606,7 @@ private static function maybe_add_required( &$f ) { * @since 2.0.25 * @param int $in_section * @param array $f + * @return void */ private static function maybe_update_in_section_variable( &$in_section, &$f ) { // If we're at the end of a section, switch $in_section is 0 @@ -639,6 +655,7 @@ private static function maybe_update_form_select( &$f, $imported ) { * * @param array $imported * @param array $f + * @return void */ private static function maybe_update_get_values_form_setting( $imported, &$f ) { if ( ! isset( $imported['forms'] ) ) { @@ -657,6 +674,9 @@ private static function maybe_update_get_values_form_setting( $imported, &$f ) { * If field settings have been migrated, update the values during import. * * @since 4.0 + * + * @param array $f + * @return void */ private static function run_field_migrations( &$f ) { self::migrate_placeholders( $f ); @@ -665,6 +685,9 @@ private static function run_field_migrations( &$f ) { /** * @since 4.0 + * + * @param array $f + * @return void */ private static function migrate_placeholders( &$f ) { $update_values = self::migrate_field_placeholder( $f, 'clear_on_focus' ); @@ -683,6 +706,10 @@ private static function migrate_placeholders( &$f ) { * Also called during database migration in FrmMigrate. * * @since 4.0 + * + * @param array $field + * @param string $type + * * @return array */ public static function migrate_field_placeholder( $field, $type ) { @@ -731,6 +758,7 @@ public static function migrate_field_placeholder( $field, $type ) { * * @param array $f * @param array $imported + * @return void */ private static function create_imported_field( $f, &$imported ) { $f = self::update_field_options_with_defaults( $f ); @@ -786,6 +814,7 @@ private static function maybe_import_images_for_options( $field ) { * @since 4.07 * @param int $form_id * @param array $keys_by_original_field_id + * @return void */ protected static function maybe_update_field_ids( $form_id, $keys_by_original_field_id ) { global $frm_duplicate_ids; @@ -827,6 +856,7 @@ protected static function maybe_update_field_ids( $form_id, $keys_by_original_fi * @since 2.0.19 * * @param array $form + * @return void */ private static function update_custom_style_setting_on_import( &$form ) { if ( ! isset( $form['options']['custom_style'] ) ) { @@ -864,6 +894,9 @@ private static function update_custom_style_setting_on_import( &$form ) { * and link them back up. * * @since 2.2.7 + * + * @param int|string $form_id + * @return void */ private static function update_custom_style_setting_after_import( $form_id ) { $form = FrmForm::getOne( $form_id ); @@ -1016,6 +1049,7 @@ public static function import_xml_views( $views, $imported ) { * Clears styles from cache for imported forms * * @param array $imported_forms + * @return void */ private static function clear_forms_style_caches( $imported_forms ) { $where = array( @@ -1302,6 +1336,10 @@ private static function populate_taxonomies( &$post, $item ) { /** * Edit post if the key and created time match. + * + * @param array $post By reference. + * + * @return void */ private static function maybe_editing_post( &$post ) { $match_by = array( @@ -1576,6 +1614,10 @@ public static function prepare_form_options_for_export( $options ) { * This keeps file size down and prevents overriding global settings after import * * @since 3.06 + * + * @param array $options By reference. + * + * @return void */ private static function remove_default_form_options( &$options ) { $defaults = FrmFormsHelper::get_default_opts(); @@ -1589,6 +1631,10 @@ private static function remove_default_form_options( &$options ) { * Remove extra settings from field to keep file size down * * @since 3.06 + * + * @param object $field + * + * @return void */ public static function prepare_field_for_export( &$field ) { self::remove_default_field_options( $field ); @@ -1599,6 +1645,9 @@ public static function prepare_field_for_export( &$field ) { * Remove defaults from field options too * * @since 3.06 + * + * @param object $field + * @return void */ private static function remove_default_field_options( &$field ) { $defaults = self::default_field_options( $field->type ); @@ -1660,6 +1709,10 @@ private static function add_image_src_to_image_options( $field ) { /** * @since 3.06.03 + * + * @param string $type + * + * @return array */ private static function default_field_options( $type ) { $defaults = FrmFieldsHelper::get_default_field_options( $type ); @@ -1674,6 +1727,11 @@ private static function default_field_options( $type ) { * remove if they are the same * * @since 3.06 + * + * @param array $defaults + * @param array $saved + * + * @return void */ private static function remove_defaults( $defaults, &$saved ) { foreach ( $saved as $key => $value ) { @@ -1687,6 +1745,12 @@ private static function remove_defaults( $defaults, &$saved ) { * The line endings may prevent html from being equal when it should * * @since 3.06 + * + * @param string $html_name + * @param array $defaults + * @param array $options + * + * @return void */ private static function remove_default_html( $html_name, $defaults, &$options ) { if ( ! isset( $options[ $html_name ] ) || ! isset( $defaults[ $html_name ] ) ) { @@ -1708,6 +1772,11 @@ private static function remove_default_html( $html_name, $defaults, &$options ) } } + /** + * @param string $str + * + * @return string + */ public static function cdata( $str ) { FrmAppHelper::unserialize_or_decode( $str ); if ( is_array( $str ) ) { @@ -1734,12 +1803,24 @@ public static function cdata( $str ) { * @since 2.0.22 * * @param string $str + * + * @return void */ private static function remove_invalid_characters_from_xml( &$str ) { // Remove character $str = str_replace( '\x1F', '', $str ); } + /** + * Migrate form settings to actions + * + * @param array $form_options + * @param int $form_id + * @param array $imported + * @param bool $switch + * + * @return void + */ public static function migrate_form_settings_to_actions( $form_options, $form_id, &$imported = array(), $switch = false ) { // Get post type $post_type = FrmFormActionsController::$action_post_type; @@ -1880,6 +1961,17 @@ private static function switch_action_field_ids( $post_content, $basic_fields, $ return $post_content; } + /** + * Migrate email settings to action + * + * @param array $form_options + * @param int $form_id + * @param string $post_type + * @param array $imported + * @param bool $switch + * + * @return void + */ private static function migrate_email_settings_to_action( $form_options, $form_id, $post_type, &$imported, $switch ) { // No old notifications or autoresponders to carry over if ( ! isset( $form_options['auto_responder'] ) && ! isset( $form_options['notification'] ) && ! isset( $form_options['email_to'] ) ) { @@ -1943,6 +2035,8 @@ private static function migrate_email_settings_to_action( $form_options, $form_i * * @param int|string $form_id * @param array $form_options + * + * @return void */ private static function remove_deprecated_notification_settings( $form_id, $form_options ) { $delete_settings = array( 'notification', 'autoresponder', 'email_to' ); @@ -1954,6 +2048,15 @@ private static function remove_deprecated_notification_settings( $form_id, $form FrmForm::update( $form_id, array( 'options' => $form_options ) ); } + /** + * Migrate notifications to action + * + * @param array $form_options + * @param int $form_id + * @param array $notifications + * + * @return void + */ private static function migrate_notifications_to_action( $form_options, $form_id, &$notifications ) { if ( ! isset( $form_options['notification'] ) && ! empty( $form_options['email_to'] ) ) { // add old settings into notification array @@ -1991,6 +2094,14 @@ private static function migrate_notifications_to_action( $form_options, $form_id }//end if } + /** + * Format email data + * + * @param array $atts + * @param array $notification + * + * @return void + */ private static function format_email_data( &$atts, $notification ) { // Format email_to self::format_email_to_data( $atts, $notification ); @@ -2021,6 +2132,14 @@ private static function format_email_data( &$atts, $notification ) { } } + /** + * Format email_to data + * + * @param array $atts + * @param array $notification + * + * @return void + */ private static function format_email_to_data( &$atts, $notification ) { if ( isset( $notification['email_to'] ) ) { $atts['email_to'] = preg_split( '/ (,|;) /', $notification['email_to'] ); @@ -2051,6 +2170,15 @@ private static function format_email_to_data( &$atts, $notification ) { $atts['email_to'] = implode( ', ', $atts['email_to'] ); } + /** + * Setup new notification + * + * @param array $new_notification + * @param array $notification + * @param array $atts + * + * @return void + */ private static function setup_new_notification( &$new_notification, $notification, $atts ) { // Set up new notification $new_notification = array( @@ -2087,6 +2215,8 @@ private static function setup_new_notification( &$new_notification, $notificatio * Switch field IDs in pre-2.0 email conditional logic * * @param array $post_content Pass by reference. + * + * @return void */ private static function switch_email_condition_field_ids( &$post_content ) { // Switch field IDs in conditional logic @@ -2100,6 +2230,15 @@ private static function switch_email_condition_field_ids( &$post_content ) { } } + /** + * Migrate autoresponder to action + * + * @param array $form_options + * @param int $form_id + * @param array $notifications + * + * @return void + */ private static function migrate_autoresponder_to_action( $form_options, $form_id, &$notifications ) { if ( isset( $form_options['auto_responder'] ) && $form_options['auto_responder'] && isset( $form_options['ar_email_message'] ) && $form_options['ar_email_message'] ) { // migrate autoresponder @@ -2159,6 +2298,11 @@ public static function maybe_libxml_disable_entity_loader( $loader ) { return $loader; } + /** + * PHP 8 backward compatibility for the libxml_disable_entity_loader function + * + * @return bool + */ public static function check_if_libxml_disable_entity_loader_exists() { return version_compare( phpversion(), '8.0', '<' ) && ! function_exists( 'libxml_disable_entity_loader' ); } diff --git a/classes/models/FrmAddon.php b/classes/models/FrmAddon.php index f0c34cb78f..52b0312fc4 100644 --- a/classes/models/FrmAddon.php +++ b/classes/models/FrmAddon.php @@ -340,6 +340,10 @@ protected function delete_cache() { * We need an extra check before we allow it to show a message. * * @since 3.04.03 + * + * @param string $file File path of the plugin. + * @param array $plugin Plugin data. + * @return void */ public function maybe_show_license_message( $file, $plugin ) { if ( $this->is_expired_addon || isset( $plugin['package'] ) ) { @@ -350,6 +354,11 @@ public function maybe_show_license_message( $file, $plugin ) { $this->show_license_message( $file, $plugin ); } + /** + * @param string $file File path of the plugin. + * @param array $plugin Plugin data. + * @return void + */ public function show_license_message( $file, $plugin ) { $message = ''; if ( empty( $this->license ) ) { @@ -435,6 +444,9 @@ private function prepare_update_details( &$transient ) { * Get the API info for this plugin * * @since 3.04.03 + * + * @param string $license The license key. + * @return array The API info for the plugin. */ protected function get_api_info( $license ) { $api = new FrmFormApi( $license ); @@ -457,6 +469,9 @@ protected function get_api_info( $license ) { * don't save the transient expiration * * @since 2.05.05 + * + * @param object $version_info The version info for the plugin. + * @return void */ private function clear_old_plugin_version( &$version_info ) { $timeout = ! empty( $version_info->timeout ) ? $version_info->timeout : 0; @@ -473,6 +488,9 @@ private function clear_old_plugin_version( &$version_info ) { * Check if the beta should be downloaded. * * @since 3.04.03 + * + * @param object $version_info The version info for the plugin. + * @return void */ private function maybe_use_beta_url( &$version_info ) { if ( $this->get_beta && ! empty( $version_info->beta ) ) { @@ -618,12 +636,20 @@ public static function activate() { /** * @since 4.08 + * + * @param string $license The license key. + * @param string $plugin_slug The plugin slug. + * @return array The response from the license activation. */ public static function activate_license_for_plugin( $license, $plugin_slug ) { $this_plugin = self::get_addon( $plugin_slug ); return $this_plugin->activate_license( $license ); } + /** + * @param string $license The license key. + * @return array The response from the license activation. + */ private function activate_license( $license ) { $this->set_license( $license ); $this->license = $license; @@ -782,6 +808,7 @@ private static function set_license_from_post() { } /** + * @param string $action * @return string */ public function send_mothership_request( $action ) { diff --git a/classes/models/FrmCreateFile.php b/classes/models/FrmCreateFile.php index ab8f250c6f..6619803545 100644 --- a/classes/models/FrmCreateFile.php +++ b/classes/models/FrmCreateFile.php @@ -29,6 +29,8 @@ public function __construct( $atts ) { /** * @since 3.0 * + * @param array $atts Attributes. + * * @return void */ private function set_new_file_path( $atts ) { @@ -62,6 +64,8 @@ public function create_file( $file_content ) { /** * @since 3.0 * + * @param string $file_content File content. + * * @return void */ public function append_file( $file_content ) { @@ -98,6 +102,8 @@ public function combine_files( $file_names ) { /** * @since 3.0 + * + * @return string */ public function get_file_contents() { $content = ''; @@ -111,6 +117,10 @@ public function get_file_contents() { /** * @since 3.0 + * + * @param string $file File. + * + * @return string */ private function get_contents( $file = '' ) { global $wp_filesystem; diff --git a/classes/models/FrmDb.php b/classes/models/FrmDb.php index f7b4adc970..41d6796375 100644 --- a/classes/models/FrmDb.php +++ b/classes/models/FrmDb.php @@ -356,6 +356,10 @@ private static function get_group_and_table_name( &$table, &$group ) { * Only remove the db prefix when at the beginning. * * @since 4.04.02 + * + * @param string $prefix Prefix to remove. + * @param string $name Name to strip prefix from, passed by reference. + * @return void */ private static function maybe_remove_prefix( $prefix, &$name ) { if ( substr( $name, 0, strlen( $prefix ) ) === $prefix ) { @@ -448,6 +452,9 @@ private static function generate_query_string_from_pieces( $columns, $table, $wh /** * @since 2.05.07 + * + * @param array $args Query arguments, passed by reference. + * @return void */ private static function esc_query_args( &$args ) { foreach ( $args as $param => $value ) { @@ -516,6 +523,9 @@ public static function esc_order( $order_query ) { * Make sure this is ordering by either ASC or DESC * * @since 2.05.06 + * + * @param string $order_by Sort direction, passed by reference. + * @return void */ public static function esc_order_by( &$order_by ) { $sort_options = array( 'asc', 'desc' ); @@ -554,6 +564,10 @@ public static function esc_limit( $limit ) { * Get an array of values ready to go through $wpdb->prepare * * @since 2.05.06 + * + * @param array $array Array of values. + * @param string $type Placeholder type. + * @return string */ public static function prepare_array_values( $array, $type = '%s' ) { $placeholders = array_fill( 0, count( $array ), $type ); @@ -652,6 +666,7 @@ public static function save_json_post( $settings ) { * @param string $group The name of the cache group. * @param string $query If blank, don't run a db call. * @param string $type The wpdb function to use with this query. + * @param int $time Cache expiration time in seconds. * * @return mixed $results The cache or query results */ @@ -680,6 +695,12 @@ public static function check_cache( $cache_key, $group = '', $query = '', $type /** * @since 2.05.06 + * + * @param string $cache_key The unique name for this cache. + * @param mixed $results Cached results. + * @param string $group The name of the cache group. + * @param int $time Cache expiration time in seconds. + * @return void */ public static function set_cache( $cache_key, $results, $group = '', $time = 300 ) { if ( ! FrmAppHelper::prevent_caching() ) { @@ -693,6 +714,10 @@ public static function set_cache( $cache_key, $results, $group = '', $time = 300 * in Redis and Memcache * * @since 2.05.06 + * + * @param string $key Cache key. + * @param string $group Cache group name. + * @return void */ public static function add_key_to_group_cache( $key, $group ) { $cached = self::get_group_cached_keys( $group ); @@ -702,6 +727,9 @@ public static function add_key_to_group_cache( $key, $group ) { /** * @since 2.05.06 + * + * @param string $group Cache group name. + * @return array */ public static function get_group_cached_keys( $group ) { $cached = wp_cache_get( 'cached_keys', $group ); @@ -715,7 +743,9 @@ public static function get_group_cached_keys( $group ) { /** * @since 2.05.06 * - * @param string $cache_key + * @param string $cache_key Cache key to delete. + * @param string $group Cache group name. + * @return void */ public static function delete_cache_and_transient( $cache_key, $group = 'default' ) { delete_transient( $cache_key ); @@ -728,6 +758,7 @@ public static function delete_cache_and_transient( $cache_key, $group = 'default * @since 2.05.06 * * @param string $group The name of the cache group. + * @return void */ public static function cache_delete_group( $group ) { $cached_keys = self::get_group_cached_keys( $group ); diff --git a/classes/models/FrmEntry.php b/classes/models/FrmEntry.php index bc18eb2bd4..d9d56c3275 100644 --- a/classes/models/FrmEntry.php +++ b/classes/models/FrmEntry.php @@ -64,6 +64,9 @@ private static function flag_new_unique_key( $unique_id ) { /** * Check for duplicate entries created in the last minute * + * @param array $new_values New values. + * @param array $values Values. + * * @return bool */ public static function is_duplicate( $new_values, $values ) { @@ -316,8 +319,9 @@ public static function update( $id, $values ) { * * @since 2.0.16 * - * @param int $id - * @param array $values + * @param int $id + * @param array $values + * @param string $update_type * * @return bool|int $query_results */ @@ -411,6 +415,10 @@ public static function clear_cache() { * we can no longer use 'name', but check it as a fallback * * @since 2.0.11 + * + * @param array $values + * @param array|string $default + * @return string */ public static function get_new_entry_name( $values, $default = '' ) { $name = $values['item_name'] ?? $values['name'] ?? $default; @@ -692,7 +700,9 @@ public static function getRecordCount( $where = '' ) { } /** - * @param int|string $p_size + * @param int|string $p_size + * @param array|int|string $where + * * @return int */ public static function getPageCount( $p_size, $where = '' ) { diff --git a/classes/models/FrmEntryFormatter.php b/classes/models/FrmEntryFormatter.php index 73c6c91fcf..d7da63c2ec 100644 --- a/classes/models/FrmEntryFormatter.php +++ b/classes/models/FrmEntryFormatter.php @@ -344,6 +344,9 @@ protected function init_is_clickable( $atts ) { * interaction with processing field values like time format. * * @since 3.0 + * + * @param array $atts + * @return void */ protected function init_atts( $atts ) { $atts['source'] = 'entry_formatter'; diff --git a/classes/models/FrmEntryMeta.php b/classes/models/FrmEntryMeta.php index e248398cf4..51b07c6a5b 100644 --- a/classes/models/FrmEntryMeta.php +++ b/classes/models/FrmEntryMeta.php @@ -80,6 +80,10 @@ public static function update_entry_meta( $entry_id, $field_id, $meta_key, $meta /** * @since 3.0 + * + * @param array $values + * + * @return void */ private static function set_value_before_save( &$values ) { $field = FrmField::getOne( $values['field_id'] ); @@ -92,6 +96,11 @@ private static function set_value_before_save( &$values ) { /** * @since 3.0 + * + * @param array $atts + * @param mixed $value + * + * @return void */ private static function get_value_to_save( $atts, &$value ) { if ( is_object( $atts['field'] ) ) { @@ -432,6 +441,11 @@ private static function should_join_fields_table( &$where ) { * @param array|string $where * @param string $order_by * @param string $limit + * @param bool $unique + * @param array $args + * @param array $query + * + * @return void */ private static function get_ids_query( $where, $order_by, $limit, $unique, $args, array &$query ) { global $wpdb; diff --git a/classes/models/FrmEntryValidate.php b/classes/models/FrmEntryValidate.php index f123814fde..bef0ad3f26 100644 --- a/classes/models/FrmEntryValidate.php +++ b/classes/models/FrmEntryValidate.php @@ -320,6 +320,9 @@ private static function is_filtered_match( $value, $option_value ) { * * @since 6.21 * + * @param object $field_object The field object. + * @param array|string $value The value to validate. + * * @return bool */ private static function options_are_dynamic_based_on_hook( $field_object, $value ) { @@ -590,6 +593,7 @@ public static function blacklist_check( $values ) { /** * Check entries for Akismet spam * + * @param array $values Entry values. * @return bool true if is spam */ public static function akismet( $values ) { @@ -619,6 +623,10 @@ public static function akismet( $values ) { /** * @since 2.0 + * + * @param array $datas The array of values being sent to Akismet. + * @param array $values Entry values. + * @return void */ private static function parse_akismet_array( &$datas, $values ) { self::add_site_info_to_akismet( $datas ); diff --git a/classes/models/FrmField.php b/classes/models/FrmField.php index 71194ae29c..0cfb89bef9 100644 --- a/classes/models/FrmField.php +++ b/classes/models/FrmField.php @@ -442,6 +442,11 @@ function ( $match ) { * Process the field duplication. * * @since 5.0.05 + * + * @param int|string $field_id Field ID. + * @param int|string $form_id Form ID. + * + * @return array|false */ public static function duplicate_single_field( $field_id, $form_id ) { $copy_field = self::getOne( $field_id ); @@ -963,6 +968,9 @@ public static function getAll( $where = array(), $order_by = '', $limit = '', $b /** * @since 2.0.8 + * + * @param array|object $results Results. + * @return void */ private static function format_field_results( &$results ) { if ( is_array( $results ) ) { @@ -1009,6 +1017,9 @@ private static function add_slashes_to_format_before_setting_field_cache( $resul * Unserialize all the serialized field data * * @since 2.0 + * + * @param object $results + * @return void */ private static function prepare_options( &$results ) { FrmAppHelper::unserialize_or_decode( $results->field_options ); @@ -1032,6 +1043,11 @@ private static function prepare_options( &$results ) { * We'll break them into groups of 200 * * @since 2.0.1 + * + * @param int|string $form_id Form ID. + * @param array $args Additional arguments. + * + * @return array */ private static function get_fields_from_transients( $form_id, $args ) { $fields = array(); @@ -1044,6 +1060,12 @@ private static function get_fields_from_transients( $form_id, $args ) { * Called by get_fields_from_transients * * @since 2.0.1 + * + * @param array $fields Array of fields. + * @param string $base_name Base name. + * @param int $next Next transient number. + * + * @return void */ private static function get_next_transient( &$fields, $base_name, $next = 0 ) { $name = $next ? $base_name . $next : $base_name; @@ -1064,6 +1086,13 @@ private static function get_next_transient( &$fields, $base_name, $next = 0 ) { * Save the transients in chunks for large forms * * @since 2.0.1 + * + * @param array $fields Array of fields. + * @param int|string $form_id Form ID. + * @param int $next Next transient number. + * @param array $args Additional arguments. + * + * @return void */ private static function set_field_transient( &$fields, $form_id, $next = 0, $args = array() ) { $base_name = 'frm_form_fields_' . $form_id . $args['inc_embed'] . $args['inc_repeat']; @@ -1137,6 +1166,8 @@ public static function get_field_type( $field ) { /** * @since 3.0 + * + * @param array|object $field * @return string */ public static function get_original_field_type( $field ) { @@ -1155,6 +1186,8 @@ public static function get_original_field_type( $field ) { * Check if this is a multiselect dropdown field * * @since 2.0.9 + * + * @param array|object $field Field object. * @return bool */ public static function is_multiple_select( $field ) { diff --git a/classes/models/FrmFieldFormHtml.php b/classes/models/FrmFieldFormHtml.php index 12597f7b87..144963a481 100644 --- a/classes/models/FrmFieldFormHtml.php +++ b/classes/models/FrmFieldFormHtml.php @@ -170,6 +170,10 @@ private function replace_required_label_shortcode() { * In this case, we don't want to run the wp shortcodes with the description included. * * @since 3.0 + * + * @param bool $wp_processed + * + * @return void */ private function maybe_replace_description_shortcode( $wp_processed = false ) { $is_html = 'html' === $this->field_obj->get_field_column( 'type' ); @@ -205,6 +209,11 @@ private function maybe_add_description_id() { * Insert an ID if it doesn't exist. * * @since 3.06.02 + * + * @param string $param + * @param string $id + * + * @return void */ private function add_element_id( $param, $id ) { preg_match_all( '/(\[if\s+' . $param . '\])(.*?)(\[\/if\s+' . $param . '\])/mis', $this->html, $inner_html ); diff --git a/classes/models/FrmFieldValueSelector.php b/classes/models/FrmFieldValueSelector.php index 07501ccae9..ac5648e8f3 100644 --- a/classes/models/FrmFieldValueSelector.php +++ b/classes/models/FrmFieldValueSelector.php @@ -86,7 +86,8 @@ class FrmFieldValueSelector { /** * FrmFieldValueSelector constructor * - * @param int|string $field_id + * @param int|string $field_id Field ID. + * @param array $args Arguments for configuring the value selector. */ public function __construct( $field_id, $args ) { $this->set_html_name( $args ); diff --git a/classes/models/FrmForm.php b/classes/models/FrmForm.php index f3ea7174e0..aa9a988176 100644 --- a/classes/models/FrmForm.php +++ b/classes/models/FrmForm.php @@ -70,6 +70,13 @@ private static function maybe_filter_form_options( $options ) { } /** + * Duplicate a form. + * + * @param int $id Form ID to duplicate. + * @param bool $template Whether the duplicated form is a template. + * @param bool $copy_keys Whether to copy the original form key. + * @param false|int $blog_id Blog ID when duplicating across sites, or false for current site. + * * @return bool|int ID on success or false on failure */ public static function duplicate( $id, $template = false, $copy_keys = false, $blog_id = false ) { @@ -219,6 +226,12 @@ private static function switch_field_ids_in_field( $field ) { } /** + * Update a form. + * + * @param int $id Form ID. + * @param array $values Form values to update. + * @param bool $create_link Whether this is being called from link creation. + * * @return bool|int */ public static function update( $id, $values, $create_link = false ) { @@ -302,6 +315,8 @@ public static function set_update_options( $new_values, $values, $args = array() } /** + * @param int $id Form ID. + * @param array $values Form values array. * @return array */ public static function update_fields( $id, $values ) { @@ -490,6 +505,10 @@ private static function normalize_calc_spaces( $calc ) { /** * Updating the settings page + * + * @param array $values Form values array. + * @param object $field Field object, passed by reference. + * @return void */ private static function get_settings_page_html( $values, &$field ) { if ( isset( $values['field_options'][ 'custom_html_' . $field->id ] ) ) { @@ -598,6 +617,7 @@ public static function set_status( $id, $status ) { } /** + * @param int|string $id Form ID. * @return bool|int */ public static function trash( $id ) { @@ -648,6 +668,7 @@ public static function trash( $id ) { } /** + * @param int|string $id Form ID. * @return bool|int */ public static function destroy( $id ) { @@ -691,6 +712,7 @@ public static function destroy( $id ) { /** * Delete trashed forms based on how long they have been trashed * + * @param int|string $delete_timestamp Timestamp cutoff for deletion. * @return int The number of forms deleted */ public static function scheduled_delete( $delete_timestamp = '' ) { @@ -723,6 +745,7 @@ public static function scheduled_delete( $delete_timestamp = '' ) { } /** + * @param int|string $id Form ID or key. * @return string form name */ public static function getName( $id ) { @@ -851,6 +874,9 @@ private static function prepare_form_row_data( $row ) { } /** + * @param array|string $where Where conditions array or raw WHERE string. + * @param string $order_by Order by clause. + * @param int|string $limit Limit clause or number. * @return array|object of objects */ public static function getAll( $where = array(), $order_by = '', $limit = '' ) { @@ -968,11 +994,11 @@ public static function clear_form_cache() { } /** + * @param array $values Form values to validate. * @return array of errors */ public static function validate( $values ) { $errors = array(); - return apply_filters( 'frm_validate_form', $errors, $values ); } @@ -1183,6 +1209,9 @@ public static function show_submit( $form ) { /** * @since 2.3 + * + * @param array $atts Attributes including form, option, and default. + * @return mixed */ public static function get_option( $atts ) { $form = $atts['form']; diff --git a/classes/models/FrmFormAction.php b/classes/models/FrmFormAction.php index 07a6a087e1..e8f9d0be33 100644 --- a/classes/models/FrmFormAction.php +++ b/classes/models/FrmFormAction.php @@ -181,6 +181,9 @@ public function __construct( $id_base, $name, $action_options = array(), $contro /** * @param string $id_base + * @param string $name + * @param array $action_options + * @param array $control_options */ public function FrmFormAction( $id_base, $name, $action_options = array(), $control_options = array() ) { self::__construct( $id_base, $name, $action_options, $control_options ); @@ -203,6 +206,10 @@ public function maybe_switch_field_ids( $action ) { /** * @since 4.0 + * + * @param array $action_options + * + * @return array */ protected function get_group( $action_options ) { $groups = FrmFormActionsController::form_action_groups(); @@ -231,6 +238,7 @@ protected function get_group( $action_options ) { * This function should be used in form() methods to create name attributes for fields to be saved by update() * * @param string $field_name Field name. + * @param string $post_field * * @return string Name attribute for $field_name */ @@ -265,6 +273,8 @@ public function _set( $number ) { } /** + * @param false|int|string $form_id + * * @return object */ public function prepare_new( $form_id = false ) { @@ -297,6 +307,11 @@ public function prepare_new( $form_id = false ) { return (object) $form_action; } + /** + * @param int|string $form_id + * + * @return int|WP_Error + */ public function create( $form_id ) { $this->form_id = $form_id; @@ -306,6 +321,9 @@ public function create( $form_id ) { } /** + * @param int|string $form_id + * @param int|string $old_id + * * @return void */ public function duplicate_form_actions( $form_id, $old_id ) { @@ -330,6 +348,8 @@ public function duplicate_form_actions( $form_id, $old_id ) { * @since 2.0 * * @param array $action + * @param array $forms + * * @return int $post_id */ public function maybe_create_action( $action, $forms ) { @@ -347,7 +367,10 @@ public function maybe_create_action( $action, $forms ) { } /** - * @param object $action + * @param object $action + * @param int|string $form_id + * + * @return int|WP_Error */ public function duplicate_one( $action, $form_id ) { global $frm_duplicate_ids; @@ -410,6 +433,10 @@ private function duplicate_array_walk( $action, $subkey, $val ) { * Deal with changed settings. * * Do NOT over-ride this function + * + * @param int|string $form_id + * + * @return array|null */ public function update_callback( $form_id ) { $this->form_id = $form_id; @@ -518,8 +545,14 @@ public function save_settings( $settings ) { return FrmDb::save_settings( $settings, 'frm_actions' ); } + /** + * @param int $id + * + * @return object|null + */ public function get_single_action( $id ) { $action = get_post( $id ); + if ( $action ) { $action = $this->prepare_action( $action ); $this->_set( $id ); @@ -621,7 +654,10 @@ protected static function prepare_get_action( &$args, $default_status = 'publish } /** - * @param int $action_id + * @param int $action_id + * @param string $type + * + * @return bool|object */ public static function get_single_action_type( $action_id, $type ) { if ( ! $type ) { @@ -637,16 +673,22 @@ public static function get_single_action_type( $action_id, $type ) { } /** - * @param int $form_id + * @param int $form_id + * @param string $type * * @return bool */ public static function form_has_action_type( $form_id, $type ) { - $payment_actions = self::get_action_for_form( $form_id, $type ); - - return ! empty( $payment_actions ); + $actions = self::get_action_for_form( $form_id, $type ); + return ! empty( $actions ); } + /** + * @param false|int|string $form_id + * @param array $atts + * + * @return array + */ public function get_all( $form_id = false, $atts = array() ) { if ( is_array( $atts ) && ! isset( $atts['limit'] ) && $this->action_options['limit'] > 99 ) { $atts['limit'] = $this->action_options['limit']; @@ -698,6 +740,9 @@ public function get_all( $form_id = false, $atts = array() ) { } /** + * @param int $form_id + * @param int $limit + * * @return array */ public static function action_args( $form_id = 0, $limit = 99 ) { @@ -717,7 +762,8 @@ public static function action_args( $form_id = 0, $limit = 99 ) { } /** - * @param array|WP_Post $action + * @param WP_Post $action + * @return WP_Post */ public function prepare_action( $action ) { $action->post_content = (array) FrmAppHelper::maybe_json_decode( $action->post_content ); @@ -745,6 +791,9 @@ public function prepare_action( $action ) { } /** + * @param false|int|string $form_id + * @param string $type + * * @return void */ public function destroy( $form_id = false, $type = 'default' ) { @@ -814,6 +863,11 @@ public function get_global_switch_fields() { /** * Migrate settings from form->options into new action. + * + * @param object $form + * @param string $update + * + * @return int|WP_Error */ public function migrate_to_2( $form, $update = 'update' ) { $action = $this->prepare_new( $form->id ); diff --git a/classes/models/FrmFormApi.php b/classes/models/FrmFormApi.php index 2b4752dcfc..16b0eba3c2 100644 --- a/classes/models/FrmFormApi.php +++ b/classes/models/FrmFormApi.php @@ -29,6 +29,9 @@ class FrmFormApi { /** * @since 3.06 + * + * @param string|null $license The license key. + * @return void */ public function __construct( $license = null ) { $this->set_license( $license ); @@ -38,6 +41,7 @@ public function __construct( $license = null ) { /** * @since 3.06 * + * @param string|null $license The license key. * @return void */ private function set_license( $license ) { @@ -386,6 +390,8 @@ public function error_for_license() { /** * @since 3.06 + * + * @param array $addons * @return array */ public function get_error_from_response( $addons = array() ) { diff --git a/classes/models/FrmFormMigrator.php b/classes/models/FrmFormMigrator.php index e7e8172eb2..cd7a93af82 100644 --- a/classes/models/FrmFormMigrator.php +++ b/classes/models/FrmFormMigrator.php @@ -159,6 +159,10 @@ public function import_forms() { /** * Import a single form + * + * @param int $source_id Source form ID. + * + * @return array */ protected function import_form( $source_id ) { @@ -209,6 +213,12 @@ protected function prepare_form( $form, &$new_form ) { // customize this function } + /** + * @param array $fields + * @param array $form + * + * @return void + */ protected function prepare_fields( $fields, &$form ) { $field_order = 1; @@ -280,6 +290,9 @@ protected function fields_with_end() { /** * @since 4.04.03 + * + * @param array $fields + * @return void */ protected function maybe_add_end_fields( &$fields ) { $with_end = $this->fields_with_end(); @@ -315,6 +328,11 @@ protected function maybe_add_end_fields( &$fields ) { /** * @since 4.04.03 + * + * @param array $fields + * @param int $order + * + * @return void */ protected function insert_end_section( &$fields, &$order ) { $sub = FrmFieldsHelper::setup_new_vars( 'end_divider' ); @@ -329,6 +347,13 @@ protected function insert_end_section( &$fields, &$order ) { * This switches the name field to individual fields. * * @since 4.04.03 + * + * @param array $subs + * @param int $start + * @param int $remove + * @param array $fields + * + * @return void */ protected function insert_fields_in_array( $subs, $start, $remove, &$fields ) { array_splice( $fields, $start, $remove, $subs ); @@ -400,6 +425,10 @@ protected function create_form( $form ) { /** * @since 4.04.03 + * + * @param array $form + * + * @return array */ protected function form_creation_error_response( $form ) { return array( @@ -425,7 +454,9 @@ protected function create_fields( $form_id, &$form ) { /** * @since 4.04.03 * - * @param array $form + * @param array $form + * @param int|string $form_id + * @return void */ protected function create_emails( $form, $form_id ) { foreach ( $form['actions'] as $action ) { diff --git a/classes/models/FrmMigrate.php b/classes/models/FrmMigrate.php index 3494a3b457..c7455a2733 100644 --- a/classes/models/FrmMigrate.php +++ b/classes/models/FrmMigrate.php @@ -457,6 +457,8 @@ private function migrate_to_97() { * Move clear_on_focus or default_blank to placeholder. * * @since 4.0 + * + * @param string $type Field option key to migrate. */ private function migrate_to_placeholder( $type = 'clear_on_focus' ) { $query = array( @@ -573,6 +575,9 @@ private function revert_widget_field_size() { * Divide by 9 to reverse the multiplication * * @since 3.0.05 + * + * @param string $size Size string to maybe convert, passed by reference. + * @return void */ private function maybe_convert_migrated_size( &$size ) { $has_px_size = ! empty( $size ) && strpos( $size, 'px' ); diff --git a/classes/models/FrmOnSubmitAction.php b/classes/models/FrmOnSubmitAction.php index aca2872fcb..0067b7e82a 100644 --- a/classes/models/FrmOnSubmitAction.php +++ b/classes/models/FrmOnSubmitAction.php @@ -39,6 +39,9 @@ public static function get_name() { } /** + * @param object $instance + * @param array $args + * * @return void */ public function form( $instance, $args = array() ) { diff --git a/classes/models/FrmPersonalData.php b/classes/models/FrmPersonalData.php index fe1506a667..3a3a0f1a8c 100644 --- a/classes/models/FrmPersonalData.php +++ b/classes/models/FrmPersonalData.php @@ -51,6 +51,9 @@ public function register_data_eraser( $erasers ) { } /** + * @param string $email + * @param int $page + * * @return array */ public function export_data( $email, $page = 1 ) { @@ -81,6 +84,9 @@ public function export_data( $email, $page = 1 ) { } /** + * @param string $email + * @param int $page + * * @return array */ public function erase_data( $email, $page = 1 ) { diff --git a/classes/models/FrmReviews.php b/classes/models/FrmReviews.php index ebacbae672..95543221ce 100644 --- a/classes/models/FrmReviews.php +++ b/classes/models/FrmReviews.php @@ -169,6 +169,9 @@ private function add_to_inbox( $title, $name, $asked ) { * * @since 4.05.02 * + * @param array $requests Array of requests. + * @param int $asked Number of times the review has been asked. + * * @return bool */ private function has_later_request( $requests, $asked ) { diff --git a/classes/models/FrmSettings.php b/classes/models/FrmSettings.php index a6ef697c54..19ce3c0da0 100644 --- a/classes/models/FrmSettings.php +++ b/classes/models/FrmSettings.php @@ -357,6 +357,7 @@ public function translatable_strings() { * * @since 3.06.01 * + * @param array $args * @return void */ public function maybe_filter_for_form( $args ) { @@ -445,6 +446,7 @@ private function update_settings( $params ) { } /** + * @param array $params * @return void */ private function update_roles( $params ) { diff --git a/classes/models/FrmSolution.php b/classes/models/FrmSolution.php index 95baa58fc4..bf43e912d8 100644 --- a/classes/models/FrmSolution.php +++ b/classes/models/FrmSolution.php @@ -180,6 +180,9 @@ protected function settings_link() { /** * Add page to global settings. + * + * @param array $sections Sections. + * @return array */ public function add_settings( $sections ) { wp_enqueue_style( 'formidable-pro-fields' ); @@ -417,6 +420,8 @@ protected function adjust_plugin_install_step( &$steps ) { } /** + * @param array $step Step. + * * @return void */ protected function step_top( $step ) { @@ -455,6 +460,8 @@ protected function step_top( $step ) { } /** + * @param array $step Step. + * * @return void */ protected function step_bottom( $step ) { @@ -467,6 +474,8 @@ protected function step_bottom( $step ) { /** * Generate and output Connect step section HTML. * + * @param array $step Step. + * * @return void */ protected function license_box( $step ) { @@ -486,6 +495,8 @@ protected function license_box( $step ) { } /** + * @param array $step Step. + * * @return void */ protected function show_plugin_install( $step ) { @@ -505,6 +516,8 @@ protected function show_plugin_install( $step ) { } /** + * @param array $step Step. + * * @return void */ protected function show_app_install( $step ) { @@ -582,6 +595,8 @@ protected function show_app_install( $step ) { } /** + * @param string $xml + * * @return void */ protected function show_form_options( $xml ) { @@ -648,6 +663,8 @@ protected function show_page_options() { } /** + * @param array $step + * * @return void */ protected function show_page_links( $step ) { diff --git a/classes/models/FrmSpamCheckWPDisallowedWords.php b/classes/models/FrmSpamCheckWPDisallowedWords.php index a7498e27bc..b39b60cad0 100644 --- a/classes/models/FrmSpamCheckWPDisallowedWords.php +++ b/classes/models/FrmSpamCheckWPDisallowedWords.php @@ -54,6 +54,13 @@ private function get_disallowed_words() { /** * For WP 5.5 compatibility. * + * @param string $author + * @param string $email + * @param string $url + * @param string $content + * @param string $ip + * @param string $user_agent + * * @return bool Return `true` if contains disallowed words. */ private function do_check_wp_disallowed_words( $author, $email, $url, $content, $ip, $user_agent ) { diff --git a/classes/models/FrmStyle.php b/classes/models/FrmStyle.php index b0cfba3fdf..28568fa77b 100644 --- a/classes/models/FrmStyle.php +++ b/classes/models/FrmStyle.php @@ -67,6 +67,8 @@ public function save( $settings ) { } /** + * @param int|string $id The id of the stylesheet or 'default'. + * * @return void */ public function duplicate( $id ) { diff --git a/classes/models/FrmUsage.php b/classes/models/FrmUsage.php index b0fa8ac2ea..524d9f3af3 100644 --- a/classes/models/FrmUsage.php +++ b/classes/models/FrmUsage.php @@ -45,6 +45,9 @@ public function send_snapshot() { /** * @since 3.06.04 + * + * @param bool $regenerate + * * @return string */ public function uuid( $regenerate = false ) { @@ -385,6 +388,9 @@ private function forms() { /** * @since 3.06.04 + * + * @param int|string $form_id Form ID. + * * @return int */ private function form_field_count( $form_id ) { @@ -403,6 +409,9 @@ private function form_field_count( $form_id ) { /** * @since 3.06.04 + * + * @param int|string $form_id Form ID. + * * @return int */ private function form_action_count( $form_id ) { @@ -471,6 +480,9 @@ private function tracking_allowed() { /** * @since 3.06.04 + * + * @param mixed $value Value. + * * @return string */ private function maybe_json( $value ) { diff --git a/classes/models/fields/FrmFieldCaptcha.php b/classes/models/fields/FrmFieldCaptcha.php index b84de5acf7..da03f45944 100644 --- a/classes/models/fields/FrmFieldCaptcha.php +++ b/classes/models/fields/FrmFieldCaptcha.php @@ -135,6 +135,9 @@ private function get_captcha_language() { } /** + * Load the captcha script. + * + * @param array $args * @return void */ protected function load_field_scripts( $args ) { diff --git a/classes/models/fields/FrmFieldCheckbox.php b/classes/models/fields/FrmFieldCheckbox.php index 533eb10961..6801c8f4f3 100644 --- a/classes/models/fields/FrmFieldCheckbox.php +++ b/classes/models/fields/FrmFieldCheckbox.php @@ -63,6 +63,9 @@ protected function new_field_settings() { * Get the type of field being displayed. * * @since 4.02.01 + * + * @param array|object $field + * * @return array */ public function displayed_field_type( $field ) { @@ -85,6 +88,8 @@ protected function extra_field_opts() { /** * @since 4.06 * + * @param array $args + * * @return void */ protected function show_priority_field_choices( $args = array() ) { diff --git a/classes/models/fields/FrmFieldDefault.php b/classes/models/fields/FrmFieldDefault.php index b8bf02997a..ff3974f6d7 100644 --- a/classes/models/fields/FrmFieldDefault.php +++ b/classes/models/fields/FrmFieldDefault.php @@ -27,6 +27,8 @@ protected function set_type( $type ) { } /** + * @param string $name + * * @return void */ public function show_on_form_builder( $name = '' ) { @@ -47,6 +49,8 @@ public function show_on_form_builder( $name = '' ) { /** * @param array $args + * @param array $shortcode_atts + * * @return string */ public function front_field_input( $args, $shortcode_atts ) { diff --git a/classes/models/fields/FrmFieldEmail.php b/classes/models/fields/FrmFieldEmail.php index 22e34a8d81..3c162b31dc 100644 --- a/classes/models/fields/FrmFieldEmail.php +++ b/classes/models/fields/FrmFieldEmail.php @@ -57,6 +57,7 @@ public function validate( $args ) { /** * @since 4.0.04 * + * @param array|string $value Email value passed by reference. * @return void */ public function sanitize_value( &$value ) { diff --git a/classes/models/fields/FrmFieldHTML.php b/classes/models/fields/FrmFieldHTML.php index 3ac0388a1a..1c892a4565 100644 --- a/classes/models/fields/FrmFieldHTML.php +++ b/classes/models/fields/FrmFieldHTML.php @@ -43,6 +43,11 @@ public function default_html() { /** * @since 3.0 + * + * @param array $args + * @param string $html + * + * @return string */ protected function after_replace_html_shortcodes( $args, $html ) { FrmFieldsHelper::run_wpautop( array( 'wpautop' => true ), $html ); diff --git a/classes/models/fields/FrmFieldName.php b/classes/models/fields/FrmFieldName.php index c3e51907ca..6b43d207be 100644 --- a/classes/models/fields/FrmFieldName.php +++ b/classes/models/fields/FrmFieldName.php @@ -170,6 +170,7 @@ protected function prepare_display_value( $value, $atts ) { /** * @since 4.0.04 * + * @param array|string $value * @return void */ public function sanitize_value( &$value ) { diff --git a/classes/models/fields/FrmFieldNumber.php b/classes/models/fields/FrmFieldNumber.php index 08df02f398..3ba77a312d 100644 --- a/classes/models/fields/FrmFieldNumber.php +++ b/classes/models/fields/FrmFieldNumber.php @@ -49,6 +49,9 @@ protected function extra_field_opts() { /** * @since 3.01.03 * + * @param array $args + * @param string $input_html + * * @return void */ protected function add_extra_html_atts( $args, &$input_html ) { @@ -163,6 +166,9 @@ private function remove_commas_from_number( &$args ) { /** * Force the value to be numeric before it's saved in the DB + * + * @param array|string $value + * @return float */ public function set_value_before_save( $value ) { if ( ! is_numeric( $value ) ) { @@ -175,6 +181,7 @@ public function set_value_before_save( $value ) { /** * @since 4.0.04 * + * @param array|string $value * @return void */ public function sanitize_value( &$value ) { diff --git a/classes/models/fields/FrmFieldPhone.php b/classes/models/fields/FrmFieldPhone.php index 64ad861901..becd53436e 100644 --- a/classes/models/fields/FrmFieldPhone.php +++ b/classes/models/fields/FrmFieldPhone.php @@ -82,6 +82,7 @@ protected function html5_input_type() { /** * @since 4.0.04 * + * @param array|string $value * @return void */ public function sanitize_value( &$value ) { diff --git a/classes/models/fields/FrmFieldRadio.php b/classes/models/fields/FrmFieldRadio.php index b4ee7435a2..fd20751bff 100644 --- a/classes/models/fields/FrmFieldRadio.php +++ b/classes/models/fields/FrmFieldRadio.php @@ -54,6 +54,9 @@ protected function field_settings_for_type() { * Get the type of field being displayed. * * @since 4.02.01 + * + * @param array|object $field + * * @return array */ public function displayed_field_type( $field ) { @@ -90,6 +93,8 @@ protected function new_field_settings() { /** * @since 4.06 * + * @param array $args + * * @return void */ protected function show_priority_field_choices( $args = array() ) { diff --git a/classes/models/fields/FrmFieldSelect.php b/classes/models/fields/FrmFieldSelect.php index 8e5ab5c7e2..e660a025de 100644 --- a/classes/models/fields/FrmFieldSelect.php +++ b/classes/models/fields/FrmFieldSelect.php @@ -53,6 +53,9 @@ protected function new_field_settings() { * Get the type of field being displayed. * * @since 4.02.01 + * + * @param array|object $field + * * @return array */ public function displayed_field_type( $field ) { diff --git a/classes/models/fields/FrmFieldType.php b/classes/models/fields/FrmFieldType.php index 59bf21d2f2..8eb9d91626 100644 --- a/classes/models/fields/FrmFieldType.php +++ b/classes/models/fields/FrmFieldType.php @@ -436,6 +436,10 @@ protected function alter_builder_classes( $classes ) { /** * @since 3.01.01 + * + * @param array $field Field settings array. + * @param array $display Display settings. + * @param array $values Form values. */ public function show_options( $field, $display, $values ) { do_action( 'frm_' . $field['type'] . '_field_options_form', $field, $display, $values ); @@ -474,6 +478,8 @@ public function show_field_choices( $args ) { /** * @since 4.04 + * + * @param array $args Includes 'field', 'display', and 'values'. */ public function show_field_options( $args ) { if ( ! $this->should_continue_to_field_options( $args ) ) { @@ -593,6 +599,8 @@ protected function get_bulk_edit_string() { /** * @since 4.04 + * + * @param array $args Includes field configuration. */ protected function show_single_option( $args ) { FrmFieldsHelper::show_single_option( $args['field'] ); @@ -609,6 +617,9 @@ protected function extra_field_choices_class() { * Should the section for adding choices show for this field? * * @since 4.02.01 + * + * @param array|object $field Field settings array. + * @return bool */ protected function has_field_choices( $field ) { return ! empty( $this->displayed_field_type( $field ) ); @@ -618,6 +629,9 @@ protected function has_field_choices( $field ) { * Get the type of field being displayed for lookups and dynamic fields. * * @since 4.02.01 + * + * @param array|object $field Field settings array. + * * @return array */ public function displayed_field_type( $field ) { @@ -715,6 +729,8 @@ public function show_after_default( $args ) { /** * @since 4.0 + * + * @param mixed $default_value Default value passed by reference. */ public function default_value_to_string( &$default_value ) { if ( ! is_array( $default_value ) ) { @@ -892,6 +908,7 @@ public function show_field( $args ) { } /** + * @param array $args Field rendering arguments. * @return void */ protected function get_field_scripts_hook( $args ) { @@ -954,6 +971,12 @@ protected function before_replace_html_shortcodes( $args, $html ) { return $html; } + /** + * @param array $args + * @param string $html + * + * @return string + */ protected function after_replace_html_shortcodes( $args, $html ) { return $html; } @@ -1141,6 +1164,10 @@ protected function prepare_esc_value() { * using the frm_field_input_html hook * * @since 3.01.03 + * + * @param array $args + * @param string $input_html + * @return void */ protected function add_extra_html_atts( $args, &$input_html ) { // override from other fields @@ -1149,6 +1176,9 @@ protected function add_extra_html_atts( $args, &$input_html ) { /** * @since 3.01.03 * + * @param array $args + * @param string $input_html + * * @return void */ protected function add_min_max( $args, &$input_html ) { @@ -1247,6 +1277,12 @@ protected function show_hidden_values( $args ) { return $hidden; } + /** + * @param string $selected + * @param array $args + * + * @return string + */ protected function show_single_hidden( $selected, $args ) { if ( $args['save_array'] ) { $args['field_name'] .= '[]'; @@ -1260,6 +1296,10 @@ protected function show_single_hidden( $selected, $args ) { /** * @since 3.0 + * + * @param array $values + * + * @return string */ protected function get_select_box( $values ) { $options = $this->get_field_column( 'options' ); @@ -1284,6 +1324,10 @@ protected function get_select_box( $values ) { /** * @since 3.0 + * + * @param array $values + * + * @return string */ protected function select_tag( $values ) { $field = $values['field'] ?? $this->field; @@ -1317,6 +1361,12 @@ protected function get_select_attributes( $values ) { return $select_atts; } + /** + * Load field scripts. + * + * @param array $args + * @return void + */ protected function load_field_scripts( $args ) { // Override me } @@ -1418,6 +1468,8 @@ public function validate( $args ) { /** * @since 4.02 + * + * @param mixed $value Value passed by reference. */ public function maybe_trim_excess_values( &$value ) { // Override in a child class. @@ -1723,6 +1775,9 @@ protected function fill_values( &$value, $defaults ) { /** * @since 4.0.04 + * + * @param array|string $value + * @return void */ public function sanitize_value( &$value ) { $unsanitized_value = $value; diff --git a/classes/models/fields/FrmFieldUrl.php b/classes/models/fields/FrmFieldUrl.php index b4d626060b..8991e60f1e 100644 --- a/classes/models/fields/FrmFieldUrl.php +++ b/classes/models/fields/FrmFieldUrl.php @@ -48,6 +48,7 @@ protected function get_field_name() { } /** + * @param array $atts * @return void */ protected function fill_default_atts( &$atts ) { @@ -106,6 +107,7 @@ protected function prepare_display_value( $value, $atts ) { /** * @since 4.0.04 * + * @param array|string $value * @return void */ public function sanitize_value( &$value ) { diff --git a/classes/models/fields/FrmFieldUserID.php b/classes/models/fields/FrmFieldUserID.php index d3c2c1d991..690e01d129 100644 --- a/classes/models/fields/FrmFieldUserID.php +++ b/classes/models/fields/FrmFieldUserID.php @@ -54,6 +54,8 @@ public function prepare_field_html( $args ) { /** * @since 4.03.06 + * + * @param array $args Field display arguments. */ protected function get_field_value( $args ) { $user_ID = get_current_user_id(); @@ -131,6 +133,8 @@ protected function prepare_import_value( $value, $atts ) { /** * @since 4.0.04 * + * @param mixed $value Field value passed by reference. + * * @return void */ public function sanitize_value( &$value ) { diff --git a/classes/views/frm-form-actions/email_action.php b/classes/views/frm-form-actions/email_action.php index 2d72936a00..3844126614 100644 --- a/classes/views/frm-form-actions/email_action.php +++ b/classes/views/frm-form-actions/email_action.php @@ -20,6 +20,9 @@ public function __construct() { } /** + * @param object $form_action + * @param array $args + * * @return void */ public function form( $form_action, $args = array() ) { diff --git a/classes/views/styles/components/FrmAlignStyleComponent.php b/classes/views/styles/components/FrmAlignStyleComponent.php index e00ffcc79c..cc3ae3ea90 100644 --- a/classes/views/styles/components/FrmAlignStyleComponent.php +++ b/classes/views/styles/components/FrmAlignStyleComponent.php @@ -17,6 +17,10 @@ class FrmAlignStyleComponent extends FrmStyleComponent { * Construct the FrmAlignStyleComponent. * * @since 6.14 + * + * @param string $field_name Field name attribute. + * @param mixed $field_value Current field value. + * @param array $data Additional component data. */ public function __construct( $field_name, $field_value, $data ) { $this->init( $data, $field_name, $field_value ); diff --git a/classes/views/styles/components/FrmBackgroundImageStyleComponent.php b/classes/views/styles/components/FrmBackgroundImageStyleComponent.php index e6a5a329ca..d543302c19 100644 --- a/classes/views/styles/components/FrmBackgroundImageStyleComponent.php +++ b/classes/views/styles/components/FrmBackgroundImageStyleComponent.php @@ -16,7 +16,9 @@ class FrmBackgroundImageStyleComponent extends FrmStyleComponent { /** * Construct FrmBackgroundImageStyleComponent. * - * @since 6.14 + * @param string $field_name Field name attribute. + * @param mixed $field_value Current field value. + * @param array $data Additional component data. */ public function __construct( $field_name, $field_value, $data ) { $this->init( $data, $field_name, $field_value ); diff --git a/classes/views/styles/components/FrmColorpickerStyleComponent.php b/classes/views/styles/components/FrmColorpickerStyleComponent.php index a16c3df0f8..aecaf196b8 100644 --- a/classes/views/styles/components/FrmColorpickerStyleComponent.php +++ b/classes/views/styles/components/FrmColorpickerStyleComponent.php @@ -17,6 +17,10 @@ class FrmColorpickerStyleComponent extends FrmStyleComponent { * Construct FrmColorpickerStyleComponent. * * @since 6.14 + * + * @param string $field_name Field name attribute. + * @param mixed $field_value Current field value. + * @param array $data Additional component data. */ public function __construct( $field_name, $field_value, $data ) { $this->init( $data, $field_name, $field_value ); diff --git a/classes/views/styles/components/FrmDirectionStyleComponent.php b/classes/views/styles/components/FrmDirectionStyleComponent.php index a6a157ea29..3f731fa40c 100644 --- a/classes/views/styles/components/FrmDirectionStyleComponent.php +++ b/classes/views/styles/components/FrmDirectionStyleComponent.php @@ -17,6 +17,10 @@ class FrmDirectionStyleComponent extends FrmStyleComponent { * Construct FrmDirectionStyleComponent. * * @since 6.14 + * + * @param string $field_name Field name attribute. + * @param mixed $field_value Current field value. + * @param array $data Additional component data. */ public function __construct( $field_name, $field_value, $data ) { $this->init( $data, $field_name, $field_value ); diff --git a/classes/views/styles/components/FrmDropdownStyleComponent.php b/classes/views/styles/components/FrmDropdownStyleComponent.php index 432f0a337e..9e3f0e715d 100644 --- a/classes/views/styles/components/FrmDropdownStyleComponent.php +++ b/classes/views/styles/components/FrmDropdownStyleComponent.php @@ -17,6 +17,10 @@ class FrmDropdownStyleComponent extends FrmStyleComponent { * Construct FrmDropdownStyleComponent. * * @since 6.14 + * + * @param string $field_name Field name attribute. + * @param mixed $field_value Current field value. + * @param array $data Additional component data. */ public function __construct( $field_name, $field_value, $data ) { $this->init( $data, $field_name, $field_value ); diff --git a/classes/views/styles/components/FrmFieldShapeStyleComponent.php b/classes/views/styles/components/FrmFieldShapeStyleComponent.php index e095556999..d05d969dda 100644 --- a/classes/views/styles/components/FrmFieldShapeStyleComponent.php +++ b/classes/views/styles/components/FrmFieldShapeStyleComponent.php @@ -17,6 +17,10 @@ class FrmFieldShapeStyleComponent extends FrmStyleComponent { * Construct the FrmFieldShapeStyleComponent. * * @since 6.14 + * + * @param string $field_name Field name attribute. + * @param mixed $field_value Current field value. + * @param array $data Additional component data. */ public function __construct( $field_name, $field_value, $data ) { $this->init( $data, $field_name, $field_value ); diff --git a/classes/views/styles/components/FrmPrimaryColorStyleComponent.php b/classes/views/styles/components/FrmPrimaryColorStyleComponent.php index ba44245d95..03b6eeb20f 100644 --- a/classes/views/styles/components/FrmPrimaryColorStyleComponent.php +++ b/classes/views/styles/components/FrmPrimaryColorStyleComponent.php @@ -17,6 +17,10 @@ class FrmPrimaryColorStyleComponent extends FrmStyleComponent { * Construct FrmPrimaryColorStyleComponent. * * @since 6.14 + * + * @param string $field_name Field name attribute. + * @param mixed $field_value Current field value. + * @param array $data Additional component data. */ public function __construct( $field_name, $field_value, $data ) { $this->init( $data, $field_name, $field_value ); diff --git a/classes/views/styles/components/FrmSliderStyleComponent.php b/classes/views/styles/components/FrmSliderStyleComponent.php index 2dd5f2b5d7..b6cfacb6ce 100644 --- a/classes/views/styles/components/FrmSliderStyleComponent.php +++ b/classes/views/styles/components/FrmSliderStyleComponent.php @@ -139,6 +139,8 @@ private function get_values() { * * @since 6.14 * + * @param string|null $value + * * @return string */ private function detect_unit_measurement( $value = null ) { diff --git a/classes/views/styles/components/FrmTextToggleStyleComponent.php b/classes/views/styles/components/FrmTextToggleStyleComponent.php index 14ac3cd4de..feb4fcb90f 100644 --- a/classes/views/styles/components/FrmTextToggleStyleComponent.php +++ b/classes/views/styles/components/FrmTextToggleStyleComponent.php @@ -18,6 +18,10 @@ class FrmTextToggleStyleComponent extends FrmStyleComponent { * Construct FrmTextToggleStyleComponent. * * @since 6.24 + * + * @param string $field_name Field name attribute. + * @param mixed $field_value Current field value. + * @param array $data Additional component data. */ public function __construct( $field_name, $field_value, $data ) { $this->init( $data, $field_name, $field_value ); diff --git a/formidable.php b/formidable.php index 478472ff11..c42c51084c 100644 --- a/formidable.php +++ b/formidable.php @@ -59,6 +59,8 @@ function load_formidable_forms() { spl_autoload_register( 'frm_forms_autoloader' ); /** + * @param string $class_name Class name. + * * @return void */ function frm_forms_autoloader( $class_name ) { @@ -75,6 +77,9 @@ function frm_forms_autoloader( $class_name ) { * * @since 3.0 * + * @param string $class_name Class name. + * @param string $filepath File path. + * * @return void */ function frm_class_autoloader( $class_name, $filepath ) { diff --git a/phpcs.xml b/phpcs.xml index a01b86d81c..3bdaab9826 100644 --- a/phpcs.xml +++ b/phpcs.xml @@ -19,7 +19,6 @@ - diff --git a/phpstan.neon b/phpstan.neon index 3610e53fe2..47e34bb1ba 100644 --- a/phpstan.neon +++ b/phpstan.neon @@ -134,3 +134,6 @@ parameters: paths: - classes/views/* - stripe/views/action-settings/payments-options.php + - + message: '#FrmFormAction::prepare_action\(\) expects WP_Post, mixed given#' + path: classes/models/FrmFormAction.php diff --git a/square/helpers/FrmSquareLiteAppHelper.php b/square/helpers/FrmSquareLiteAppHelper.php index 63cd209722..af0fe7ac07 100644 --- a/square/helpers/FrmSquareLiteAppHelper.php +++ b/square/helpers/FrmSquareLiteAppHelper.php @@ -54,6 +54,9 @@ public static function active_mode() { /** * Add education about Stripe fees. * + * @param string $medium Medium identifier for the tip (for example 'tip'). + * @param array|false|string $gateway Gateway or list of gateways this applies to. + * * @return void */ public static function fee_education( $medium = 'tip', $gateway = false ) { diff --git a/square/helpers/FrmSquareLiteConnectHelper.php b/square/helpers/FrmSquareLiteConnectHelper.php index 0acad7356e..bb2c856d0b 100644 --- a/square/helpers/FrmSquareLiteConnectHelper.php +++ b/square/helpers/FrmSquareLiteConnectHelper.php @@ -260,6 +260,9 @@ private static function get_uuid() { /** * WPML might add a language to the url. Don't send that to the server. + * + * @param string $url URL to strip language from. + * @return string */ private static function strip_lang_from_url( $url ) { $split_on_language = explode( '/?lang=', $url ); @@ -273,7 +276,7 @@ private static function strip_lang_from_url( $url ) { * WPML alters the output of home_url. * If it is active, use the WPML "absolute home" URL which is not modified. * - * @param string $url + * @param string $url URL to maybe fix. * @return string */ private static function maybe_fix_wpml_url( $url ) { @@ -369,6 +372,7 @@ private static function get_merchant_id_option_name( $mode = 'auto' ) { } /** + * @param string $mode either 'auto', 'live', or 'test'. * @return string */ private static function get_location_id_option_name( $mode = 'auto' ) { @@ -384,7 +388,7 @@ private static function get_merchant_currency_option_name( $mode = 'auto' ) { } /** - * @param string $key 'merchant_id', 'client_password', 'server_password'. + * @param string $key 'merchant_id', 'client_password', 'server_password'. * @param string $mode either 'auto', 'live', or 'test'. * @return string */ @@ -545,7 +549,8 @@ public static function create_subscription( $info ) { } /** - * @param bool $force + * @param bool $force Whether to force refreshing the location id. + * @param string $mode Either 'auto', 'live', or 'test'. * @return false|string */ public static function get_location_id( $force = false, $mode = 'auto' ) { diff --git a/stripe/controllers/FrmTransLiteAppController.php b/stripe/controllers/FrmTransLiteAppController.php index 07a60a9a46..19bb28c2f6 100755 --- a/stripe/controllers/FrmTransLiteAppController.php +++ b/stripe/controllers/FrmTransLiteAppController.php @@ -6,6 +6,9 @@ class FrmTransLiteAppController { /** + * Install or upgrade database structures. + * + * @param mixed $old_db_version Previous database version, or false on fresh install. * @return void */ public static function install( $old_db_version = false ) { diff --git a/stripe/controllers/FrmTransLiteListsController.php b/stripe/controllers/FrmTransLiteListsController.php index a8ecc5bc97..2d5d9df16f 100755 --- a/stripe/controllers/FrmTransLiteListsController.php +++ b/stripe/controllers/FrmTransLiteListsController.php @@ -81,6 +81,11 @@ public static function payment_columns( $columns = array() ) { * viewing a payment or subscription * * @since 6.5 + * + * @param bool $show_screen Whether to show the screen options tab. + * @param object $screen The current screen. + * + * @return bool */ public static function remove_screen_options( $show_screen, $screen ) { if ( ! in_array( FrmAppHelper::simple_get( 'action', 'sanitize_title' ), array( 'edit', 'show', 'new', 'duplicate' ), true ) ) { diff --git a/stripe/helpers/FrmStrpLiteAppHelper.php b/stripe/helpers/FrmStrpLiteAppHelper.php index a334b1a85b..706f2db7d4 100644 --- a/stripe/helpers/FrmStrpLiteAppHelper.php +++ b/stripe/helpers/FrmStrpLiteAppHelper.php @@ -96,6 +96,9 @@ public static function active_mode() { /** * Add education about Stripe fees. * + * @param string $medium Medium identifier for the tip (for example 'tip'). + * @param array|false|string $gateway Gateway or list of gateways this applies to. + * * @return void */ public static function fee_education( $medium = 'tip', $gateway = false ) { diff --git a/stripe/helpers/FrmStrpLiteConnectHelper.php b/stripe/helpers/FrmStrpLiteConnectHelper.php index 92dc7dc5cd..5f4baad3bc 100644 --- a/stripe/helpers/FrmStrpLiteConnectHelper.php +++ b/stripe/helpers/FrmStrpLiteConnectHelper.php @@ -531,6 +531,9 @@ private static function maybe_fix_wpml_url( $url ) { /** * WPML might add a language to the url. Don't send that to the server. + * + * @param string $url URL. + * @return string */ private static function strip_lang_from_url( $url ) { $split_on_language = explode( '/?lang=', $url ); diff --git a/stripe/helpers/FrmTransLiteListHelper.php b/stripe/helpers/FrmTransLiteListHelper.php index 13fe8d2f8d..e543a08da4 100755 --- a/stripe/helpers/FrmTransLiteListHelper.php +++ b/stripe/helpers/FrmTransLiteListHelper.php @@ -452,6 +452,8 @@ private function get_created_at_column( $item, $atts ) { } /** + * @param object $item + * * @return string */ private function get_amount_column( $item ) { diff --git a/stripe/models/FrmStrpLiteAuth.php b/stripe/models/FrmStrpLiteAuth.php index 119292c1cb..d2d5e326bd 100644 --- a/stripe/models/FrmStrpLiteAuth.php +++ b/stripe/models/FrmStrpLiteAuth.php @@ -174,6 +174,11 @@ private static function prepare_success_atts( &$atts ) { * Insert a message/error where the form styling will be applied. * * @since 6.5, introduced in v2.0 of the Stripe add on. + * + * @param string $message Message. + * @param string $form Form. + * + * @return void */ private static function insert_error_message( $message, &$form ) { $add_after = '
'; diff --git a/stripe/models/FrmTransLiteDb.php b/stripe/models/FrmTransLiteDb.php index b048363e9d..49427981ba 100755 --- a/stripe/models/FrmTransLiteDb.php +++ b/stripe/models/FrmTransLiteDb.php @@ -281,6 +281,10 @@ private function fill_values( $values, &$new_values ) { } /** + * Run database migrations starting from a previous DB version. + * + * @param int $old_db_version Previous database version. + * * @return void */ private function migrate_data( $old_db_version ) { diff --git a/tests/cypress/e2e/Forms/formPageDataValidation.cy.js b/tests/cypress/e2e/Forms/formPageDataValidation.cy.js index 430703dd0a..f3da5b86a4 100644 --- a/tests/cypress/e2e/Forms/formPageDataValidation.cy.js +++ b/tests/cypress/e2e/Forms/formPageDataValidation.cy.js @@ -41,6 +41,7 @@ describe( 'Forms page', () => { 'tired of workarounds? build what you really need.', 'build powerful forms, web apps, dashboards, and more', 'black friday sales are happening now!', + 'save 65% on the best wordpress form builder', ] ).to.include( headingText ); } ); } ); diff --git a/tests/cypress/e2e/admin-a11y.cy.js b/tests/cypress/e2e/admin-a11y.cy.js index 4bed47ead1..c11b7cc79f 100644 --- a/tests/cypress/e2e/admin-a11y.cy.js +++ b/tests/cypress/e2e/admin-a11y.cy.js @@ -30,7 +30,8 @@ describe( 'Run some accessibility tests', function() { { id: 'color-contrast', enabled: false }, { id: 'aria-allowed-role', enabled: false }, { id: 'link-name', enabled: false }, - { id: 'link-in-text-block', enabled: false } + { id: 'link-in-text-block', enabled: false }, + { id: 'region', enabled: false }, ]; it( 'Check the dashboard page is accessible', () => {