Template.php
94 lines
| 1 | <?php |
| 2 | namespace Give\Helpers\Form; |
| 3 | |
| 4 | use Give\Form\Template\LegacyFormSettingCompatibility; |
| 5 | use Give\Helpers\Form\Template\Utils\Frontend; |
| 6 | |
| 7 | /** |
| 8 | * @since 2.7.0 |
| 9 | */ |
| 10 | class Template { |
| 11 | /** |
| 12 | * This function will return selected form template for a specific form. |
| 13 | * |
| 14 | * @param int $formId Form id. Default value: check explanation in ./Utils.php:103 |
| 15 | * |
| 16 | * @return string |
| 17 | * @since 2.7.0 |
| 18 | */ |
| 19 | public static function getActiveID( $formId = null ) { |
| 20 | return Give()->form_meta->get_meta( $formId ?: Frontend::getFormId(), '_give_form_template', true ); |
| 21 | } |
| 22 | |
| 23 | /** |
| 24 | * Return saved form template settings |
| 25 | * |
| 26 | * @param int $formId |
| 27 | * @param string $templateId |
| 28 | * |
| 29 | * @return array |
| 30 | * @since 2.7.0 |
| 31 | */ |
| 32 | public static function getOptions( $formId = null, $templateId = '' ) { |
| 33 | $formId = $formId ?: Frontend::getFormId(); |
| 34 | $template = $templateId ?: Give()->form_meta->get_meta( $formId, '_give_form_template', true ); |
| 35 | $settings = Give()->form_meta->get_meta( $formId, "_give_{$template}_form_template_settings", true ); |
| 36 | |
| 37 | $settings = $settings ?: []; |
| 38 | |
| 39 | // Exit if admin did not have any settings. |
| 40 | // New donation form does not have any setting saved. |
| 41 | if ( ! $settings ) { |
| 42 | return $settings; |
| 43 | } |
| 44 | |
| 45 | // Backward compatibility for migrated settings. |
| 46 | // 1. "Introduction -> Primary Color" move to "Visual Appearance -> Primary Color" |
| 47 | // 2. "Payment Amount -> Decimal amounts" move to "Visual Appearance -> Decimal amounts" |
| 48 | self::handleOptionsBackwardCompatibility( $settings ); |
| 49 | |
| 50 | return $settings; |
| 51 | } |
| 52 | |
| 53 | /** |
| 54 | * Save settings |
| 55 | * |
| 56 | * @sinxe 2.7.0 |
| 57 | * @param $formId |
| 58 | * @param $settings |
| 59 | * |
| 60 | * @return mixed |
| 61 | */ |
| 62 | public static function saveOptions( $formId, $settings ) { |
| 63 | $templateId = Give()->form_meta->get_meta( $formId, '_give_form_template', true ); |
| 64 | $template = Give()->templates->getTemplate( $templateId ); |
| 65 | $isUpdated = Give()->form_meta->update_meta( $formId, "_give_{$templateId}_form_template_settings", $settings ); |
| 66 | |
| 67 | /* |
| 68 | * Below code save legacy setting which connected/mapped to form template setting. |
| 69 | * 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. |
| 70 | * |
| 71 | * Note: We can remove legacy setting compatibility by returning anything except LegacyFormSettingCompatibility class object. |
| 72 | */ |
| 73 | $legacySettingHandler = new LegacyFormSettingCompatibility( $template ); |
| 74 | $legacySettingHandler->save( $formId, $settings ); |
| 75 | |
| 76 | return $isUpdated; |
| 77 | } |
| 78 | |
| 79 | /** |
| 80 | * @since 2.16.0 |
| 81 | * |
| 82 | * @param array $settings |
| 83 | */ |
| 84 | public static function handleOptionsBackwardCompatibility( &$settings ) { |
| 85 | if ( ! isset( $settings['visual_appearance'] ) ) { |
| 86 | $settings['visual_appearance']['decimals_enabled'] = $settings['payment_amount']['decimals_enabled']; |
| 87 | $settings['visual_appearance']['primary_color'] = $settings['introduction']['primary_color']; |
| 88 | } else { |
| 89 | $settings['payment_amount']['decimals_enabled'] = $settings['visual_appearance']['decimals_enabled']; |
| 90 | $settings['introduction']['primary_color'] = $settings['visual_appearance']['primary_color']; |
| 91 | } |
| 92 | } |
| 93 | } |
| 94 |