| @@ -4,226 +4,365 @@ | ||
| 4 | 4 | } |
| 5 | 5 | |
| 6 | 6 | class FrmField { |
| 7 | 7 | |
| 8 | + /** | |
| 9 | + * @var bool | |
| 10 | + */ | |
| 8 | 11 | public static $use_cache = true; |
| 12 | + | |
| 13 | + /** | |
| 14 | + * @var int | |
| 15 | + */ | |
| 9 | 16 | public static $transient_size = 200; |
| 10 | 17 | |
| 18 | + /** | |
| 19 | + * @return array | |
| 20 | + */ | |
| 11 | 21 | public static function field_selection() { |
| 12 | - $frm_settings = FrmAppHelper::get_settings(); | |
| 13 | - $active_captcha = $frm_settings->active_captcha; | |
| 14 | - if ( ! FrmFieldCaptcha::should_show_captcha() ) { | |
| 15 | - $captcha_name = 'Captcha'; | |
| 16 | - } elseif ( $active_captcha === 'recaptcha' ) { | |
| 17 | - $captcha_name = 'reCAPTCHA'; | |
| 18 | - } else { | |
| 19 | - $captcha_name = 'hCaptcha'; | |
| 20 | - } | |
| 21 | 22 | $fields = array( |
| 22 | - 'text' => array( | |
| 23 | + 'text' => array( | |
| 23 | 24 | 'name' => __( 'Text', 'formidable' ), |
| 24 | - 'icon' => 'frm_icon_font frm_text2_icon', | |
| 25 | + 'icon' => 'frmfont frm_text2_icon', | |
| 25 | 26 | ), |
| 26 | - 'textarea' => array( | |
| 27 | + 'textarea' => array( | |
| 27 | 28 | 'name' => __( 'Paragraph', 'formidable' ), |
| 28 | - 'icon' => 'frm_icon_font frm_paragraph_icon', | |
| 29 | + 'icon' => 'frmfont frm_paragraph_icon', | |
| 29 | 30 | ), |
| 30 | - 'checkbox' => array( | |
| 31 | + 'checkbox' => array( | |
| 31 | 32 | 'name' => __( 'Checkboxes', 'formidable' ), |
| 32 | - 'icon' => 'frm_icon_font frm_check_square_icon', | |
| 33 | + 'icon' => 'frmfont frm_check_square_icon', | |
| 33 | 34 | ), |
| 34 | - 'radio' => array( | |
| 35 | + 'radio' => array( | |
| 35 | 36 | 'name' => __( 'Radio Buttons', 'formidable' ), |
| 36 | - 'icon' => 'frm_icon_font frm_radio_checked_icon', | |
| 37 | + 'icon' => 'frmfont frm_radio_checked_icon', | |
| 37 | 38 | ), |
| 38 | - 'select' => array( | |
| 39 | + 'select' => array( | |
| 39 | 40 | 'name' => __( 'Dropdown', 'formidable' ), |
| 40 | - 'icon' => 'frm_icon_font frm_caret_square_down_icon', | |
| 41 | + 'icon' => 'frmfont frm_dropdown_icon', | |
| 41 | 42 | ), |
| 42 | - 'email' => array( | |
| 43 | + 'email' => array( | |
| 43 | 44 | 'name' => __( 'Email', 'formidable' ), |
| 44 | - 'icon' => 'frm_icon_font frm_email_icon', | |
| 45 | + 'icon' => 'frmfont frm_email2_icon', | |
| 45 | 46 | ), |
| 46 | - 'url' => array( | |
| 47 | + 'url' => array( | |
| 47 | 48 | 'name' => __( 'Website/URL', 'formidable' ), |
| 48 | - 'icon' => 'frm_icon_font frm_link_icon', | |
| 49 | + 'icon' => 'frmfont frm_link2_icon', | |
| 49 | 50 | ), |
| 50 | - 'number' => array( | |
| 51 | + 'number' => array( | |
| 51 | 52 | 'name' => __( 'Number', 'formidable' ), |
| 52 | - 'icon' => 'frm_icon_font frm_hashtag_icon', | |
| 53 | + 'icon' => 'frmfont frm_hashtag_icon', | |
| 53 | 54 | ), |
| 54 | - 'name' => array( | |
| 55 | + 'name' => array( | |
| 55 | 56 | 'name' => __( 'Name', 'formidable' ), |
| 56 | - 'icon' => 'frm_icon_font frm_user_name_icon', | |
| 57 | + 'icon' => 'frmfont frm_user_name_icon', | |
| 57 | 58 | ), |
| 58 | - 'phone' => array( | |
| 59 | + 'phone' => array( | |
| 59 | 60 | 'name' => __( 'Phone', 'formidable' ), |
| 60 | - 'icon' => 'frm_icon_font frm_phone_icon', | |
| 61 | + 'icon' => 'frmfont frm_phone_icon', | |
| 61 | 62 | ), |
| 62 | - 'html' => array( | |
| 63 | + 'html' => array( | |
| 63 | 64 | 'name' => __( 'HTML', 'formidable' ), |
| 64 | - 'icon' => 'frm_icon_font frm_code_icon', | |
| 65 | + 'icon' => 'frmfont frm_code2_icon', | |
| 65 | 66 | ), |
| 66 | - 'hidden' => array( | |
| 67 | + 'hidden' => array( | |
| 67 | 68 | 'name' => __( 'Hidden', 'formidable' ), |
| 68 | - 'icon' => 'frm_icon_font frm_eye_slash_icon', | |
| 69 | + 'icon' => 'frmfont frm_eye_slash2_icon', | |
| 69 | 70 | ), |
| 70 | - 'user_id' => array( | |
| 71 | + 'user_id' => array( | |
| 71 | 72 | 'name' => __( 'User ID', 'formidable' ), |
| 72 | - 'icon' => 'frm_icon_font frm_user_icon', | |
| 73 | + 'icon' => 'frmfont frm_user2_icon', | |
| 73 | 74 | ), |
| 74 | - 'captcha' => array( | |
| 75 | - 'name' => $captcha_name, | |
| 76 | - 'icon' => 'frm_icon_font frm_shield_check_icon', | |
| 75 | + 'captcha' => array( | |
| 76 | + 'name' => self::get_captcha_field_name(), | |
| 77 | + 'icon' => 'frmfont frm_shield_check2_icon', | |
| 77 | 78 | ), |
| 79 | + 'credit_card' => array( | |
| 80 | + 'name' => __( 'Payment', 'formidable' ), | |
| 81 | + 'icon' => 'frmfont frm_credit_card2_icon', | |
| 82 | + ), | |
| 83 | + FrmSubmitHelper::FIELD_TYPE => array( | |
| 84 | + 'name' => __( 'Submit', 'formidable' ), | |
| 85 | + 'hide' => true, | |
| 86 | + ), | |
| 87 | + FrmFieldGdprHelper::FIELD_TYPE => array( | |
| 88 | + 'name' => __( 'GDPR', 'formidable' ), | |
| 89 | + 'icon' => 'frmfont frm-gdpr-icon', | |
| 90 | + 'hide' => FrmFieldGdprHelper::hide_gdpr_field(), | |
| 91 | + ), | |
| 92 | + 'product' => array( | |
| 93 | + 'name' => __( 'Product', 'formidable' ), | |
| 94 | + 'icon' => 'frmfont frm_product2_icon', | |
| 95 | + 'section' => 'pricing', | |
| 96 | + ), | |
| 97 | + 'quantity' => array( | |
| 98 | + 'name' => __( 'Quantity', 'formidable' ), | |
| 99 | + 'icon' => 'frmfont frm_quantity_icon', | |
| 100 | + 'section' => 'pricing', | |
| 101 | + ), | |
| 102 | + 'total' => array( | |
| 103 | + 'name' => __( 'Total', 'formidable' ), | |
| 104 | + 'icon' => 'frmfont frm_total2_icon', | |
| 105 | + 'section' => 'pricing', | |
| 106 | + ), | |
| 78 | 107 | ); |
| 79 | 108 | |
| 109 | + /** | |
| 110 | + * @param array $fields | |
| 111 | + */ | |
| 80 | 112 | return apply_filters( 'frm_available_fields', $fields ); |
| 81 | 113 | } |
| 82 | 114 | |
| 115 | + /** | |
| 116 | + * Get the name of the Captcha field based on the global Captcha setting. | |
| 117 | + * | |
| 118 | + * @return string | |
| 119 | + */ | |
| 120 | + private static function get_captcha_field_name() { | |
| 121 | + return 'Captcha'; | |
| 122 | + } | |
| 123 | + | |
| 124 | + /** | |
| 125 | + * @return array | |
| 126 | + */ | |
| 83 | 127 | public static function pro_field_selection() { |
| 84 | - $images_url = FrmAppHelper::plugin_url() . '/images/'; | |
| 85 | - $fields = array( | |
| 86 | - 'file' => array( | |
| 87 | - 'name' => __( 'File Upload', 'formidable' ), | |
| 88 | - 'icon' => 'frm_icon_font frm_upload_icon', | |
| 89 | - 'message' => 'Add file uploads to save time and cut down on back-and-forth. Upgrade to Pro to get Upload fields and more.', | |
| 128 | + $upsell_images_url = FrmAppHelper::plugin_url() . '/images/upsell/'; | |
| 129 | + $fields = array( | |
| 130 | + 'file' => array( | |
| 131 | + 'name' => __( 'File Upload', 'formidable' ), | |
| 132 | + 'icon' => 'frmfont frm_upload3_icon', | |
| 133 | + 'message' => __( 'Add file uploads to save time and cut down on back-and-forth. Upgrade to Pro to get Upload fields and more.', 'formidable' ), | |
| 134 | + 'upsell_image' => $upsell_images_url . 'file-upload-field-preview.webp', | |
| 135 | + 'learn-more' => 'features/wordpress-multiple-file-upload-form', | |
| 90 | 136 | ), |
| 91 | - 'rte' => array( | |
| 92 | - 'name' => __( 'Rich Text', 'formidable' ), | |
| 93 | - 'icon' => 'frm_icon_font frm_align_right_icon', | |
| 137 | + 'ranking' => array( | |
| 138 | + 'name' => __( 'Ranking', 'formidable' ), | |
| 139 | + 'icon' => 'frmfont frm_chart_bar_icon frm_show_upgrade', | |
| 140 | + 'message' => __( 'Now you can effortlessly gather insights, preferences, and opinions by allowing users to rank options.', 'formidable' ), | |
| 141 | + 'upsell_image' => $upsell_images_url . 'ranking-field-preview.webp', | |
| 142 | + 'addon' => 'surveys', | |
| 143 | + 'learn-more' => 'ranking-survey', | |
| 94 | 144 | ), |
| 95 | - 'date' => array( | |
| 96 | - 'name' => __( 'Date', 'formidable' ), | |
| 97 | - 'icon' => 'frm_icon_font frm_calendar_icon', | |
| 145 | + 'rte' => array( | |
| 146 | + 'name' => __( 'Rich Text', 'formidable' ), | |
| 147 | + 'icon' => 'frmfont frm_align_right_icon', | |
| 148 | + 'message' => __( 'Go beyond plain text, let your users format their content with bolding, italics, links, lists and more.', 'formidable' ), | |
| 149 | + 'upsell_image' => $upsell_images_url . 'rich-text-field-preview.webp', | |
| 150 | + 'learn-more' => 'rich-text', | |
| 98 | 151 | ), |
| 99 | - 'time' => array( | |
| 100 | - 'name' => __( 'Time', 'formidable' ), | |
| 101 | - 'icon' => 'frm_icon_font frm_clock_icon', | |
| 152 | + 'date' => array( | |
| 153 | + 'name' => __( 'Date', 'formidable' ), | |
| 154 | + 'icon' => 'frmfont frm_calendar2_icon', | |
| 155 | + 'message' => __( 'Capture exact calendar dates effortlessly with a sleek pop-up date picker, ensuring clarity and consistency for scheduling, tracking deadlines, and more.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 156 | + 'upsell_image' => $upsell_images_url . 'date-field-preview.webp', | |
| 157 | + 'learn-more' => 'date', | |
| 102 | 158 | ), |
| 103 | - 'scale' => array( | |
| 104 | - 'name' => __( 'Scale', 'formidable' ), | |
| 105 | - 'icon' => 'frm_icon_font frm_linear_scale_icon', | |
| 106 | - 'message' => 'Add a set of radio buttons with whatever range you choose. <img src="' . esc_attr( $images_url ) . 'scale_field.png" alt="Scale Field" />', | |
| 159 | + 'time' => array( | |
| 160 | + 'name' => __( 'Time', 'formidable' ), | |
| 161 | + 'icon' => 'frmfont frm_clock_icon', | |
| 162 | + 'message' => __( 'Precisely log important moments with an intuitive time selection tool, perfect for managing events, availability, or operational hours.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 163 | + 'upsell_image' => $upsell_images_url . 'time-field-preview.webp', | |
| 164 | + 'learn-more' => 'time', | |
| 107 | 165 | ), |
| 108 | - 'star' => array( | |
| 109 | - 'name' => __( 'Star Rating', 'formidable' ), | |
| 110 | - 'icon' => 'frm_icon_font frm_star_icon', | |
| 166 | + 'scale' => array( | |
| 167 | + 'name' => __( 'Scale', 'formidable' ), | |
| 168 | + 'icon' => 'frmfont frm_linear_scale_icon', | |
| 169 | + 'message' => esc_html__( 'Easily measure satisfaction or quantity using a simple, clear numerical scale, giving you fast, quantifiable insights into user feedback.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 170 | + 'upsell_image' => $upsell_images_url . 'scale-field-preview.webp', | |
| 171 | + 'learn-more' => 'scale', | |
| 111 | 172 | ), |
| 112 | - 'range' => array( | |
| 113 | - 'name' => __( 'Slider', 'formidable' ), | |
| 114 | - 'icon' => 'frm_icon_font frm_code_commit_icon', | |
| 173 | + 'star' => array( | |
| 174 | + 'name' => __( 'Star Rating', 'formidable' ), | |
| 175 | + 'icon' => 'frmfont frm_star2_icon', | |
| 176 | + 'message' => esc_html__( 'Capture instant, appealing feedback with a familiar visual star system, providing immediate and engaging quality assessments from your users.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 177 | + 'upsell_image' => $upsell_images_url . 'star-field-preview.webp', | |
| 178 | + 'learn-more' => 'star-ratings', | |
| 115 | 179 | ), |
| 116 | - 'toggle' => array( | |
| 117 | - 'name' => __( 'Toggle', 'formidable' ), | |
| 118 | - 'icon' => 'frm_icon_font frm_toggle_on_icon', | |
| 180 | + 'range' => array( | |
| 181 | + 'name' => __( 'Slider', 'formidable' ), | |
| 182 | + 'icon' => 'frmfont frm_code_commit_icon', | |
| 183 | + 'message' => esc_html__( 'Let users quickly select values within a range using a dynamic, interactive slider, creating a modern and enjoyable data input experience.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 184 | + 'upsell_image' => $upsell_images_url . 'slider-field-preview.webp', | |
| 185 | + 'learn-more' => 'slider', | |
| 119 | 186 | ), |
| 120 | - 'data' => array( | |
| 121 | - 'name' => __( 'Dynamic', 'formidable' ), | |
| 122 | - 'icon' => 'frm_icon_font frm_sitemap_icon', | |
| 123 | - 'message' => 'Create relationships between multiple forms. You can link a member to a team, a rating to a product, a comment to a submission, and much more.', | |
| 187 | + 'toggle' => array( | |
| 188 | + 'name' => __( 'Toggle', 'formidable' ), | |
| 189 | + 'icon' => 'frmfont frm_toggle_on_icon', | |
| 190 | + 'message' => esc_html__( 'Quickly and easily create cascading fields, populate fields by search and more.', 'formidable' ), | |
| 191 | + 'upsell_image' => $upsell_images_url . 'toggle-field-preview.webp', | |
| 192 | + 'learn-more' => 'toggle', | |
| 124 | 193 | ), |
| 125 | - 'lookup' => array( | |
| 126 | - 'name' => __( 'Lookup', 'formidable' ), | |
| 127 | - 'icon' => 'frm_icon_font frm_search_icon', | |
| 128 | - 'message' => 'Filter the options in the next field and automatically add values to other fields. Upgrade to Pro to get Lookup fields and more. <img src="' . esc_attr( $images_url ) . 'look-up_year-make-model.gif" alt="cascading lookup fields" />', | |
| 194 | + 'data' => array( | |
| 195 | + 'name' => __( 'Dynamic', 'formidable' ), | |
| 196 | + 'icon' => 'frmfont frm_dynamic_icon', | |
| 197 | + 'message' => __( 'Link entries together, dynamic display information, and even make selections from data entered on another form.', 'formidable' ), | |
| 198 | + 'upsell_image' => $upsell_images_url . 'dynamic-field-preview.webp', | |
| 199 | + 'learn-more' => 'dynamic', | |
| 129 | 200 | ), |
| 130 | - 'divider|repeat' => array( | |
| 131 | - 'name' => __( 'Repeater', 'formidable' ), | |
| 132 | - 'icon' => 'frm_icon_font frm_repeater_icon', | |
| 133 | - 'message' => 'Allow your visitors to add new sets of fields while filling out forms. Increase conversions while saving building time and server resources. <img src="' . esc_attr( $images_url ) . 'repeatable-section_frontend.gif" alt="Dynamically Add Form Fields with repeatable sections" />', | |
| 201 | + 'lookup' => array( | |
| 202 | + 'name' => __( 'Lookup', 'formidable' ), | |
| 203 | + 'icon' => 'frmfont frm_search_icon', | |
| 204 | + 'message' => esc_html__( 'Link entries together, dynamic display information, and even make selections from data entered on another form.', 'formidable' ), | |
| 205 | + 'upsell_image' => $upsell_images_url . 'lookup-field-preview.webp', | |
| 206 | + 'learn-more' => 'lookup', | |
| 134 | 207 | ), |
| 135 | - 'end_divider' => array( | |
| 208 | + 'divider|repeat' => array( | |
| 209 | + 'name' => __( 'Repeater', 'formidable' ), | |
| 210 | + 'icon' => 'frmfont frm_refresh_icon', | |
| 211 | + 'message' => esc_html__( 'Allow users to add rows of fields dynamically as needed (like for multiple attendees or items), making complex data entry flexible and intuitive.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 212 | + 'upsell_image' => $upsell_images_url . 'repeater-field-preview.webp', | |
| 213 | + 'learn-more' => 'repeatable-section', | |
| 214 | + ), | |
| 215 | + 'end_divider' => array( | |
| 136 | 216 | 'name' => __( 'Section Buttons', 'formidable' ), |
| 137 | 217 | 'switch_from' => 'divider', |
| 138 | 218 | ), |
| 139 | - 'divider' => array( | |
| 140 | - 'name' => __( 'Section', 'formidable' ), | |
| 141 | - 'icon' => 'frm_icon_font frm_header_icon', | |
| 219 | + 'divider' => array( | |
| 220 | + 'name' => __( 'Section', 'formidable' ), | |
| 221 | + 'icon' => 'frmfont frm_header_icon', | |
| 222 | + 'message' => esc_html__( 'Enhance the user experience and improve completion rates by dividing long surveys into clean, manageable steps with distinct pages.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 223 | + 'upsell_image' => $upsell_images_url . 'section-field-preview.webp', | |
| 224 | + 'learn-more' => 'section-heading', | |
| 142 | 225 | ), |
| 143 | - 'break' => array( | |
| 144 | - 'name' => __( 'Page Break', 'formidable' ), | |
| 145 | - 'icon' => 'frm_icon_font frm_page_break_icon', | |
| 146 | - 'message' => 'Get multi-paged forms with progress bars. Did you know you can upgrade to PRO to unlock multi-step forms with more awesome features?', | |
| 226 | + 'break' => array( | |
| 227 | + 'name' => __( 'Page Break', 'formidable' ), | |
| 228 | + 'icon' => 'frmfont frm_page_break_icon', | |
| 229 | + 'message' => esc_html__( 'Enhance the user experience and improve completion rates by dividing long surveys into clean, manageable steps with distinct pages.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 230 | + 'upsell_image' => $upsell_images_url . 'page-break-field-preview.webp', | |
| 231 | + 'learn-more' => 'page-breaks', | |
| 147 | 232 | ), |
| 148 | - 'form' => array( | |
| 149 | - 'name' => __( 'Embed Form', 'formidable' ), | |
| 150 | - 'icon' => 'frm_icon_font frm_file_text_icon', | |
| 233 | + 'form' => array( | |
| 234 | + 'name' => __( 'Embed Form', 'formidable' ), | |
| 235 | + 'icon' => 'frmfont frm_file_text2_icon', | |
| 236 | + 'message' => esc_html__( 'Seamlessly integrate other existing forms or external content directly inside your current form, creating powerful, interconnected workflows.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 237 | + 'upsell_image' => $upsell_images_url . 'embed-form-field-preview.webp', | |
| 238 | + 'learn-more' => 'embed-form', | |
| 151 | 239 | ), |
| 152 | - 'likert' => array( | |
| 153 | - 'name' => __( 'Likert Scale', 'formidable' ), | |
| 154 | - 'icon' => 'frm_icon_font frm_likert_scale frm_show_upgrade', | |
| 155 | - 'addon' => 'surveys', | |
| 240 | + 'likert' => array( | |
| 241 | + 'name' => __( 'Likert Scale', 'formidable' ), | |
| 242 | + 'icon' => 'frmfont frm_likert_scale frm_show_upgrade', | |
| 243 | + 'addon' => 'surveys', | |
| 244 | + 'message' => esc_html__( 'Get nuanced, detailed opinions using standardized agreement scales, unlocking deeper insights beyond simple yes/no answers.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 245 | + 'upsell_image' => $upsell_images_url . 'likert-field-preview.webp', | |
| 246 | + 'learn-more' => 'likert-scale', | |
| 156 | 247 | ), |
| 157 | - 'nps' => array( | |
| 158 | - 'name' => __( 'NPS', 'formidable' ), | |
| 159 | - 'icon' => 'frm_icon_font frm_nps frm_show_upgrade', | |
| 160 | - 'addon' => 'surveys', | |
| 248 | + 'nps' => array( | |
| 249 | + 'name' => __( 'NPS', 'formidable' ), | |
| 250 | + 'icon' => 'frmfont frm_nps frm_show_upgrade', | |
| 251 | + 'addon' => 'surveys', | |
| 252 | + 'message' => esc_html__( 'Directly measure customer loyalty with the industry-standard Net Promoter Score® field, giving you a single, vital metric for business growth.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 253 | + 'upsell_image' => $upsell_images_url . 'nps-field-preview.webp', | |
| 254 | + 'learn-more' => 'net-promoter-score', | |
| 161 | 255 | ), |
| 162 | - 'password' => array( | |
| 163 | - 'name' => __( 'Password', 'formidable' ), | |
| 164 | - 'icon' => 'frm_icon_font frm_lock_open_icon', | |
| 256 | + 'password' => array( | |
| 257 | + 'name' => __( 'Password', 'formidable' ), | |
| 258 | + 'icon' => 'frmfont frm_lock_closed2_icon', | |
| 259 | + 'message' => esc_html__( 'Confidently collect sensitive credentials or create secure sections with a dedicated field that masks input for privacy and security.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 260 | + 'upsell_image' => $upsell_images_url . 'password-field-preview.webp', | |
| 261 | + 'learn-more' => 'password-2', | |
| 165 | 262 | ), |
| 166 | - 'tag' => array( | |
| 167 | - 'name' => __( 'Tags', 'formidable' ), | |
| 168 | - 'icon' => 'frm_icon_font frm_price_tags_icon', | |
| 263 | + 'tag' => array( | |
| 264 | + 'name' => __( 'Tags', 'formidable' ), | |
| 265 | + 'icon' => 'frmfont frm_price_tags2_icon', | |
| 266 | + 'message' => esc_html__( 'Facilitate easy categorization and analysis by letting users select or create multiple relevant keywords or labels for their entry.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 267 | + 'upsell_image' => $upsell_images_url . 'tags-field-preview.webp', | |
| 268 | + 'learn-more' => 'tags', | |
| 169 | 269 | ), |
| 170 | - 'credit_card' => array( | |
| 171 | - 'name' => __( 'Credit Card', 'formidable' ), | |
| 172 | - 'icon' => 'frm_icon_font frm_credit_card_icon frm_show_upgrade', | |
| 173 | - 'addon' => 'stripe', | |
| 270 | + // This is no longer a Pro field, but without this here, Pro triggers "undefined index" notices. | |
| 271 | + // Right now it leaves a gap. Maybe we can skip anything without a name or something. | |
| 272 | + 'credit_card' => array( | |
| 273 | + 'name' => '', | |
| 274 | + 'icon' => '', | |
| 174 | 275 | ), |
| 175 | - 'address' => array( | |
| 176 | - 'name' => __( 'Address', 'formidable' ), | |
| 177 | - 'icon' => 'frm_icon_font frm_location_icon', | |
| 276 | + 'address' => array( | |
| 277 | + 'name' => __( 'Address', 'formidable' ), | |
| 278 | + 'icon' => 'frmfont frm_location2_icon', | |
| 279 | + 'message' => esc_html__( 'Instantly capture location information, simplifying logistics and contact collection. (Or go further with our Geolocation add-on!)', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 280 | + 'upsell_image' => $upsell_images_url . 'address-field-preview.webp', | |
| 281 | + 'learn-more' => 'address', | |
| 178 | 282 | ), |
| 179 | - 'summary' => array( | |
| 180 | - 'name' => __( 'Summary', 'formidable' ), | |
| 181 | - 'icon' => 'frm_icon_font frm_file_text_icon', | |
| 182 | - 'message' => 'Allow visitors to review their responses before a form is submitted. Upgrade to Pro to get Summary fields and more.', | |
| 283 | + 'summary' => array( | |
| 284 | + 'name' => __( 'Summary', 'formidable' ), | |
| 285 | + 'icon' => 'frmfont frm_file_text3_icon', | |
| 286 | + 'message' => __( 'Provide users with a clean, final review of all their entered data before submission, reducing errors and improving data quality.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 287 | + 'upsell_image' => $upsell_images_url . 'summary-field-preview.webp', | |
| 288 | + 'learn-more' => 'summary-review-before-submit', | |
| 183 | 289 | ), |
| 184 | - 'signature' => array( | |
| 185 | - 'name' => __( 'Signature', 'formidable' ), | |
| 186 | - 'icon' => 'frm_icon_font frm_signature_icon frm_show_upgrade', | |
| 187 | - 'addon' => 'signature', | |
| 290 | + 'signature' => array( | |
| 291 | + 'name' => __( 'Signature', 'formidable' ), | |
| 292 | + 'icon' => 'frmfont frm_signature_icon frm_show_upgrade', | |
| 293 | + 'addon' => 'signature', | |
| 294 | + 'message' => __( 'Capture digital e-signatures directly within your form, making official agreements and authorizations straightforward.', 'formidable' ), | |
| 295 | + 'upsell_image' => $upsell_images_url . 'signature-field-preview.webp', | |
| 296 | + 'learn-more' => 'formidable-signature', | |
| 188 | 297 | ), |
| 189 | - 'ai' => array( | |
| 190 | - 'name' => __( 'AI', 'formidable' ), | |
| 191 | - 'icon' => 'frm_icon_font frm_eye_icon frm_show_upgrade', | |
| 192 | - 'addon' => 'ai', | |
| 193 | - 'message' => 'Streamline workflows and reclaim valuable time with the power of AI. You can effortlessly respond to your visitors in real-time with ChatGPT as your automated assistant. Upgrade to Pro and unlock AI-powered fields.', | |
| 298 | + 'ai' => array( | |
| 299 | + 'name' => __( 'AI', 'formidable' ), | |
| 300 | + 'icon' => 'frmfont frm-ai-icon frm_show_upgrade', | |
| 301 | + 'addon' => 'ai', | |
| 302 | + 'message' => __( 'Harness artificial intelligence by taking user input and let the model of your choice create an output, quickly and easily.', 'formidable' ), | |
| 303 | + 'upsell_image' => $upsell_images_url . 'ai-field-preview.webp', | |
| 304 | + 'learn-more' => 'form-ai', | |
| 194 | 305 | ), |
| 195 | 306 | 'ssa-appointment' => array( |
| 196 | - 'name' => __( 'Appointment', 'formidable' ), | |
| 197 | - 'icon' => 'frm_icon_font frm_calendar_icon frm_show_upgrade', | |
| 198 | - 'require' => 'Simply Schedule Appointments', | |
| 199 | - 'message' => 'Appointment fields are an integration with <a href="https://simplyscheduleappointments.com/meet/formidable/">Simply Schedule Appointments</a>. Get started now to schedule appointments directly from your forms. | |
| 200 | - <img src="' . esc_attr( $images_url ) . 'appointments.png" alt="Scheduling" />', | |
| 201 | - 'link' => 'https://simplyscheduleappointments.com/meet/formidable/', | |
| 307 | + 'name' => __( 'Appointment', 'formidable' ), | |
| 308 | + 'icon' => 'frmfont frm_schedule_icon frm_show_upgrade', | |
| 309 | + 'require' => 'Simply Schedule Appointments', | |
| 310 | + 'message' => sprintf( | |
| 311 | + /* translators: %1$s: Link opening HTML, %2$s: Link tag closing */ | |
| 312 | + esc_html__( 'Appointment fields are an integration with %1$sSimply Schedule Appointments%2$s. Get started now to schedule appointments directly from your forms.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 313 | + '<a class="frm-inline-flex" href="https://simplyscheduleappointments.com/meet/formidable/" target="_blank" rel="noopener">', | |
| 314 | + '</a>' | |
| 315 | + ), | |
| 316 | + 'link' => 'https://simplyscheduleappointments.com/meet/formidable/', | |
| 317 | + 'upsell_image' => $upsell_images_url . 'appointment-field-preview.webp', | |
| 318 | + 'learn-more' => 'simply-schedule-appointments-forms', | |
| 202 | 319 | ), |
| 203 | - 'product' => array( | |
| 204 | - 'name' => __( 'Product', 'formidable' ), | |
| 205 | - 'icon' => 'frm_icon_font frm_product_icon', | |
| 206 | - 'section' => 'pricing', | |
| 320 | + 'virtual' => array( | |
| 321 | + 'name' => __( 'Virtual', 'formidable' ), | |
| 322 | + 'icon' => 'frmfont frm-virtual-field-icon', | |
| 323 | + 'message' => esc_html__( 'Protect sensitive data by storing field values server-side only, preventing users from viewing or manipulating them in their browser.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 324 | + 'upsell_image' => $upsell_images_url . 'virtual-field-preview.webp', | |
| 325 | + 'learn-more' => '/virtual', | |
| 326 | + 'is_new' => self::field_is_new( 'virtual' ), | |
| 207 | 327 | ), |
| 208 | - 'quantity' => array( | |
| 209 | - 'name' => __( 'Quantity', 'formidable' ), | |
| 210 | - 'icon' => 'frm_icon_font frm_quantity_icon', | |
| 211 | - 'section' => 'pricing', | |
| 328 | + 'product' => array( | |
| 329 | + 'name' => __( 'Product', 'formidable' ), | |
| 330 | + 'icon' => 'frmfont frm_product2_icon', | |
| 331 | + 'section' => 'pricing', | |
| 332 | + 'message' => __( 'Turn your form into a simple storefront by adding fields to list products, choose quantities, and calculate totals, enabling direct sales.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 333 | + 'upsell_image' => $upsell_images_url . 'product-field-preview.webp', | |
| 334 | + 'learn-more' => 'features/pricing-fields', | |
| 212 | 335 | ), |
| 213 | - 'total' => array( | |
| 214 | - 'name' => __( 'Total', 'formidable' ), | |
| 215 | - 'icon' => 'frm_icon_font frm_total_icon', | |
| 336 | + 'quantity' => array( | |
| 337 | + 'name' => __( 'Quantity', 'formidable' ), | |
| 338 | + 'icon' => 'frmfont frm_quantity_icon', | |
| 339 | + 'section' => 'pricing', | |
| 340 | + 'message' => __( 'Turn your form into a simple storefront by adding fields to list products, choose quantities, and calculate totals, enabling direct sales.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 341 | + 'upsell_image' => $upsell_images_url . 'quantity-field-preview.webp', | |
| 342 | + 'learn-more' => 'features/pricing-fields', | |
| 343 | + ), | |
| 344 | + 'total' => array( | |
| 345 | + 'name' => __( 'Total', 'formidable' ), | |
| 346 | + 'icon' => 'frmfont frm_total2_icon', | |
| 347 | + 'section' => 'pricing', | |
| 348 | + 'message' => __( 'Turn your form into a simple storefront by adding fields to list products, choose quantities, and calculate totals, enabling direct sales.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 349 | + 'upsell_image' => $upsell_images_url . 'total-field-preview.webp', | |
| 350 | + 'learn-more' => 'features/pricing-fields', | |
| 351 | + ), | |
| 352 | + 'coupon' => array( | |
| 353 | + 'name' => __( 'Coupon', 'formidable' ), | |
| 354 | + 'icon' => 'frm_icon_font frm_coupon_icon frm_show_upgrade', | |
| 355 | + 'addon' => 'coupons', | |
| 216 | 356 | 'section' => 'pricing', |
| 357 | + 'limit' => 1, | |
| 358 | + 'is_new' => self::field_is_new( 'coupon' ), | |
| 217 | 359 | ), |
| 218 | 360 | ); |
| 219 | 361 | |
| 220 | - if ( ! FrmAppHelper::show_new_feature( 'ai' ) ) { | |
| 221 | - unset( $fields['ai'] ); | |
| 222 | - } | |
| 223 | - | |
| 224 | 362 | // Since the signature field may be in a different section, don't show it twice. |
| 225 | 363 | $lite_fields = self::field_selection(); |
| 364 | + | |
| 226 | 365 | if ( isset( $lite_fields['signature'] ) ) { |
| 227 | 366 | unset( $fields['signature'] ); |
| 228 | 367 | } |
| 229 | 368 | |
| @@ -230,26 +369,109 @@ | ||
| 230 | 369 | return apply_filters( 'frm_pro_available_fields', $fields ); |
| 231 | 370 | } |
| 232 | 371 | |
| 233 | 372 | /** |
| 373 | + * Flag Pro field types that require a newer Pro version with frm_show_update. | |
| 374 | + * | |
| 375 | + * @since 6.29 | |
| 376 | + * | |
| 377 | + * @param array $fields Available Pro field types. | |
| 378 | + * | |
| 379 | + * @return array | |
| 380 | + */ | |
| 381 | + public static function show_update_for_pro_fields( $fields ) { | |
| 382 | + if ( FrmAppHelper::pro_is_installed() && ! class_exists( 'FrmProVirtualFieldController', false ) ) { | |
| 383 | + $fields['virtual']['icon'] .= ' frm_show_update'; | |
| 384 | + } | |
| 385 | + | |
| 386 | + return $fields; | |
| 387 | + } | |
| 388 | + | |
| 389 | + /** | |
| 390 | + * Gets field section labels in the form builder. | |
| 391 | + * | |
| 392 | + * @since 6.30 | |
| 393 | + * | |
| 394 | + * @return array | |
| 395 | + */ | |
| 396 | + public static function field_section_labels() { | |
| 397 | + return apply_filters( | |
| 398 | + 'frm_available_field_sections', | |
| 399 | + array( | |
| 400 | + 'pricing' => __( 'Pricing Fields', 'formidable' ), | |
| 401 | + ) | |
| 402 | + ); | |
| 403 | + } | |
| 404 | + | |
| 405 | + /** | |
| 406 | + * Consider a field new for 90 days after the release date. | |
| 407 | + * | |
| 408 | + * @since 6.8.3 | |
| 409 | + * | |
| 410 | + * @param string $type | |
| 411 | + * | |
| 412 | + * @return bool | |
| 413 | + */ | |
| 414 | + private static function field_is_new( $type ) { | |
| 415 | + $release_dates = array( | |
| 416 | + 'virtual' => '2026-03-10', | |
| 417 | + ); | |
| 418 | + | |
| 419 | + if ( ! isset( $release_dates[ $type ] ) ) { | |
| 420 | + return false; | |
| 421 | + } | |
| 422 | + | |
| 423 | + $release_date = $release_dates[ $type ]; | |
| 424 | + $three_months_after_release = gmdate( 'Y-m-d', strtotime( $release_date . ' + 90 days' ) ); | |
| 425 | + return gmdate( 'Y-m-d' ) < $three_months_after_release; | |
| 426 | + } | |
| 427 | + | |
| 428 | + /** | |
| 429 | + * Remove field types that are moved from Pro to Lite. | |
| 430 | + * | |
| 431 | + * @since 6.30 | |
| 432 | + * | |
| 433 | + * @param array $pro_fields | |
| 434 | + * | |
| 435 | + * @return void | |
| 436 | + */ | |
| 437 | + public static function remove_moved_field_types_from_pro( &$pro_fields ) { | |
| 438 | + unset( $pro_fields['credit_card'] ); | |
| 439 | + unset( $pro_fields['product'] ); | |
| 440 | + unset( $pro_fields['quantity'] ); | |
| 441 | + unset( $pro_fields['total'] ); | |
| 442 | + } | |
| 443 | + | |
| 444 | + /** | |
| 234 | 445 | * @since 4.0 |
| 446 | + * | |
| 447 | + * @return array | |
| 235 | 448 | */ |
| 236 | 449 | public static function all_field_selection() { |
| 237 | - $pro_field_selection = self::pro_field_selection(); | |
| 238 | - return array_merge( $pro_field_selection, self::field_selection() ); | |
| 450 | + return array_merge( self::pro_field_selection(), self::field_selection() ); | |
| 239 | 451 | } |
| 240 | 452 | |
| 453 | + /** | |
| 454 | + * Create a field. | |
| 455 | + * | |
| 456 | + * @param array $values | |
| 457 | + * @param bool $return | |
| 458 | + * | |
| 459 | + * @return false|int | |
| 460 | + */ | |
| 241 | 461 | public static function create( $values, $return = true ) { |
| 242 | 462 | global $wpdb, $frm_duplicate_ids; |
| 243 | 463 | |
| 244 | 464 | $new_values = array(); |
| 245 | - $key = isset( $values['field_key'] ) ? $values['field_key'] : $values['name']; | |
| 465 | + $key = $values['field_key'] ?? $values['name']; | |
| 246 | 466 | $new_values['field_key'] = FrmAppHelper::get_unique_key( $key, $wpdb->prefix . 'frm_fields', 'field_key' ); |
| 247 | 467 | |
| 248 | 468 | $values = FrmAppHelper::maybe_filter_array( $values, array( 'name', 'description' ) ); |
| 249 | 469 | |
| 250 | 470 | foreach ( array( 'name', 'description', 'type', 'default_value' ) as $col ) { |
| 251 | - $new_values[ $col ] = $values[ $col ]; | |
| 471 | + if ( isset( $values[ $col ] ) ) { | |
| 472 | + $new_values[ $col ] = $values[ $col ]; | |
| 473 | + } | |
| 252 | 474 | } |
| 253 | 475 | |
| 254 | 476 | $new_values['options'] = self::maybe_filter_options( $values['options'] ); |
| 255 | 477 | $new_values['field_order'] = isset( $values['field_order'] ) ? (int) $values['field_order'] : null; |
| @@ -266,56 +488,137 @@ | ||
| 266 | 488 | self::preserve_format_option_backslashes( $new_values ); |
| 267 | 489 | |
| 268 | 490 | foreach ( $new_values as $k => $v ) { |
| 269 | 491 | if ( is_array( $v ) ) { |
| 270 | - if ( $k === 'default_value' ) { | |
| 271 | - $new_values[ $k ] = FrmAppHelper::maybe_json_encode( $v ); | |
| 272 | - } else { | |
| 273 | - $new_values[ $k ] = serialize( $v ); | |
| 274 | - } | |
| 492 | + $new_values[ $k ] = $k === 'default_value' ? FrmAppHelper::maybe_json_encode( $v ) : serialize( $v ); | |
| 275 | 493 | } |
| 276 | 494 | unset( $k, $v ); |
| 277 | 495 | } |
| 278 | 496 | |
| 279 | 497 | $query_results = $wpdb->insert( $wpdb->prefix . 'frm_fields', $new_values ); |
| 280 | - $new_id = 0; | |
| 281 | - if ( $query_results ) { | |
| 282 | - self::delete_form_transient( $new_values['form_id'] ); | |
| 283 | - $new_id = $wpdb->insert_id; | |
| 498 | + | |
| 499 | + if ( ! $query_results ) { | |
| 500 | + return false; | |
| 284 | 501 | } |
| 285 | 502 | |
| 503 | + self::delete_form_transient( $new_values['form_id'] ); | |
| 504 | + | |
| 286 | 505 | if ( ! $return ) { |
| 287 | 506 | return false; |
| 288 | 507 | } |
| 289 | 508 | |
| 290 | - if ( $query_results ) { | |
| 291 | - if ( isset( $values['id'] ) ) { | |
| 292 | - $frm_duplicate_ids[ $values['id'] ] = $new_id; | |
| 293 | - } | |
| 509 | + $new_id = $wpdb->insert_id; | |
| 294 | 510 | |
| 295 | - return $new_id; | |
| 296 | - } else { | |
| 297 | - return false; | |
| 511 | + if ( isset( $values['id'] ) ) { | |
| 512 | + $frm_duplicate_ids[ $values['id'] ] = $new_id; | |
| 298 | 513 | } |
| 514 | + | |
| 515 | + return $new_id; | |
| 299 | 516 | } |
| 300 | 517 | |
| 301 | 518 | /** |
| 519 | + * Maybe filter HTML in field options data. | |
| 520 | + * HTML is only filtered when unsafe HTML is disallowed. | |
| 521 | + * See FrmAppHelper::allow_unfiltered_html. | |
| 522 | + * | |
| 302 | 523 | * @since 5.0.08 |
| 303 | 524 | * |
| 304 | 525 | * @param array $options |
| 526 | + * | |
| 305 | 527 | * @return array |
| 306 | 528 | */ |
| 307 | 529 | private static function maybe_filter_options( $options ) { |
| 308 | - return FrmAppHelper::maybe_filter_array( $options, array( 'custom_html' ) ); | |
| 530 | + $options = FrmAppHelper::maybe_filter_array( $options, array( 'custom_html' ) ); | |
| 531 | + | |
| 532 | + if ( ! empty( $options['custom_html'] ) ) { | |
| 533 | + $options['custom_html'] = self::maybe_filter_custom_html_input_attributes( $options['custom_html'] ); | |
| 534 | + } | |
| 535 | + | |
| 536 | + if ( ! empty( $options['classes'] ) ) { | |
| 537 | + $options['classes'] = implode( ' ', array_map( 'FrmFormsHelper::sanitize_layout_class', explode( ' ', $options['classes'] ) ) ); | |
| 538 | + } | |
| 539 | + | |
| 540 | + return $options; | |
| 309 | 541 | } |
| 310 | 542 | |
| 311 | 543 | /** |
| 544 | + * Prevent users who do not have permission to insert JavaScript attributes in input elements. | |
| 545 | + * This is triggered when a field is updated. | |
| 546 | + * | |
| 547 | + * @since 6.11.2 | |
| 548 | + * | |
| 549 | + * @param string $html | |
| 550 | + * | |
| 551 | + * @return string | |
| 552 | + */ | |
| 553 | + private static function maybe_filter_custom_html_input_attributes( $html ) { | |
| 554 | + if ( FrmAppHelper::allow_unfiltered_html() ) { | |
| 555 | + return $html; | |
| 556 | + } | |
| 557 | + | |
| 558 | + $pattern = get_shortcode_regex( array( 'input' ) ); | |
| 559 | + return preg_replace_callback( | |
| 560 | + "/$pattern/", | |
| 561 | + /** | |
| 562 | + * @param array $match Shortcode data. | |
| 563 | + * | |
| 564 | + * @return string | |
| 565 | + */ | |
| 566 | + function ( $match ) { | |
| 567 | + $attr = shortcode_parse_atts( $match[3] ); | |
| 568 | + | |
| 569 | + if ( ! is_array( $attr ) ) { | |
| 570 | + // In old versions of WordPress (older than 6.5), this might not be an array. | |
| 571 | + return '[input]'; | |
| 572 | + } | |
| 573 | + | |
| 574 | + $safe_atts = array(); | |
| 575 | + | |
| 576 | + foreach ( $attr as $attr_key => $att ) { | |
| 577 | + if ( is_numeric( $attr_key ) ) { | |
| 578 | + // Some data is mapped like 0 => 'placeholder="Placeholder"'. | |
| 579 | + $split = explode( '=', $att, 2 ); | |
| 580 | + | |
| 581 | + if ( 2 !== count( $split ) ) { | |
| 582 | + continue; | |
| 583 | + } | |
| 584 | + | |
| 585 | + $key = trim( $split[0] ); | |
| 586 | + $value = trim( $split[1], '"' ); | |
| 587 | + } else { | |
| 588 | + // opt=1 without parentheses for example is mapped like 'opt' => 1. | |
| 589 | + $key = $attr_key; | |
| 590 | + $value = $att; | |
| 591 | + } | |
| 592 | + | |
| 593 | + if ( FrmAppHelper::input_key_is_safe( $key, 'update' ) ) { | |
| 594 | + $safe_atts[ $key ] = $value; | |
| 595 | + } | |
| 596 | + }//end foreach | |
| 597 | + | |
| 598 | + if ( ! $safe_atts ) { | |
| 599 | + return '[input]'; | |
| 600 | + } | |
| 601 | + | |
| 602 | + return '[input ' . FrmAppHelper::array_to_html_params( $safe_atts ) . ']'; | |
| 603 | + }, | |
| 604 | + $html | |
| 605 | + ); | |
| 606 | + } | |
| 607 | + | |
| 608 | + /** | |
| 312 | 609 | * Process the field duplication. |
| 313 | 610 | * |
| 314 | 611 | * @since 5.0.05 |
| 612 | + * | |
| 613 | + * @param int|string $field_id Field ID. | |
| 614 | + * @param int|string $form_id Form ID. | |
| 615 | + * | |
| 616 | + * @return array|false | |
| 315 | 617 | */ |
| 316 | 618 | public static function duplicate_single_field( $field_id, $form_id ) { |
| 317 | 619 | $copy_field = self::getOne( $field_id ); |
| 620 | + | |
| 318 | 621 | if ( ! $copy_field ) { |
| 319 | 622 | return false; |
| 320 | 623 | } |
| 321 | 624 | |
| @@ -325,10 +628,9 @@ | ||
| 325 | 628 | $values = array( |
| 326 | 629 | 'id' => $copy_field->id, |
| 327 | 630 | ); |
| 328 | 631 | FrmFieldsHelper::fill_field( $values, $copy_field, $copy_field->form_id ); |
| 329 | - $values = apply_filters( 'frm_prepare_single_field_for_duplication', $values ); | |
| 330 | - | |
| 632 | + $values = apply_filters( 'frm_prepare_single_field_for_duplication', $values ); | |
| 331 | 633 | $field_id = self::create( $values ); |
| 332 | 634 | |
| 333 | 635 | /** |
| 334 | 636 | * Fires after duplicating a field. |
| @@ -348,8 +650,16 @@ | ||
| 348 | 650 | |
| 349 | 651 | return compact( 'field_id', 'values' ); |
| 350 | 652 | } |
| 351 | 653 | |
| 654 | + /** | |
| 655 | + * @param int|string $old_form_id | |
| 656 | + * @param int|string $form_id | |
| 657 | + * @param bool $copy_keys | |
| 658 | + * @param false|int $blog_id | |
| 659 | + * | |
| 660 | + * @return void | |
| 661 | + */ | |
| 352 | 662 | public static function duplicate( $old_form_id, $form_id, $copy_keys = false, $blog_id = false ) { |
| 353 | 663 | global $frm_duplicate_ids; |
| 354 | 664 | |
| 355 | 665 | $where = array( |
| @@ -362,8 +672,10 @@ | ||
| 362 | 672 | $fields = self::getAll( $where, 'field_order', '', $blog_id ); |
| 363 | 673 | |
| 364 | 674 | foreach ( (array) $fields as $field ) { |
| 365 | 675 | $new_key = $copy_keys ? $field->field_key : ''; |
| 676 | + | |
| 677 | + // phpcs:ignore Universal.Operators.StrictComparisons | |
| 366 | 678 | if ( $copy_keys && substr( $field->field_key, - 1 ) == 2 ) { |
| 367 | 679 | $new_key = rtrim( $new_key, 2 ); |
| 368 | 680 | } |
| 369 | 681 | |
| @@ -371,9 +683,9 @@ | ||
| 371 | 683 | FrmFieldsHelper::fill_field( $values, $field, $form_id, $new_key ); |
| 372 | 684 | |
| 373 | 685 | // If this is a repeating section, create new form |
| 374 | 686 | if ( self::is_repeating_field( $field ) ) { |
| 375 | - // create the repeatable form | |
| 687 | + // Create the repeatable form | |
| 376 | 688 | $new_repeat_form_id = apply_filters( |
| 377 | 689 | 'frm_create_repeat_form', |
| 378 | 690 | 0, |
| 379 | 691 | array( |
| @@ -389,9 +701,9 @@ | ||
| 389 | 701 | $values['field_options']['form_select'] = $new_repeat_form_id; |
| 390 | 702 | } |
| 391 | 703 | |
| 392 | 704 | // If this is a field inside of a repeating section, associate it with the correct form |
| 393 | - if ( $field->form_id != $old_form_id && isset( $old_repeat_form_id ) && isset( $new_repeat_form_id ) && $field->form_id == $old_repeat_form_id ) { | |
| 705 | + if ( (int) $field->form_id !== (int) $old_form_id && isset( $old_repeat_form_id ) && isset( $new_repeat_form_id ) && (int) $field->form_id === (int) $old_repeat_form_id ) { // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 394 | 706 | $values['form_id'] = $new_repeat_form_id; |
| 395 | 707 | } |
| 396 | 708 | |
| 397 | 709 | $values['description'] = FrmFieldsHelper::switch_field_ids( $values['description'] ); |
| @@ -400,11 +712,17 @@ | ||
| 400 | 712 | $new_id = self::create( $values ); |
| 401 | 713 | $frm_duplicate_ids[ $field->id ] = $new_id; |
| 402 | 714 | $frm_duplicate_ids[ $field->field_key ] = $new_id; |
| 403 | 715 | unset( $field ); |
| 404 | - } | |
| 716 | + }//end foreach | |
| 405 | 717 | } |
| 406 | 718 | |
| 719 | + /** | |
| 720 | + * @param int|string $id | |
| 721 | + * @param array $values | |
| 722 | + * | |
| 723 | + * @return false|int | |
| 724 | + */ | |
| 407 | 725 | public static function update( $id, $values ) { |
| 408 | 726 | global $wpdb; |
| 409 | 727 | |
| 410 | 728 | $id = absint( $id ); |
| @@ -420,36 +738,53 @@ | ||
| 420 | 738 | |
| 421 | 739 | self::preserve_format_option_backslashes( $values ); |
| 422 | 740 | |
| 423 | 741 | if ( isset( $values['type'] ) ) { |
| 424 | - $values = apply_filters( 'frm_clean_' . $values['type'] . '_field_options_before_update', $values ); | |
| 742 | + if ( 'dropdown' === $values['type'] ) { | |
| 743 | + // To avoid conflicts with security plugins the value "dropdown" is sent for select fields. | |
| 744 | + // This is because "select" gets matched for SQL injection attempts. | |
| 745 | + $values['type'] = 'select'; | |
| 746 | + } | |
| 425 | 747 | |
| 748 | + /** | |
| 749 | + * @since 6.9 The Field ID param was added. | |
| 750 | + * | |
| 751 | + * @param array $values | |
| 752 | + * @param int $id Field ID. | |
| 753 | + */ | |
| 754 | + $values = apply_filters( 'frm_clean_' . $values['type'] . '_field_options_before_update', $values, $id ); | |
| 755 | + | |
| 426 | 756 | if ( $values['type'] === 'hidden' && isset( $values['field_options'] ) && isset( $values['field_options']['clear_on_focus'] ) ) { |
| 427 | - // don't keep the old placeholder setting for hidden fields | |
| 757 | + // Don't keep the old placeholder setting for hidden fields | |
| 428 | 758 | $values['field_options']['clear_on_focus'] = 0; |
| 429 | 759 | } |
| 430 | 760 | } |
| 431 | 761 | |
| 432 | - // serialize array values | |
| 762 | + // Serialize array values | |
| 433 | 763 | foreach ( array( 'field_options', 'options' ) as $opt ) { |
| 434 | - if ( isset( $values[ $opt ] ) && is_array( $values[ $opt ] ) ) { | |
| 435 | - if ( 'field_options' === $opt ) { | |
| 436 | - $values[ $opt ] = self::maybe_filter_options( $values[ $opt ] ); | |
| 437 | - } | |
| 438 | - $values[ $opt ] = serialize( $values[ $opt ] ); | |
| 764 | + if ( ! isset( $values[ $opt ] ) || ! is_array( $values[ $opt ] ) ) { | |
| 765 | + continue; | |
| 439 | 766 | } |
| 767 | + | |
| 768 | + if ( 'field_options' === $opt ) { | |
| 769 | + $values[ $opt ] = self::maybe_filter_options( $values[ $opt ] ); | |
| 770 | + } | |
| 771 | + | |
| 772 | + $values[ $opt ] = serialize( $values[ $opt ] ); | |
| 440 | 773 | } |
| 774 | + | |
| 441 | 775 | if ( isset( $values['default_value'] ) && is_array( $values['default_value'] ) ) { |
| 442 | 776 | $values['default_value'] = json_encode( $values['default_value'] ); |
| 443 | 777 | } |
| 444 | 778 | |
| 445 | 779 | $query_results = $wpdb->update( $wpdb->prefix . 'frm_fields', $values, array( 'id' => $id ) ); |
| 780 | + $form_id = 0; | |
| 446 | 781 | |
| 447 | - $form_id = 0; | |
| 448 | 782 | if ( isset( $values['form_id'] ) ) { |
| 449 | 783 | $form_id = absint( $values['form_id'] ); |
| 450 | 784 | } else { |
| 451 | 785 | $field = self::getOne( $id ); |
| 786 | + | |
| 452 | 787 | if ( $field ) { |
| 453 | 788 | $form_id = $field->form_id; |
| 454 | 789 | } |
| 455 | 790 | unset( $field ); |
| @@ -457,8 +792,9 @@ | ||
| 457 | 792 | unset( $values ); |
| 458 | 793 | |
| 459 | 794 | if ( $query_results ) { |
| 460 | 795 | wp_cache_delete( $id, 'frm_field' ); |
| 796 | + | |
| 461 | 797 | if ( $form_id ) { |
| 462 | 798 | self::delete_form_transient( $form_id ); |
| 463 | 799 | } |
| 464 | 800 | } |
| @@ -470,9 +806,11 @@ | ||
| 470 | 806 | * Keep backslashes in the phone format option |
| 471 | 807 | * |
| 472 | 808 | * @since 2.0.8 |
| 473 | 809 | * |
| 474 | - * @param $values array - pass by reference | |
| 810 | + * @param array $values Pass by reference. | |
| 811 | + * | |
| 812 | + * @return void | |
| 475 | 813 | */ |
| 476 | 814 | private static function preserve_format_option_backslashes( &$values ) { |
| 477 | 815 | if ( isset( $values['field_options']['format'] ) ) { |
| 478 | 816 | $values['field_options']['format'] = FrmAppHelper::preserve_backslashes( $values['field_options']['format'] ); |
| @@ -478,8 +816,13 @@ | ||
| 478 | 816 | $values['field_options']['format'] = FrmAppHelper::preserve_backslashes( $values['field_options']['format'] ); |
| 479 | 817 | } |
| 480 | 818 | } |
| 481 | 819 | |
| 820 | + /** | |
| 821 | + * @param int|string $id | |
| 822 | + * | |
| 823 | + * @return bool|int | |
| 824 | + */ | |
| 482 | 825 | public static function destroy( $id ) { |
| 483 | 826 | global $wpdb; |
| 484 | 827 | |
| 485 | 828 | do_action( 'frm_before_destroy_field', $id ); |
| @@ -485,8 +828,9 @@ | ||
| 485 | 828 | do_action( 'frm_before_destroy_field', $id ); |
| 486 | 829 | |
| 487 | 830 | wp_cache_delete( $id, 'frm_field' ); |
| 488 | 831 | $field = self::getOne( $id ); |
| 832 | + | |
| 489 | 833 | if ( ! $field ) { |
| 490 | 834 | return false; |
| 491 | 835 | } |
| 492 | 836 | |
| @@ -496,8 +840,13 @@ | ||
| 496 | 840 | |
| 497 | 841 | return $wpdb->query( $wpdb->prepare( 'DELETE FROM ' . $wpdb->prefix . 'frm_fields WHERE id=%d', $id ) ); |
| 498 | 842 | } |
| 499 | 843 | |
| 844 | + /** | |
| 845 | + * @param int|string $form_id | |
| 846 | + * | |
| 847 | + * @return void | |
| 848 | + */ | |
| 500 | 849 | public static function delete_form_transient( $form_id ) { |
| 501 | 850 | $form_id = absint( $form_id ); |
| 502 | 851 | delete_transient( 'frm_form_fields_' . $form_id . 'excludeinclude' ); |
| 503 | 852 | delete_transient( 'frm_form_fields_' . $form_id . 'includeinclude' ); |
| @@ -504,14 +853,15 @@ | ||
| 504 | 853 | delete_transient( 'frm_form_fields_' . $form_id . 'includeexclude' ); |
| 505 | 854 | delete_transient( 'frm_form_fields_' . $form_id . 'excludeexclude' ); |
| 506 | 855 | |
| 507 | 856 | global $wpdb; |
| 508 | - $wpdb->query( $wpdb->prepare( 'DELETE FROM ' . $wpdb->options . ' WHERE option_name LIKE %s OR option_name LIKE %s OR option_name LIKE %s OR option_name LIKE %s', '_transient_timeout_frm_form_fields_' . $form_id . 'ex%', '_transient_frm_form_fields_' . $form_id . 'ex%', '_transient_timeout_frm_form_fields_' . $form_id . 'in%', '_transient_frm_form_fields_' . $form_id . 'in%' ) ); | |
| 857 | + $wpdb->query( $wpdb->prepare( 'DELETE FROM ' . $wpdb->options . ' WHERE option_name LIKE %s OR option_name LIKE %s OR option_name LIKE %s OR option_name LIKE %s', '_transient_timeout_frm_form_fields_' . $form_id . 'ex%', '_transient_frm_form_fields_' . $form_id . 'ex%', '_transient_timeout_frm_form_fields_' . $form_id . 'in%', '_transient_frm_form_fields_' . $form_id . 'in%' ) ); // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 509 | 858 | |
| 510 | 859 | FrmDb::cache_delete_group( 'frm_field' ); |
| 511 | 860 | |
| 512 | 861 | $form = FrmForm::getOne( $form_id ); |
| 513 | - if ( $form && $form->parent_form_id && $form->parent_form_id != $form_id ) { | |
| 862 | + | |
| 863 | + if ( $form && $form->parent_form_id && (int) $form->parent_form_id !== $form_id ) { | |
| 514 | 864 | self::delete_form_transient( $form->parent_form_id ); |
| 515 | 865 | } |
| 516 | 866 | } |
| 517 | 867 | |
| @@ -516,8 +866,12 @@ | ||
| 516 | 866 | } |
| 517 | 867 | |
| 518 | 868 | /** |
| 519 | 869 | * If $field is numeric, get the field object |
| 870 | + * | |
| 871 | + * @param int|object|string $field | |
| 872 | + * | |
| 873 | + * @return void | |
| 520 | 874 | */ |
| 521 | 875 | public static function maybe_get_field( &$field ) { |
| 522 | 876 | if ( ! is_object( $field ) ) { |
| 523 | 877 | $field = self::getOne( $field ); |
| @@ -524,13 +878,15 @@ | ||
| 524 | 878 | } |
| 525 | 879 | } |
| 526 | 880 | |
| 527 | 881 | /** |
| 528 | - * @param string|int $id The field id or key. | |
| 529 | - * @param bool $filter When true, run the frm_field filter. | |
| 882 | + * @param int|string $id The field id or key. | |
| 883 | + * @param bool $filter When true, run the frm_field filter. | |
| 884 | + * | |
| 885 | + * @return object|null | |
| 530 | 886 | */ |
| 531 | 887 | public static function getOne( $id, $filter = false ) { |
| 532 | - if ( empty( $id ) ) { | |
| 888 | + if ( ! $id ) { | |
| 533 | 889 | return null; |
| 534 | 890 | } |
| 535 | 891 | |
| 536 | 892 | global $wpdb; |
| @@ -539,9 +895,9 @@ | ||
| 539 | 895 | $query = $wpdb->prepare( 'SELECT * FROM ' . $wpdb->prefix . 'frm_fields WHERE ' . $where, $id ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared |
| 540 | 896 | |
| 541 | 897 | $results = FrmDb::check_cache( $id, 'frm_field', $query, 'get_row', 0 ); |
| 542 | 898 | |
| 543 | - if ( empty( $results ) ) { | |
| 899 | + if ( ! $results ) { | |
| 544 | 900 | self::filter_field( $filter, $results ); |
| 545 | 901 | return $results; |
| 546 | 902 | } |
| 547 | 903 | |
| @@ -558,10 +914,13 @@ | ||
| 558 | 914 | } |
| 559 | 915 | |
| 560 | 916 | /** |
| 561 | 917 | * @since 3.06.01 |
| 918 | + * | |
| 562 | 919 | * @param bool $filter When true, run the frm_field filter. |
| 563 | 920 | * @param object $results |
| 921 | + * | |
| 922 | + * @return void | |
| 564 | 923 | */ |
| 565 | 924 | private static function filter_field( $filter, &$results ) { |
| 566 | 925 | if ( $filter ) { |
| 567 | 926 | /** |
| @@ -573,27 +932,33 @@ | ||
| 573 | 932 | |
| 574 | 933 | /** |
| 575 | 934 | * Get the field type by key or id |
| 576 | 935 | * |
| 577 | - * @param int|string The field id or key | |
| 578 | - * @param mixed $col The name of the column in the fields database table | |
| 936 | + * @param int|string $id The field id or key. | |
| 937 | + * @param mixed $col The name of the column in the fields database table. | |
| 938 | + * | |
| 939 | + * @return mixed | |
| 579 | 940 | */ |
| 580 | 941 | public static function get_type( $id, $col = 'type' ) { |
| 581 | 942 | $field = FrmDb::check_cache( $id, 'frm_field' ); |
| 943 | + | |
| 582 | 944 | if ( $field ) { |
| 583 | - $type = $field->{$col}; | |
| 584 | - } else { | |
| 585 | - $where = array( | |
| 586 | - 'or' => 1, | |
| 587 | - 'id' => $id, | |
| 588 | - 'field_key' => $id, | |
| 589 | - ); | |
| 590 | - $type = FrmDb::get_var( 'frm_fields', $where, $col ); | |
| 945 | + return $field->{$col}; | |
| 591 | 946 | } |
| 592 | 947 | |
| 593 | - return $type; | |
| 948 | + $where = is_numeric( $id ) ? array( 'id' => $id ) : array( 'field_key' => $id ); | |
| 949 | + | |
| 950 | + return FrmDb::get_var( 'frm_fields', $where, $col ); | |
| 594 | 951 | } |
| 595 | 952 | |
| 953 | + /** | |
| 954 | + * @param int|string $form_id | |
| 955 | + * @param string $type | |
| 956 | + * @param int|string $limit | |
| 957 | + * @param string $inc_sub | |
| 958 | + * | |
| 959 | + * @return array|object | |
| 960 | + */ | |
| 596 | 961 | public static function get_all_types_in_form( $form_id, $type, $limit = '', $inc_sub = 'exclude' ) { |
| 597 | 962 | if ( ! $form_id ) { |
| 598 | 963 | return array(); |
| 599 | 964 | } |
| @@ -604,24 +969,28 @@ | ||
| 604 | 969 | 'inc_embed' => $inc_sub, |
| 605 | 970 | 'inc_repeat' => $inc_sub, |
| 606 | 971 | ) |
| 607 | 972 | ); |
| 608 | - if ( ! empty( $results ) ) { | |
| 973 | + | |
| 974 | + if ( $results ) { | |
| 609 | 975 | $fields = array(); |
| 610 | 976 | $count = 0; |
| 977 | + | |
| 611 | 978 | foreach ( $results as $result ) { |
| 612 | - if ( $type != $result->type ) { | |
| 979 | + if ( $type !== $result->type ) { | |
| 613 | 980 | continue; |
| 614 | 981 | } |
| 615 | 982 | |
| 616 | 983 | $fields[ $result->id ] = $result; |
| 617 | - $count ++; | |
| 984 | + ++$count; | |
| 985 | + | |
| 986 | + // phpcs:ignore Universal.Operators.StrictComparisons | |
| 618 | 987 | if ( $limit == 1 ) { |
| 619 | 988 | $fields = $result; |
| 620 | 989 | break; |
| 621 | 990 | } |
| 622 | 991 | |
| 623 | - if ( ! empty( $limit ) && $count >= $limit ) { | |
| 992 | + if ( $limit && $count >= $limit ) { | |
| 624 | 993 | break; |
| 625 | 994 | } |
| 626 | 995 | |
| 627 | 996 | unset( $result ); |
| @@ -627,9 +996,9 @@ | ||
| 627 | 996 | unset( $result ); |
| 628 | 997 | } |
| 629 | 998 | |
| 630 | 999 | return wp_unslash( $fields ); |
| 631 | - } | |
| 1000 | + }//end if | |
| 632 | 1001 | |
| 633 | 1002 | self::$use_cache = false; |
| 634 | 1003 | |
| 635 | 1004 | $where = array( |
| @@ -643,8 +1012,16 @@ | ||
| 643 | 1012 | |
| 644 | 1013 | return $results; |
| 645 | 1014 | } |
| 646 | 1015 | |
| 1016 | + /** | |
| 1017 | + * @param int|string $form_id | |
| 1018 | + * @param int|string $limit | |
| 1019 | + * @param string $inc_embed | |
| 1020 | + * @param string $inc_repeat | |
| 1021 | + * | |
| 1022 | + * @return array | |
| 1023 | + */ | |
| 647 | 1024 | public static function get_all_for_form( $form_id, $limit = '', $inc_embed = 'exclude', $inc_repeat = 'include' ) { |
| 648 | 1025 | if ( ! (int) $form_id ) { |
| 649 | 1026 | return array(); |
| 650 | 1027 | } |
| @@ -649,19 +1026,22 @@ | ||
| 649 | 1026 | return array(); |
| 650 | 1027 | } |
| 651 | 1028 | |
| 652 | 1029 | $results = self::get_fields_from_transients( $form_id, compact( 'inc_embed', 'inc_repeat' ) ); |
| 653 | - if ( ! empty( $results ) ) { | |
| 654 | - if ( empty( $limit ) ) { | |
| 1030 | + | |
| 1031 | + if ( $results ) { | |
| 1032 | + if ( ! $limit ) { | |
| 655 | 1033 | return $results; |
| 656 | 1034 | } |
| 657 | 1035 | |
| 658 | 1036 | $fields = array(); |
| 659 | 1037 | $count = 0; |
| 1038 | + | |
| 660 | 1039 | foreach ( $results as $result ) { |
| 661 | - $count ++; | |
| 1040 | + ++$count; | |
| 662 | 1041 | $fields[ $result->id ] = $result; |
| 663 | - if ( ! empty( $limit ) && $count >= $limit ) { | |
| 1042 | + | |
| 1043 | + if ( $limit && $count >= $limit ) { | |
| 664 | 1044 | break; |
| 665 | 1045 | } |
| 666 | 1046 | } |
| 667 | 1047 | |
| @@ -677,9 +1057,9 @@ | ||
| 677 | 1057 | self::$use_cache = true; |
| 678 | 1058 | |
| 679 | 1059 | self::include_sub_fields( $results, $inc_embed, 'all', $form_id ); |
| 680 | 1060 | |
| 681 | - if ( empty( $limit ) ) { | |
| 1061 | + if ( ! $limit ) { | |
| 682 | 1062 | self::set_field_transient( $results, $form_id, 0, compact( 'inc_embed', 'inc_repeat' ) ); |
| 683 | 1063 | } |
| 684 | 1064 | |
| 685 | 1065 | return $results; |
| @@ -688,41 +1068,56 @@ | ||
| 688 | 1068 | /** |
| 689 | 1069 | * If repeating fields should be included, adjust $where accordingly |
| 690 | 1070 | * |
| 691 | 1071 | * @param string $inc_repeat |
| 692 | - * @param array $where - pass by reference | |
| 1072 | + * @param array $where Pass by reference. | |
| 1073 | + * | |
| 1074 | + * @return void | |
| 693 | 1075 | */ |
| 694 | 1076 | private static function maybe_include_repeating_fields( $inc_repeat, &$where ) { |
| 695 | - if ( $inc_repeat == 'include' ) { | |
| 696 | - $form_id = $where['fi.form_id']; | |
| 697 | - $where[] = array( | |
| 698 | - 'or' => 1, | |
| 699 | - 'fi.form_id' => $form_id, | |
| 700 | - 'fr.parent_form_id' => $form_id, | |
| 701 | - ); | |
| 702 | - unset( $where['fi.form_id'] ); | |
| 1077 | + if ( $inc_repeat !== 'include' ) { | |
| 1078 | + return; | |
| 703 | 1079 | } |
| 1080 | + | |
| 1081 | + $form_id = $where['fi.form_id']; | |
| 1082 | + $where[] = array( | |
| 1083 | + 'or' => 1, | |
| 1084 | + 'fi.form_id' => $form_id, | |
| 1085 | + 'fr.parent_form_id' => $form_id, | |
| 1086 | + ); | |
| 1087 | + unset( $where['fi.form_id'] ); | |
| 704 | 1088 | } |
| 705 | 1089 | |
| 1090 | + /** | |
| 1091 | + * @param array $results | |
| 1092 | + * @param string $inc_embed | |
| 1093 | + * @param string $type | |
| 1094 | + * @param int|string $form_id | |
| 1095 | + * | |
| 1096 | + * @return void | |
| 1097 | + */ | |
| 706 | 1098 | public static function include_sub_fields( &$results, $inc_embed, $type = 'all', $form_id = '' ) { |
| 707 | - $no_sub_forms = empty( $results ) && $type === 'all'; | |
| 708 | - if ( 'include' != $inc_embed || $no_sub_forms ) { | |
| 1099 | + $no_sub_forms = ! $results && $type === 'all'; | |
| 1100 | + | |
| 1101 | + if ( 'include' !== $inc_embed || $no_sub_forms ) { | |
| 709 | 1102 | return; |
| 710 | 1103 | } |
| 711 | 1104 | |
| 712 | - $form_fields = $results; | |
| 713 | - $should_get_subforms = ( $type !== 'all' && $type !== 'form' && ! empty( $form_id ) ); | |
| 1105 | + $form_fields = $results; | |
| 1106 | + $should_get_subforms = $type !== 'all' && $type !== 'form' && $form_id; | |
| 1107 | + | |
| 714 | 1108 | if ( $should_get_subforms ) { |
| 715 | 1109 | $form_fields = self::get_all_types_in_form( $form_id, 'form' ); |
| 716 | 1110 | } |
| 717 | 1111 | |
| 718 | 1112 | $index_offset = 1; |
| 1113 | + | |
| 719 | 1114 | foreach ( $form_fields as $k => $field ) { |
| 720 | - if ( 'form' != $field->type || ! isset( $field->field_options['form_select'] ) ) { | |
| 1115 | + if ( 'form' !== $field->type || ! isset( $field->field_options['form_select'] ) ) { | |
| 721 | 1116 | continue; |
| 722 | 1117 | } |
| 723 | 1118 | |
| 724 | - if ( $type == 'all' ) { | |
| 1119 | + if ( $type === 'all' ) { | |
| 725 | 1120 | $sub_fields = self::get_all_for_form( $field->field_options['form_select'] ); |
| 726 | 1121 | } else { |
| 727 | 1122 | $sub_fields = self::get_all_types_in_form( $field->field_options['form_select'], $type ); |
| 728 | 1123 | } |
| @@ -727,9 +1122,9 @@ | ||
| 727 | 1122 | $sub_fields = self::get_all_types_in_form( $field->field_options['form_select'], $type ); |
| 728 | 1123 | } |
| 729 | 1124 | |
| 730 | 1125 | if ( ! empty( $sub_fields ) ) { |
| 731 | - $index = $k + $index_offset; | |
| 1126 | + $index = $k + $index_offset; | |
| 732 | 1127 | $index_offset += count( $sub_fields ); |
| 733 | 1128 | array_splice( $results, $index, 0, $sub_fields ); |
| 734 | 1129 | } |
| 735 | 1130 | unset( $field, $sub_fields ); |
| @@ -735,13 +1130,23 @@ | ||
| 735 | 1130 | unset( $field, $sub_fields ); |
| 736 | 1131 | } |
| 737 | 1132 | } |
| 738 | 1133 | |
| 1134 | + /** | |
| 1135 | + * @param array|string $where | |
| 1136 | + * @param string $order_by | |
| 1137 | + * @param string $limit | |
| 1138 | + * @param false|int $blog_id | |
| 1139 | + * | |
| 1140 | + * @return array|object|null | |
| 1141 | + */ | |
| 739 | 1142 | public static function getAll( $where = array(), $order_by = '', $limit = '', $blog_id = false ) { |
| 740 | 1143 | $cache_key = FrmAppHelper::maybe_json_encode( $where ) . $order_by . 'l' . $limit . 'b' . $blog_id; |
| 1144 | + | |
| 741 | 1145 | if ( self::$use_cache ) { |
| 742 | - // make sure old cache doesn't get saved as a transient | |
| 1146 | + // Make sure old cache doesn't get saved as a transient | |
| 743 | 1147 | $results = wp_cache_get( $cache_key, 'frm_field' ); |
| 1148 | + | |
| 744 | 1149 | if ( false !== $results ) { |
| 745 | 1150 | return wp_unslash( $results ); |
| 746 | 1151 | } |
| 747 | 1152 | } |
| @@ -748,15 +1153,9 @@ | ||
| 748 | 1153 | |
| 749 | 1154 | global $wpdb; |
| 750 | 1155 | |
| 751 | 1156 | if ( $blog_id && is_multisite() ) { |
| 752 | - global $wpmuBaseTablePrefix; | |
| 753 | - if ( $wpmuBaseTablePrefix ) { | |
| 754 | - $prefix = $wpmuBaseTablePrefix . $blog_id . '_'; | |
| 755 | - } else { | |
| 756 | - $prefix = $wpdb->get_blog_prefix( $blog_id ); | |
| 757 | - } | |
| 758 | - | |
| 1157 | + $prefix = $wpdb->get_blog_prefix( $blog_id ); | |
| 759 | 1158 | $table_name = $prefix . 'frm_fields'; |
| 760 | 1159 | $form_table_name = $prefix . 'frm_forms'; |
| 761 | 1160 | } else { |
| 762 | 1161 | $table_name = $wpdb->prefix . 'frm_fields'; |
| @@ -762,28 +1161,27 @@ | ||
| 762 | 1161 | $table_name = $wpdb->prefix . 'frm_fields'; |
| 763 | 1162 | $form_table_name = $wpdb->prefix . 'frm_forms'; |
| 764 | 1163 | } |
| 765 | 1164 | |
| 766 | - if ( ! empty( $order_by ) && strpos( $order_by, 'ORDER BY' ) === false ) { | |
| 1165 | + if ( $order_by && ! str_contains( $order_by, 'ORDER BY' ) ) { | |
| 767 | 1166 | $order_by = ' ORDER BY ' . $order_by; |
| 768 | 1167 | } |
| 769 | 1168 | |
| 770 | - $limit = FrmDb::esc_limit( $limit ); | |
| 1169 | + $limit = FrmDb::esc_limit( $limit ); | |
| 1170 | + $query = "SELECT fi.*, fr.name as form_name FROM {$table_name} fi JOIN {$form_table_name} fr ON fi.form_id=fr.id"; | |
| 1171 | + $query_type = $limit === ' LIMIT 1' || $limit == 1 ? 'row' : 'results'; // phpcs:ignore Universal.Operators.StrictComparisons | |
| 771 | 1172 | |
| 772 | - $query = "SELECT fi.*, fr.name as form_name FROM {$table_name} fi LEFT OUTER JOIN {$form_table_name} fr ON fi.form_id=fr.id"; | |
| 773 | - $query_type = ( $limit == ' LIMIT 1' || $limit == 1 ) ? 'row' : 'results'; | |
| 774 | - | |
| 775 | 1173 | if ( is_array( $where ) ) { |
| 776 | 1174 | $args = array( |
| 777 | 1175 | 'order_by' => $order_by, |
| 778 | 1176 | 'limit' => $limit, |
| 779 | 1177 | ); |
| 780 | - $results = FrmDb::get_var( $table_name . ' fi LEFT OUTER JOIN ' . $form_table_name . ' fr ON fi.form_id=fr.id', $where, 'fi.*, fr.name as form_name', $args, '', $query_type ); | |
| 1178 | + $results = FrmDb::get_var( $table_name . ' fi JOIN ' . $form_table_name . ' fr ON fi.form_id=fr.id', $where, 'fi.*, fr.name as form_name', $args, '', $query_type ); | |
| 781 | 1179 | } else { |
| 782 | - // if the query is not an array, then it has already been prepared | |
| 1180 | + // If the query is not an array, then it has already been prepared | |
| 783 | 1181 | $query .= FrmDb::prepend_and_or_where( ' WHERE ', $where ) . $order_by . $limit; |
| 784 | 1182 | |
| 785 | - $function_name = ( $query_type == 'row' ) ? 'get_row' : 'get_results'; | |
| 1183 | + $function_name = $query_type === 'row' ? 'get_row' : 'get_results'; | |
| 786 | 1184 | $results = $wpdb->$function_name( $query ); |
| 787 | 1185 | } |
| 788 | 1186 | unset( $where ); |
| 789 | 1187 | |
| @@ -795,12 +1193,18 @@ | ||
| 795 | 1193 | } |
| 796 | 1194 | |
| 797 | 1195 | /** |
| 798 | 1196 | * @since 2.0.8 |
| 1197 | + * | |
| 1198 | + * @param array|object|null $results Results. | |
| 1199 | + * | |
| 1200 | + * @return void | |
| 799 | 1201 | */ |
| 800 | 1202 | private static function format_field_results( &$results ) { |
| 801 | 1203 | if ( is_array( $results ) ) { |
| 802 | 1204 | foreach ( $results as $r_key => $result ) { |
| 1205 | + self::add_slashes_to_format_before_setting_field_cache( $result ); | |
| 1206 | + | |
| 803 | 1207 | FrmDb::set_cache( $result->id, $result, 'frm_field' ); |
| 804 | 1208 | FrmDb::set_cache( $result->field_key, $result, 'frm_field' ); |
| 805 | 1209 | |
| 806 | 1210 | self::prepare_options( $result ); |
| @@ -818,11 +1222,34 @@ | ||
| 818 | 1222 | } |
| 819 | 1223 | } |
| 820 | 1224 | |
| 821 | 1225 | /** |
| 1226 | + * When $result->field_options is an array and not a serialized string there is only a single backslash. | |
| 1227 | + * Cached results are unslashed in FrmField::getAll, so we need to make sure that the cached object has an extra backslash. | |
| 1228 | + * Otherwise the backslash is stripped away on load. | |
| 1229 | + * | |
| 1230 | + * @since 6.15 | |
| 1231 | + * | |
| 1232 | + * @param stdClass $result | |
| 1233 | + * | |
| 1234 | + * @return void | |
| 1235 | + */ | |
| 1236 | + private static function add_slashes_to_format_before_setting_field_cache( $result ) { | |
| 1237 | + if ( ! isset( $result->field_options ) || ! is_array( $result->field_options ) || empty( $result->field_options['format'] ) ) { | |
| 1238 | + return; | |
| 1239 | + } | |
| 1240 | + | |
| 1241 | + $result->field_options['format'] = addslashes( $result->field_options['format'] ); | |
| 1242 | + } | |
| 1243 | + | |
| 1244 | + /** | |
| 822 | 1245 | * Unserialize all the serialized field data |
| 823 | 1246 | * |
| 824 | 1247 | * @since 2.0 |
| 1248 | + * | |
| 1249 | + * @param object $results | |
| 1250 | + * | |
| 1251 | + * @return void | |
| 825 | 1252 | */ |
| 826 | 1253 | private static function prepare_options( &$results ) { |
| 827 | 1254 | FrmAppHelper::unserialize_or_decode( $results->field_options ); |
| 828 | 1255 | FrmAppHelper::unserialize_or_decode( $results->options ); |
| @@ -828,19 +1255,32 @@ | ||
| 828 | 1255 | FrmAppHelper::unserialize_or_decode( $results->options ); |
| 829 | 1256 | |
| 830 | 1257 | // Allow a single box to be checked for the default value. |
| 831 | 1258 | $before = $results->default_value; |
| 1259 | + | |
| 1260 | + $field_object = FrmFieldFactory::get_field_type( $results->type ); | |
| 1261 | + | |
| 1262 | + if ( ! $field_object->should_unserialize_value() ) { | |
| 1263 | + return; | |
| 1264 | + } | |
| 1265 | + | |
| 832 | 1266 | FrmAppHelper::unserialize_or_decode( $results->default_value ); |
| 833 | - if ( $before === $results->default_value && ! is_array( $before ) && strpos( $before, '["' ) === 0 ) { | |
| 1267 | + | |
| 1268 | + if ( $before === $results->default_value && is_string( $before ) && str_starts_with( $before, '["' ) ) { | |
| 834 | 1269 | $results->default_value = FrmAppHelper::maybe_json_decode( $results->default_value ); |
| 835 | 1270 | } |
| 836 | 1271 | } |
| 837 | 1272 | |
| 838 | 1273 | /** |
| 839 | - * If a form has too many fields, thay won't all save into a single transient. | |
| 1274 | + * If a form has too many fields, they won't all save into a single transient. | |
| 840 | 1275 | * We'll break them into groups of 200 |
| 841 | 1276 | * |
| 842 | 1277 | * @since 2.0.1 |
| 1278 | + * | |
| 1279 | + * @param int|string $form_id Form ID. | |
| 1280 | + * @param array $args Additional arguments. | |
| 1281 | + * | |
| 1282 | + * @return array | |
| 843 | 1283 | */ |
| 844 | 1284 | private static function get_fields_from_transients( $form_id, $args ) { |
| 845 | 1285 | $fields = array(); |
| 846 | 1286 | self::get_next_transient( $fields, 'frm_form_fields_' . $form_id . $args['inc_embed'] . $args['inc_repeat'] ); |
| @@ -851,22 +1291,32 @@ | ||
| 851 | 1291 | /** |
| 852 | 1292 | * Called by get_fields_from_transients |
| 853 | 1293 | * |
| 854 | 1294 | * @since 2.0.1 |
| 1295 | + * | |
| 1296 | + * @param array $fields Array of fields. | |
| 1297 | + * @param string $base_name Base name. | |
| 1298 | + * @param int $next Next transient number. | |
| 1299 | + * | |
| 1300 | + * @return void | |
| 855 | 1301 | */ |
| 856 | 1302 | private static function get_next_transient( &$fields, $base_name, $next = 0 ) { |
| 857 | 1303 | $name = $next ? $base_name . $next : $base_name; |
| 858 | 1304 | $next_fields = get_transient( $name ); |
| 859 | 1305 | |
| 860 | - if ( $next_fields ) { | |
| 861 | - $fields = array_merge( $fields, $next_fields ); | |
| 1306 | + if ( ! $next_fields ) { | |
| 1307 | + return; | |
| 1308 | + } | |
| 862 | 1309 | |
| 863 | - if ( count( $next_fields ) >= self::$transient_size ) { | |
| 864 | - // if this transient is full, check for another | |
| 865 | - $next ++; | |
| 866 | - self::get_next_transient( $fields, $base_name, $next ); | |
| 867 | - } | |
| 1310 | + $fields = array_merge( $fields, $next_fields ); | |
| 1311 | + | |
| 1312 | + if ( count( $next_fields ) < self::$transient_size ) { | |
| 1313 | + return; | |
| 868 | 1314 | } |
| 1315 | + | |
| 1316 | + // If this transient is full, check for another | |
| 1317 | + ++$next; | |
| 1318 | + self::get_next_transient( $fields, $base_name, $next ); | |
| 869 | 1319 | } |
| 870 | 1320 | |
| 871 | 1321 | /** |
| 872 | 1322 | * Save the transients in chunks for large forms |
| @@ -871,8 +1321,15 @@ | ||
| 871 | 1321 | /** |
| 872 | 1322 | * Save the transients in chunks for large forms |
| 873 | 1323 | * |
| 874 | 1324 | * @since 2.0.1 |
| 1325 | + * | |
| 1326 | + * @param array $fields Array of fields. | |
| 1327 | + * @param int|string $form_id Form ID. | |
| 1328 | + * @param int $next Next transient number. | |
| 1329 | + * @param array $args Additional arguments. | |
| 1330 | + * | |
| 1331 | + * @return void | |
| 875 | 1332 | */ |
| 876 | 1333 | private static function set_field_transient( &$fields, $form_id, $next = 0, $args = array() ) { |
| 877 | 1334 | $base_name = 'frm_form_fields_' . $form_id . $args['inc_embed'] . $args['inc_repeat']; |
| 878 | 1335 | $field_chunks = array_chunk( $fields, self::$transient_size ); |
| @@ -879,12 +1336,13 @@ | ||
| 879 | 1336 | |
| 880 | 1337 | foreach ( $field_chunks as $field ) { |
| 881 | 1338 | $name = $next ? $base_name . $next : $base_name; |
| 882 | 1339 | $set = set_transient( $name, $field, 60 * 60 * 6 ); |
| 1340 | + | |
| 883 | 1341 | if ( ! $set ) { |
| 884 | - // the transient didn't save | |
| 885 | - if ( $name != $base_name ) { | |
| 886 | - // if the first saved an others fail, this will show an incmoplete form | |
| 1342 | + // The transient didn't save | |
| 1343 | + if ( $name !== $base_name ) { | |
| 1344 | + // If the first saved an others fail, this will show an incomplete form | |
| 887 | 1345 | self::delete_form_transient( $form_id ); |
| 888 | 1346 | } |
| 889 | 1347 | |
| 890 | 1348 | return; |
| @@ -889,18 +1347,26 @@ | ||
| 889 | 1347 | |
| 890 | 1348 | return; |
| 891 | 1349 | } |
| 892 | 1350 | |
| 893 | - $next ++; | |
| 1351 | + ++$next; | |
| 894 | 1352 | } |
| 895 | 1353 | } |
| 896 | 1354 | |
| 1355 | + /** | |
| 1356 | + * @param string $type | |
| 1357 | + * | |
| 1358 | + * @return bool | |
| 1359 | + */ | |
| 897 | 1360 | public static function is_no_save_field( $type ) { |
| 898 | - return in_array( $type, self::no_save_fields() ); | |
| 1361 | + return in_array( $type, self::no_save_fields(), true ); | |
| 899 | 1362 | } |
| 900 | 1363 | |
| 1364 | + /** | |
| 1365 | + * @return string[] | |
| 1366 | + */ | |
| 901 | 1367 | public static function no_save_fields() { |
| 902 | - return array( 'divider', 'end_divider', 'captcha', 'break', 'html', 'form', 'summary' ); | |
| 1368 | + return array( 'divider', 'end_divider', 'captcha', 'break', 'html', 'form', 'summary', FrmSubmitHelper::FIELD_TYPE ); | |
| 903 | 1369 | } |
| 904 | 1370 | |
| 905 | 1371 | /** |
| 906 | 1372 | * Check if this field can hold an array of values |
| @@ -908,9 +1374,9 @@ | ||
| 908 | 1374 | * @since 2.0.9 |
| 909 | 1375 | * |
| 910 | 1376 | * @param array|object $field |
| 911 | 1377 | * |
| 912 | - * @return boolean | |
| 1378 | + * @return bool | |
| 913 | 1379 | */ |
| 914 | 1380 | public static function is_field_with_multiple_values( $field ) { |
| 915 | 1381 | if ( ! $field ) { |
| 916 | 1382 | return false; |
| @@ -917,19 +1383,16 @@ | ||
| 917 | 1383 | } |
| 918 | 1384 | |
| 919 | 1385 | $field_type = self::get_original_field_type( $field ); |
| 920 | 1386 | |
| 921 | - $is_multi_value_field = ( | |
| 922 | - self::is_checkbox( $field ) || | |
| 923 | - $field_type == 'address' || | |
| 924 | - self::is_multiple_select( $field ) | |
| 925 | - ); | |
| 926 | - | |
| 927 | - return $is_multi_value_field; | |
| 1387 | + return self::is_checkbox( $field ) || $field_type === 'address' || self::is_multiple_select( $field ); | |
| 928 | 1388 | } |
| 929 | 1389 | |
| 930 | 1390 | /** |
| 931 | 1391 | * @since 3.0 |
| 1392 | + * | |
| 1393 | + * @param array|object $field | |
| 1394 | + * | |
| 932 | 1395 | * @return string |
| 933 | 1396 | */ |
| 934 | 1397 | public static function get_field_type( $field ) { |
| 935 | 1398 | return is_array( $field ) ? $field['type'] : $field->type; |
| @@ -936,8 +1399,11 @@ | ||
| 936 | 1399 | } |
| 937 | 1400 | |
| 938 | 1401 | /** |
| 939 | 1402 | * @since 3.0 |
| 1403 | + * | |
| 1404 | + * @param array|object $field | |
| 1405 | + * | |
| 940 | 1406 | * @return string |
| 941 | 1407 | */ |
| 942 | 1408 | public static function get_original_field_type( $field ) { |
| 943 | 1409 | $field_type = self::get_field_type( $field ); |
| @@ -942,10 +1408,11 @@ | ||
| 942 | 1408 | public static function get_original_field_type( $field ) { |
| 943 | 1409 | $field_type = self::get_field_type( $field ); |
| 944 | 1410 | $original_type = self::get_option( $field, 'original_type' ); |
| 945 | 1411 | |
| 946 | - if ( ! empty( $original_type ) && $original_type != $field_type ) { | |
| 947 | - $field_type = $original_type; // check the original type for arrays | |
| 1412 | + if ( $original_type && $original_type !== $field_type ) { | |
| 1413 | + // Check the original type for arrays. | |
| 1414 | + return $original_type; | |
| 948 | 1415 | } |
| 949 | 1416 | |
| 950 | 1417 | return $field_type; |
| 951 | 1418 | } |
| @@ -953,14 +1420,15 @@ | ||
| 953 | 1420 | /** |
| 954 | 1421 | * Check if this is a multiselect dropdown field |
| 955 | 1422 | * |
| 956 | 1423 | * @since 2.0.9 |
| 957 | - * @return boolean | |
| 1424 | + * | |
| 1425 | + * @param array|object $field Field object. | |
| 1426 | + * | |
| 1427 | + * @return bool | |
| 958 | 1428 | */ |
| 959 | 1429 | public static function is_multiple_select( $field ) { |
| 960 | - $field_type = self::get_field_type( $field ); | |
| 961 | - $is_multiple = self::is_option_true( $field, 'multiple' ) && self::is_field_type( $field, 'select' ) && $field_type !== 'hidden'; | |
| 962 | - | |
| 1430 | + $is_multiple = self::is_option_true( $field, 'multiple' ) && self::is_field_type( $field, 'select' ) && self::get_field_type( $field ) !== 'hidden'; | |
| 963 | 1431 | return apply_filters( 'frm_is_multiple_select', $is_multiple, $field ); |
| 964 | 1432 | } |
| 965 | 1433 | |
| 966 | 1434 | /** |
| @@ -967,82 +1435,134 @@ | ||
| 967 | 1435 | * Check if a field is read only. Read only can be set in the field options, |
| 968 | 1436 | * but disabled with the shortcode options |
| 969 | 1437 | * |
| 970 | 1438 | * @since 2.0.9 |
| 1439 | + * | |
| 1440 | + * @param array|object $field | |
| 1441 | + * | |
| 1442 | + * @return bool | |
| 971 | 1443 | */ |
| 972 | 1444 | public static function is_read_only( $field ) { |
| 973 | 1445 | global $frm_vars; |
| 974 | - | |
| 975 | - return ( self::is_option_true( $field, 'read_only' ) && ( ! isset( $frm_vars['readonly'] ) || $frm_vars['readonly'] != 'disabled' ) ); | |
| 1446 | + return self::is_option_true( $field, 'read_only' ) && ( ! isset( $frm_vars['readonly'] ) || $frm_vars['readonly'] !== 'disabled' ); | |
| 976 | 1447 | } |
| 977 | 1448 | |
| 978 | 1449 | /** |
| 979 | 1450 | * @since 2.0.9 |
| 1451 | + * | |
| 1452 | + * @param array $field | |
| 1453 | + * | |
| 1454 | + * @return bool | |
| 980 | 1455 | */ |
| 981 | 1456 | public static function is_required( $field ) { |
| 982 | - $required = ( $field['required'] != '0' ); | |
| 983 | - $required = apply_filters( 'frm_is_field_required', $required, $field ); | |
| 1457 | + $required = $field['required'] != '0'; // phpcs:ignore Universal.Operators.StrictComparisons | |
| 984 | 1458 | |
| 985 | - return $required; | |
| 1459 | + /** | |
| 1460 | + * @param bool $required | |
| 1461 | + * @param array $field | |
| 1462 | + */ | |
| 1463 | + return (bool) apply_filters( 'frm_is_field_required', $required, $field ); | |
| 986 | 1464 | } |
| 987 | 1465 | |
| 988 | 1466 | /** |
| 989 | 1467 | * @since 2.0.9 |
| 1468 | + * | |
| 1469 | + * @param array|object $field | |
| 1470 | + * @param string $option | |
| 1471 | + * | |
| 1472 | + * @return bool | |
| 990 | 1473 | */ |
| 991 | 1474 | public static function is_option_true( $field, $option ) { |
| 992 | 1475 | if ( is_array( $field ) ) { |
| 993 | 1476 | return self::is_option_true_in_array( $field, $option ); |
| 994 | - } else { | |
| 995 | - return self::is_option_true_in_object( $field, $option ); | |
| 996 | 1477 | } |
| 1478 | + return self::is_option_true_in_object( $field, $option ); | |
| 997 | 1479 | } |
| 998 | 1480 | |
| 999 | 1481 | /** |
| 1000 | 1482 | * @since 2.0.9 |
| 1483 | + * | |
| 1484 | + * @param array|object $field | |
| 1485 | + * @param string $option | |
| 1486 | + * | |
| 1487 | + * @return bool | |
| 1001 | 1488 | */ |
| 1002 | 1489 | public static function is_option_empty( $field, $option ) { |
| 1003 | 1490 | if ( is_array( $field ) ) { |
| 1004 | 1491 | return self::is_option_empty_in_array( $field, $option ); |
| 1005 | - } else { | |
| 1006 | - return self::is_option_empty_in_object( $field, $option ); | |
| 1007 | 1492 | } |
| 1493 | + return self::is_option_empty_in_object( $field, $option ); | |
| 1008 | 1494 | } |
| 1009 | 1495 | |
| 1496 | + /** | |
| 1497 | + * @param array $field | |
| 1498 | + * @param string $option | |
| 1499 | + * | |
| 1500 | + * @return bool | |
| 1501 | + */ | |
| 1010 | 1502 | public static function is_option_true_in_array( $field, $option ) { |
| 1011 | - return isset( $field[ $option ] ) && $field[ $option ]; | |
| 1503 | + return ! empty( $field[ $option ] ); | |
| 1012 | 1504 | } |
| 1013 | 1505 | |
| 1506 | + /** | |
| 1507 | + * @param object $field | |
| 1508 | + * @param string $option | |
| 1509 | + * | |
| 1510 | + * @return bool | |
| 1511 | + */ | |
| 1014 | 1512 | public static function is_option_true_in_object( $field, $option ) { |
| 1015 | - return isset( $field->field_options[ $option ] ) && $field->field_options[ $option ]; | |
| 1513 | + return ! empty( $field->field_options[ $option ] ); | |
| 1016 | 1514 | } |
| 1017 | 1515 | |
| 1516 | + /** | |
| 1517 | + * @param array $field | |
| 1518 | + * @param string $option | |
| 1519 | + * | |
| 1520 | + * @return bool | |
| 1521 | + */ | |
| 1018 | 1522 | public static function is_option_empty_in_array( $field, $option ) { |
| 1019 | - return ! isset( $field[ $option ] ) || empty( $field[ $option ] ); | |
| 1523 | + return empty( $field[ $option ] ); | |
| 1020 | 1524 | } |
| 1021 | 1525 | |
| 1526 | + /** | |
| 1527 | + * @param object $field | |
| 1528 | + * @param string $option | |
| 1529 | + * | |
| 1530 | + * @return bool | |
| 1531 | + */ | |
| 1022 | 1532 | public static function is_option_empty_in_object( $field, $option ) { |
| 1023 | - return ! isset( $field->field_options[ $option ] ) || empty( $field->field_options[ $option ] ); | |
| 1533 | + return empty( $field->field_options[ $option ] ); | |
| 1024 | 1534 | } |
| 1025 | 1535 | |
| 1536 | + /** | |
| 1537 | + * @param stdClass $field | |
| 1538 | + * @param string $option | |
| 1539 | + * | |
| 1540 | + * @return bool | |
| 1541 | + */ | |
| 1026 | 1542 | public static function is_option_value_in_object( $field, $option ) { |
| 1027 | - return isset( $field->field_options[ $option ] ) && $field->field_options[ $option ] != ''; | |
| 1543 | + return isset( $field->field_options[ $option ] ) && $field->field_options[ $option ] != ''; // phpcs:ignore Universal.Operators.StrictComparisons | |
| 1028 | 1544 | } |
| 1029 | 1545 | |
| 1030 | 1546 | /** |
| 1031 | 1547 | * @since 2.0.18 |
| 1548 | + * | |
| 1549 | + * @param array|object $field | |
| 1550 | + * @param string $option | |
| 1551 | + * | |
| 1552 | + * @return mixed | |
| 1032 | 1553 | */ |
| 1033 | 1554 | public static function get_option( $field, $option ) { |
| 1034 | - if ( is_array( $field ) ) { | |
| 1035 | - $option = self::get_option_in_array( $field, $option ); | |
| 1036 | - } else { | |
| 1037 | - $option = self::get_option_in_object( $field, $option ); | |
| 1038 | - } | |
| 1039 | - | |
| 1040 | - return $option; | |
| 1555 | + return is_array( $field ) ? self::get_option_in_array( $field, $option ) : self::get_option_in_object( $field, $option ); | |
| 1041 | 1556 | } |
| 1042 | 1557 | |
| 1558 | + /** | |
| 1559 | + * @param array $field | |
| 1560 | + * @param string $option | |
| 1561 | + * | |
| 1562 | + * @return mixed | |
| 1563 | + */ | |
| 1043 | 1564 | public static function get_option_in_array( $field, $option ) { |
| 1044 | - | |
| 1045 | 1565 | if ( isset( $field[ $option ] ) ) { |
| 1046 | 1566 | $this_option = $field[ $option ]; |
| 1047 | 1567 | } elseif ( isset( $field['field_options'] ) && is_array( $field['field_options'] ) && isset( $field['field_options'][ $option ] ) ) { |
| 1048 | 1568 | $this_option = $field['field_options'][ $option ]; |
| @@ -1052,23 +1572,28 @@ | ||
| 1052 | 1572 | |
| 1053 | 1573 | return $this_option; |
| 1054 | 1574 | } |
| 1055 | 1575 | |
| 1576 | + /** | |
| 1577 | + * @param object $field | |
| 1578 | + * @param string $option | |
| 1579 | + * | |
| 1580 | + * @return mixed | |
| 1581 | + */ | |
| 1056 | 1582 | public static function get_option_in_object( $field, $option ) { |
| 1057 | - return isset( $field->field_options[ $option ] ) ? $field->field_options[ $option ] : ''; | |
| 1583 | + return $field->field_options[ $option ] ?? ''; | |
| 1058 | 1584 | } |
| 1059 | 1585 | |
| 1060 | 1586 | /** |
| 1061 | 1587 | * @since 2.0.09 |
| 1588 | + * | |
| 1589 | + * @param array|object $field | |
| 1590 | + * | |
| 1591 | + * @return bool | |
| 1062 | 1592 | */ |
| 1063 | 1593 | public static function is_repeating_field( $field ) { |
| 1064 | - if ( is_array( $field ) ) { | |
| 1065 | - $is_repeating_field = ( 'divider' == $field['type'] ); | |
| 1066 | - } else { | |
| 1067 | - $is_repeating_field = ( 'divider' == $field->type ); | |
| 1068 | - } | |
| 1069 | - | |
| 1070 | - return ( $is_repeating_field && self::is_option_true( $field, 'repeat' ) ); | |
| 1594 | + $is_repeating_field = is_array( $field ) ? 'divider' === $field['type'] : 'divider' === $field->type; | |
| 1595 | + return $is_repeating_field && self::is_option_true( $field, 'repeat' ); | |
| 1071 | 1596 | } |
| 1072 | 1597 | |
| 1073 | 1598 | /** |
| 1074 | 1599 | * @param string $key |
| @@ -1076,9 +1601,8 @@ | ||
| 1076 | 1601 | * @return int field id |
| 1077 | 1602 | */ |
| 1078 | 1603 | public static function get_id_by_key( $key ) { |
| 1079 | 1604 | $id = FrmDb::get_var( 'frm_fields', array( 'field_key' => sanitize_title( $key ) ) ); |
| 1080 | - | |
| 1081 | 1605 | return (int) $id; |
| 1082 | 1606 | } |
| 1083 | 1607 | |
| 1084 | 1608 | /** |
| @@ -1083,18 +1607,22 @@ | ||
| 1083 | 1607 | |
| 1084 | 1608 | /** |
| 1085 | 1609 | * @param string $id |
| 1086 | 1610 | * |
| 1087 | - * @return null|string | |
| 1611 | + * @return string|null | |
| 1088 | 1612 | */ |
| 1089 | 1613 | public static function get_key_by_id( $id ) { |
| 1090 | 1614 | return FrmDb::get_var( 'frm_fields', array( 'id' => $id ), 'field_key' ); |
| 1091 | 1615 | } |
| 1092 | 1616 | |
| 1617 | + /** | |
| 1618 | + * @param array|object $field | |
| 1619 | + * | |
| 1620 | + * @return bool | |
| 1621 | + */ | |
| 1093 | 1622 | public static function is_image( $field ) { |
| 1094 | 1623 | $type = self::get_field_type( $field ); |
| 1095 | - | |
| 1096 | - return ( $type == 'url' && self::get_option( $field, 'show_image' ) ); | |
| 1624 | + return $type === 'url' && self::get_option( $field, 'show_image' ); | |
| 1097 | 1625 | } |
| 1098 | 1626 | |
| 1099 | 1627 | /** |
| 1100 | 1628 | * Check if field is radio or Dynamic radio |
| @@ -1102,9 +1630,9 @@ | ||
| 1102 | 1630 | * @since 3.0 |
| 1103 | 1631 | * |
| 1104 | 1632 | * @param array|object $field |
| 1105 | 1633 | * |
| 1106 | - * @return boolean true if field type is radio or Dynamic radio | |
| 1634 | + * @return bool true if field type is radio or Dynamic radio | |
| 1107 | 1635 | */ |
| 1108 | 1636 | public static function is_radio( $field ) { |
| 1109 | 1637 | return self::is_field_type( $field, 'radio' ); |
| 1110 | 1638 | } |
| @@ -1115,9 +1643,9 @@ | ||
| 1115 | 1643 | * @since 3.0 |
| 1116 | 1644 | * |
| 1117 | 1645 | * @param array|object $field |
| 1118 | 1646 | * |
| 1119 | - * @return boolean true if field type is checkbox or Dynamic checkbox | |
| 1647 | + * @return bool true if field type is checkbox or Dynamic checkbox | |
| 1120 | 1648 | */ |
| 1121 | 1649 | public static function is_checkbox( $field ) { |
| 1122 | 1650 | return self::is_field_type( $field, 'checkbox' ); |
| 1123 | 1651 | } |
| @@ -1127,23 +1655,17 @@ | ||
| 1127 | 1655 | * |
| 1128 | 1656 | * @since 3.0 |
| 1129 | 1657 | * |
| 1130 | 1658 | * @param array|object $field |
| 1131 | - * @param string $is_type Options include radio, checkbox, text | |
| 1659 | + * @param string $is_type Options include radio, checkbox, text. | |
| 1132 | 1660 | * |
| 1133 | - * @return boolean true if field type is checkbox or Dynamic checkbox | |
| 1661 | + * @return bool true if field type is checkbox or Dynamic checkbox | |
| 1134 | 1662 | */ |
| 1135 | 1663 | public static function is_field_type( $field, $is_type ) { |
| 1136 | - $field_type = self::get_original_field_type( $field ); | |
| 1137 | - $data_type = self::get_option( $field, 'data_type' ); | |
| 1664 | + $field_type = self::get_original_field_type( $field ); | |
| 1665 | + $data_type = self::get_option( $field, 'data_type' ); | |
| 1666 | + $is_field_type = $is_type === $field_type || ( 'data' === $field_type && $is_type === $data_type ) || ( 'lookup' === $field_type && $is_type === $data_type ) || ( 'product' === $field_type && $is_type === $data_type ); // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 1138 | 1667 | |
| 1139 | - $is_field_type = ( | |
| 1140 | - $is_type === $field_type || | |
| 1141 | - ( 'data' === $field_type && $is_type === $data_type ) || | |
| 1142 | - ( 'lookup' === $field_type && $is_type === $data_type ) || | |
| 1143 | - ( 'product' === $field_type && $is_type === $data_type ) | |
| 1144 | - ); | |
| 1145 | - | |
| 1146 | 1668 | /** |
| 1147 | 1669 | * When a field type is checked, allow individual fields |
| 1148 | 1670 | * to set the type. |
| 1149 | 1671 | * |
| @@ -1157,12 +1679,12 @@ | ||
| 1157 | 1679 | * |
| 1158 | 1680 | * @since 4.10.02 |
| 1159 | 1681 | * |
| 1160 | 1682 | * @param array $field Field array. |
| 1683 | + * | |
| 1161 | 1684 | * @return bool |
| 1162 | 1685 | */ |
| 1163 | 1686 | public static function is_combo_field( $field ) { |
| 1164 | 1687 | $field_type_obj = FrmFieldFactory::get_field_factory( $field ); |
| 1165 | - | |
| 1166 | 1688 | return ! empty( $field_type_obj->is_combo_field ); |
| 1167 | 1689 | } |
| 1168 | 1690 | } |
