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