| 1 |
<?php |
| 2 |
namespace Give\Form\Template; |
| 3 |
|
| 4 |
use Give\Form\Template; |
| 5 |
use Give\Helpers\Form\Utils; |
| 6 |
|
| 7 |
/** |
| 8 |
* Class LegacyFormSettingCompatibility |
| 9 |
* |
| 10 |
* @since 2.7.0 |
| 11 |
* @package Give\Form\Template |
| 12 |
*/ |
| 13 |
class LegacyFormSettingCompatibility { |
| 14 |
/** |
| 15 |
* Name of key which we are using in field description to connect template setting with legacy setting. |
| 16 |
* |
| 17 |
* @var string |
| 18 |
*/ |
| 19 |
public static $key = 'mapToLegacySetting'; |
| 20 |
|
| 21 |
/** |
| 22 |
* Map legacy setting key name to template function/property from which you will get donation form configuration about different features. |
| 23 |
* |
| 24 |
* @var array $mapToTemplateProperty Form settings default values for form template. |
| 25 |
*/ |
| 26 |
private $mapToTemplateProperty = [ |
| 27 |
'_give_display_style' => 'donationFormLevelsStyle', |
| 28 |
'_give_payment_display' => 'donationFormStyle', |
| 29 |
'_give_form_floating_labels' => 'floatingLabelsStyle', |
| 30 |
'_give_reveal_label' => 'getContinueToDonationFormLabel', |
| 31 |
'_give_checkout_label' => 'getDonateNowButtonLabel', |
| 32 |
'_give_display_content' => 'showDonationIntroductionContent', |
| 33 |
'_give_content_placement' => 'getDonationIntroductionContentPosition', |
| 34 |
'_give_form_content' => 'getDonationIntroductionContent', |
| 35 |
]; |
| 36 |
|
| 37 |
/** |
| 38 |
* @var Template $template |
| 39 |
*/ |
| 40 |
private $template; |
| 41 |
|
| 42 |
/** |
| 43 |
* LegacyFormSettingCompatibility constructor. |
| 44 |
* |
| 45 |
* @param Template $template |
| 46 |
*/ |
| 47 |
public function __construct( Template $template ) { |
| 48 |
$this->template = $template; |
| 49 |
} |
| 50 |
|
| 51 |
/** |
| 52 |
* Save legacy settings. |
| 53 |
* |
| 54 |
* Note: we are using this function internally to store legacy form settings when save form template setting. |
| 55 |
* |
| 56 |
* @see src/Helpers/Form/Theme/Theme.php:46 we are using this function in set function. |
| 57 |
* @param int $formId |
| 58 |
* @param array $settings |
| 59 |
* @since 2.7.0 |
| 60 |
*/ |
| 61 |
public function save( $formId, $settings ) { |
| 62 |
$alreadySavedLegacySettings = []; |
| 63 |
$templateOptions = $this->template->getOptionsConfig(); |
| 64 |
$enableDisableValueSet = [ 'disabled', 'enabled' ]; |
| 65 |
|
| 66 |
foreach ( $templateOptions as $groupId => $group ) { |
| 67 |
foreach ( $group['fields'] as $field ) { |
| 68 |
// Continue if setting is not map to legacy setting. |
| 69 |
if ( ! isset( $field[ self::$key ] ) ) { |
| 70 |
continue; |
| 71 |
} |
| 72 |
|
| 73 |
Give()->form_meta->update_meta( $formId, $field[ self::$key ], $settings[ $groupId ][ $field['id'] ] ); |
| 74 |
$alreadySavedLegacySettings[] = $field[ self::$key ]; |
| 75 |
} |
| 76 |
} |
| 77 |
|
| 78 |
if ( $remainingSettings = array_diff( array_keys( $this->mapToTemplateProperty ), $alreadySavedLegacySettings ) ) { |
| 79 |
foreach ( $remainingSettings as $metaKey ) { |
| 80 |
$value = property_exists( $this->template, $this->mapToTemplateProperty[ $metaKey ] ) ? |
| 81 |
$this->template->{$this->mapToTemplateProperty[ $metaKey ]} : // Get value from property. |
| 82 |
$this->template->{$this->mapToTemplateProperty[ $metaKey ]}(); // Get value from function |
| 83 |
|
| 84 |
// Convert boolean value to enable and disabled. |
| 85 |
if ( is_bool( $value ) ) { |
| 86 |
$value = $enableDisableValueSet[ absint( $value ) ]; |
| 87 |
} |
| 88 |
|
| 89 |
Give()->form_meta->update_meta( |
| 90 |
$formId, |
| 91 |
$metaKey, |
| 92 |
$value |
| 93 |
); |
| 94 |
} |
| 95 |
} |
| 96 |
} |
| 97 |
|
| 98 |
/** |
| 99 |
* Migrate existing legacy form settings. |
| 100 |
* Note: Only for internal use. This function can be removed or change in future |
| 101 |
* |
| 102 |
* @since 2.7.0 |
| 103 |
*/ |
| 104 |
public static function migrateExistingFormSettings() { |
| 105 |
// Only migrate settings for existing form when editing. |
| 106 |
if ( ! isset( $_GET['action'] ) || 'edit' !== give_clean( $_GET['action'] ) ) { |
| 107 |
return; |
| 108 |
} |
| 109 |
|
| 110 |
$formId = absint( $_GET['post'] ); |
| 111 |
|
| 112 |
if ( ! Utils::isLegacyForm( $formId ) ) { |
| 113 |
return; |
| 114 |
} |
| 115 |
|
| 116 |
if ( Give()->form_meta->get_meta( $formId, '_give_legacy_form_template_settings', true ) ) { |
| 117 |
return; |
| 118 |
} |
| 119 |
|
| 120 |
$mapToSetting = [ |
| 121 |
'display_style' => '_give_display_style', |
| 122 |
'payment_display' => '_give_payment_display', |
| 123 |
'reveal_label' => '_give_reveal_label', |
| 124 |
'checkout_label' => '_give_checkout_label', |
| 125 |
'form_floating_labels' => '_give_form_floating_labels', |
| 126 |
'display_content' => '_give_display_content', |
| 127 |
'content_placement' => '_give_content_placement', |
| 128 |
'form_content' => '_give_form_content', |
| 129 |
]; |
| 130 |
|
| 131 |
foreach ( $mapToSetting as $newSetting => $oldSetting ) { |
| 132 |
if ( $value = Give()->form_meta->get_meta( $formId, $oldSetting, true ) ) { |
| 133 |
$settings['display_settings'][ $newSetting ] = $value; |
| 134 |
} |
| 135 |
} |
| 136 |
|
| 137 |
Give()->form_meta->update_meta( $formId, '_give_form_template', 'legacy' ); |
| 138 |
Give()->form_meta->update_meta( $formId, '_give_legacy_form_template_settings', $settings ); |
| 139 |
} |
| 140 |
} |
| 141 |
|
