Template.php
140 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Helpers\Form; |
| 4 | |
| 5 | use Give\Form\Template\LegacyFormSettingCompatibility; |
| 6 | use Give\Helpers\Form\Template\Utils\Frontend; |
| 7 | |
| 8 | /** |
| 9 | * @since 2.7.0 |
| 10 | */ |
| 11 | class Template |
| 12 | { |
| 13 | /** |
| 14 | * This function will return selected form template for a specific form. |
| 15 | * |
| 16 | * @since 2.7.0 |
| 17 | * |
| 18 | * @param int $formId Form id. Default value: check explanation in ./Utils.php:103 |
| 19 | * |
| 20 | * @return string |
| 21 | */ |
| 22 | public static function getActiveID($formId = null) |
| 23 | { |
| 24 | return Give()->form_meta->get_meta($formId ?: Frontend::getFormId(), '_give_form_template', true); |
| 25 | } |
| 26 | |
| 27 | /** |
| 28 | * Return saved form template settings |
| 29 | * |
| 30 | * @since 2.7.0 |
| 31 | * |
| 32 | * @param string $templateId |
| 33 | * |
| 34 | * @param int $formId |
| 35 | * |
| 36 | * @return array |
| 37 | */ |
| 38 | public static function getOptions($formId = null, $templateId = '') |
| 39 | { |
| 40 | $formId = $formId ?: Frontend::getFormId(); |
| 41 | $template = $templateId ?: Give()->form_meta->get_meta($formId, '_give_form_template', true); |
| 42 | $settings = Give()->form_meta->get_meta($formId, "_give_{$template}_form_template_settings", true); |
| 43 | |
| 44 | $settings = $settings ?: []; |
| 45 | |
| 46 | // Exit if admin did not have any settings. |
| 47 | // New donation form does not have any setting saved. |
| 48 | if ( ! $settings) { |
| 49 | return $settings; |
| 50 | } |
| 51 | |
| 52 | /** |
| 53 | * Backwards compatibility for forms saved before the Donation Summary was introduced. |
| 54 | * @since 2.17.0 |
| 55 | */ |
| 56 | if ( ! isset($settings['payment_information'])) { |
| 57 | $settings['payment_information'] = [ |
| 58 | 'donation_summary_enabled' => 'disabled', // Disable by default for existing forms. |
| 59 | 'donation_summary_heading' => __('Here\'s what you\'re about to donate:', 'give'), |
| 60 | 'donation_summary_location' => 'give_donation_form_before_submit', |
| 61 | ]; |
| 62 | } |
| 63 | |
| 64 | // Backward compatibility for migrated settings. |
| 65 | // 1. "Introduction -> Primary Color" move to "Visual Appearance -> Primary Color" |
| 66 | // 2. "Payment Amount -> Decimal amounts" move to "Visual Appearance -> Decimal amounts" |
| 67 | return self::handleOptionsBackwardCompatibility($settings, $template); |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * Save settings |
| 72 | * |
| 73 | * @sinxe 2.7.0 |
| 74 | * |
| 75 | * @param $formId |
| 76 | * @param $settings |
| 77 | * |
| 78 | * @return bool |
| 79 | */ |
| 80 | public static function saveOptions($formId, $settings) |
| 81 | { |
| 82 | $templateId = Give()->form_meta->get_meta($formId, '_give_form_template', true); |
| 83 | $template = Give()->templates->getTemplate($templateId); |
| 84 | $isUpdated = Give()->form_meta->update_meta($formId, "_give_{$templateId}_form_template_settings", $settings); |
| 85 | |
| 86 | /* |
| 87 | * Below code save legacy setting which connected/mapped to form template setting. |
| 88 | * Existing form render on basis of these settings if missed then required output will not generate from give_form_shortcode -> give_get_donation_form function. |
| 89 | * |
| 90 | * Note: We can remove legacy setting compatibility by returning anything except LegacyFormSettingCompatibility class object. |
| 91 | */ |
| 92 | $legacySettingHandler = new LegacyFormSettingCompatibility($template); |
| 93 | $legacySettingHandler->save($formId, $settings); |
| 94 | |
| 95 | return $isUpdated; |
| 96 | } |
| 97 | |
| 98 | /** |
| 99 | * @since 2.16.0 |
| 100 | * |
| 101 | * @since 2.16.2 Accepts parameter "call by value". Pass multiple to arguments to isset to validate whether deprecated settings exist. |
| 102 | * |
| 103 | * @param array $settings |
| 104 | * |
| 105 | * @param string $template |
| 106 | * |
| 107 | * @return array $settings |
| 108 | */ |
| 109 | public static function handleOptionsBackwardCompatibility($settings, $template) |
| 110 | { |
| 111 | if (isset($settings['visual_appearance'])) { |
| 112 | if (isset($settings['visual_appearance']['decimals_enabled'])) { |
| 113 | $settings['payment_amount']['decimals_enabled'] = $settings['visual_appearance']['decimals_enabled']; |
| 114 | } |
| 115 | $settings['introduction']['primary_color'] = $settings['visual_appearance']['primary_color']; |
| 116 | } elseif (isset($settings['payment_amount'], $settings['introduction'])) { |
| 117 | if (isset($settings['payment_amount']['decimals_enabled'])) { |
| 118 | $settings['visual_appearance']['decimals_enabled'] = $settings['payment_amount']['decimals_enabled']; |
| 119 | } else { |
| 120 | $settings['visual_appearance']['decimals_enabled'] = 'disabled'; |
| 121 | } |
| 122 | if (isset($settings['visual_appearance']['primary_color'])) { |
| 123 | $settings['visual_appearance']['primary_color'] = $settings['introduction']['primary_color']; |
| 124 | } else { |
| 125 | switch ($template) { |
| 126 | case 'sequoia': |
| 127 | $settings['visual_appearance']['primary_color'] = '#28C77B'; |
| 128 | break; |
| 129 | case 'classic': |
| 130 | default: |
| 131 | $settings['visual_appearance']['primary_color'] = '#1E8CBE'; |
| 132 | break; |
| 133 | } |
| 134 | } |
| 135 | } |
| 136 | |
| 137 | return $settings; |
| 138 | } |
| 139 | } |
| 140 |