FormBuilderViewModel.php
414 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\FormBuilder\ViewModels; |
| 4 | |
| 5 | use Give\Campaigns\Models\Campaign; |
| 6 | use Give\DonationForms\Actions\GenerateDonationFormPreviewRouteUrl; |
| 7 | use Give\DonationForms\Models\DonationForm; |
| 8 | use Give\DonationForms\ValueObjects\GoalProgressType; |
| 9 | use Give\DonationForms\ValueObjects\GoalSource; |
| 10 | use Give\DonationForms\ValueObjects\GoalType; |
| 11 | use Give\Donations\Models\Donation; |
| 12 | use Give\Donations\ValueObjects\DonationMetaKeys; |
| 13 | use Give\Donors\Models\Donor; |
| 14 | use Give\Donors\ValueObjects\DonorMetaKeys; |
| 15 | use Give\FormBuilder\DataTransferObjects\EmailNotificationData; |
| 16 | use Give\FormBuilder\ValueObjects\FormBuilderRestRouteConfig; |
| 17 | use Give\Framework\FormDesigns\FormDesign; |
| 18 | use Give\Framework\FormDesigns\Registrars\FormDesignRegistrar; |
| 19 | use Give\Framework\PaymentGateways\PaymentGateway; |
| 20 | use Give\Framework\Support\Facades\Scripts\ScriptAsset; |
| 21 | use Give\Helpers\IntlTelInput; |
| 22 | use Give\Subscriptions\Models\Subscription; |
| 23 | use Give_License; |
| 24 | |
| 25 | class FormBuilderViewModel |
| 26 | { |
| 27 | /** |
| 28 | * @since 3.12.0 Add goalProgressOptions key to the returned array |
| 29 | * @since 3.9.0 Add support to intlTelInputSettings key in the returned array |
| 30 | * @since 3.7.0 Add support to isExcerptEnabled key in the returned array |
| 31 | * @since 3.2.0 Add nameTitlePrefixes key to the returned array |
| 32 | * @since 3.0.0 |
| 33 | */ |
| 34 | public function storageData(int $donationFormId): array |
| 35 | { |
| 36 | /** @var DonationForm $donationForm */ |
| 37 | $donationForm = DonationForm::find($donationFormId); |
| 38 | |
| 39 | return [ |
| 40 | 'formId' => $donationFormId, |
| 41 | 'resourceURL' => rest_url(FormBuilderRestRouteConfig::NAMESPACE . '/form/' . $donationFormId), |
| 42 | 'previewURL' => (new GenerateDonationFormPreviewRouteUrl())($donationFormId), |
| 43 | 'nonce' => wp_create_nonce('wp_rest'), |
| 44 | 'blockData' => $donationForm->blocks->toJson(), |
| 45 | 'settings' => $donationForm->settings->toJson(), |
| 46 | 'currency' => give_get_currency(), |
| 47 | 'formDesigns' => array_map(static function ($designClass) { |
| 48 | /** @var FormDesign $design */ |
| 49 | $design = give($designClass); |
| 50 | |
| 51 | return [ |
| 52 | 'id' => $design::id(), |
| 53 | 'name' => $design::name(), |
| 54 | 'isMultiStep' => $design->isMultiStep(), |
| 55 | ]; |
| 56 | }, give(FormDesignRegistrar::class)->getDesigns()), |
| 57 | 'formPage' => [ |
| 58 | 'isEnabled' => give_is_setting_enabled(give_get_option('forms_singular')), |
| 59 | // Note: Boolean values must be nested in an array to maintain boolean type, see \WP_Scripts::localize(). |
| 60 | 'permalink' => add_query_arg(['p' => $donationFormId], site_url('?post_type=give_forms')), |
| 61 | 'rewriteSlug' => get_post_type_object('give_forms')->rewrite['slug'], |
| 62 | 'baseUrl' => preg_replace('/^https?:\/\//', '', site_url()), |
| 63 | ], |
| 64 | 'gateways' => $this->getGateways(), |
| 65 | 'gatewaySettingsUrl' => admin_url('edit.php?post_type=give_forms&page=give-settings&tab=gateways'), |
| 66 | 'isRecurringEnabled' => defined('GIVE_RECURRING_VERSION') ? GIVE_RECURRING_VERSION : null, |
| 67 | 'recurringAddonData' => [ |
| 68 | 'isInstalled' => defined('GIVE_RECURRING_VERSION'), |
| 69 | ], |
| 70 | 'formFieldManagerData' => [ |
| 71 | 'isInstalled' => defined('GIVE_FFM_VERSION'), |
| 72 | 'isLicensed' => (Give_License::get_license_by_plugin_dirname('give-form-field-manager')['license'] ?? '') === 'valid', |
| 73 | ], |
| 74 | 'emailTemplateTags' => $this->getEmailTemplateTags(), |
| 75 | 'emailNotifications' => array_map(static function ($notification) { |
| 76 | return EmailNotificationData::fromLegacyNotification($notification); |
| 77 | }, apply_filters('give_email_notification_options_metabox_fields', [], $donationFormId)), |
| 78 | 'emailPreviewURL' => rest_url('givewp/form-builder/email-preview'), |
| 79 | 'emailDefaultAddress' => get_option('admin_email'), |
| 80 | 'disallowedFieldNames' => $this->getDisallowedFieldNames(), |
| 81 | 'donationConfirmationTemplateTags' => $this->getDonationConfirmationPageTemplateTags(), |
| 82 | 'termsAndConditions' => [ |
| 83 | 'checkboxLabel' => give_get_option('agree_to_terms_label'), |
| 84 | 'agreementText' => give_get_option('agreement_text'), |
| 85 | ], |
| 86 | 'goalTypeOptions' => $this->getGoalTypeOptions(), |
| 87 | 'goalSourceOptions' => $this->getGoalSourceOptions(), |
| 88 | 'goalProgressOptions' => $this->getGoalProgressOptions(), |
| 89 | 'nameTitlePrefixes' => give_get_option('title_prefixes', array_values(give_get_default_title_prefixes())), |
| 90 | 'isExcerptEnabled' => give_is_setting_enabled(give_get_option('forms_excerpt')), |
| 91 | 'intlTelInputSettings' => IntlTelInput::getSettings(), |
| 92 | 'campaignColors' => $this->getCampaignColors($donationFormId), |
| 93 | 'showFormGoalNotice' => !get_user_meta(get_current_user_id(), 'givewp_campaign_form_goal_notice', true), |
| 94 | ]; |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * @since 3.0.0 |
| 99 | */ |
| 100 | public function isRecurringEnabled(): bool |
| 101 | { |
| 102 | return defined('GIVE_RECURRING_VERSION') && GIVE_RECURRING_VERSION; |
| 103 | } |
| 104 | |
| 105 | /** |
| 106 | * @since 3.0.0 |
| 107 | */ |
| 108 | public function getGoalTypeOption( |
| 109 | string $value, |
| 110 | string $label, |
| 111 | string $description, |
| 112 | bool $isCurrency = false |
| 113 | ): array |
| 114 | { |
| 115 | return [ |
| 116 | 'value' => $value, |
| 117 | 'label' => $label, |
| 118 | 'description' => $description, |
| 119 | 'isCurrency' => $isCurrency, |
| 120 | ]; |
| 121 | } |
| 122 | |
| 123 | |
| 124 | /** |
| 125 | * @since 4.1.0 |
| 126 | */ |
| 127 | public function getGoalSourceOption( |
| 128 | string $value, |
| 129 | string $label, |
| 130 | string $description |
| 131 | ): array |
| 132 | { |
| 133 | return [ |
| 134 | 'value' => $value, |
| 135 | 'label' => $label, |
| 136 | 'description' => $description, |
| 137 | ]; |
| 138 | } |
| 139 | |
| 140 | |
| 141 | /** |
| 142 | * @since 3.12.0 |
| 143 | */ |
| 144 | public function getGoalProgressOption( |
| 145 | string $value, |
| 146 | string $label, |
| 147 | string $description |
| 148 | ): array |
| 149 | { |
| 150 | return [ |
| 151 | 'value' => $value, |
| 152 | 'label' => $label, |
| 153 | 'description' => $description |
| 154 | ]; |
| 155 | } |
| 156 | |
| 157 | |
| 158 | /** |
| 159 | * @since 3.0.0 |
| 160 | */ |
| 161 | public function getGoalTypeOptions(): array |
| 162 | { |
| 163 | $options = [ |
| 164 | $this->getGoalTypeOption( |
| 165 | GoalType::AMOUNT, |
| 166 | __('Amount Raised', 'give'), |
| 167 | __('The total amount raised for the form', 'give'), |
| 168 | true |
| 169 | ), |
| 170 | $this->getGoalTypeOption( |
| 171 | GoalType::DONATIONS, |
| 172 | __('Number of Donations', 'give'), |
| 173 | __('The total number of donations made for the form', 'give') |
| 174 | ), |
| 175 | $this->getGoalTypeOption( |
| 176 | GoalType::DONORS, |
| 177 | __('Number of Donors', 'give'), |
| 178 | __('The total number of unique donors who have donated to the form', 'give') |
| 179 | ), |
| 180 | ]; |
| 181 | |
| 182 | if ($this->isRecurringEnabled()) { |
| 183 | return array_merge($options, [ |
| 184 | $this->getGoalTypeOption( |
| 185 | GoalType::AMOUNT_FROM_SUBSCRIPTIONS, |
| 186 | __('Subscription Amount Raised', 'give'), |
| 187 | __('The total amount raised for the form through subscriptions', 'give'), |
| 188 | true |
| 189 | ), |
| 190 | $this->getGoalTypeOption( |
| 191 | GoalType::SUBSCRIPTIONS, |
| 192 | __('Number of Subscriptions', 'give'), |
| 193 | __('The total number of subscriptions made for the form', 'give') |
| 194 | ), |
| 195 | $this->getGoalTypeOption( |
| 196 | GoalType::DONORS_FROM_SUBSCRIPTIONS, |
| 197 | __('Number of Subscribers', 'give'), |
| 198 | __('The total number of unique donors who have donated to the form through subscriptions', 'give') |
| 199 | ), |
| 200 | ]); |
| 201 | } |
| 202 | |
| 203 | return $options; |
| 204 | } |
| 205 | |
| 206 | /** |
| 207 | * @since 4.1.0 |
| 208 | */ |
| 209 | public function getGoalSourceOptions(): array |
| 210 | { |
| 211 | return [ |
| 212 | $this->getGoalTypeOption( |
| 213 | GoalSource::CAMPAIGN, |
| 214 | __('Campaign', 'give'), |
| 215 | __('The goal for this form will automatically adjust according to the campaign goal. Change campaign goal.', 'give') |
| 216 | ), |
| 217 | $this->getGoalTypeOption( |
| 218 | GoalSource::FORM, |
| 219 | __('Custom', 'give'), |
| 220 | __('Set the custom goal for this form', 'give') |
| 221 | ), |
| 222 | ]; |
| 223 | } |
| 224 | |
| 225 | /** |
| 226 | * @since 3.12.0 |
| 227 | */ |
| 228 | public function getGoalProgressOptions(): array |
| 229 | { |
| 230 | return [ |
| 231 | $this->getGoalProgressOption( |
| 232 | GoalProgressType::ALL_TIME, |
| 233 | __('All time', 'give'), |
| 234 | __('Displays the goal progress for a lifetime, starting from when this form was published.', 'give') |
| 235 | ), |
| 236 | $this->getGoalProgressOption( |
| 237 | GoalProgressType::CUSTOM, |
| 238 | __('Custom', 'give'), |
| 239 | __('Displays the goal progress from the start date to the end date.', 'give') |
| 240 | ) |
| 241 | ]; |
| 242 | } |
| 243 | |
| 244 | /** |
| 245 | * @since 3.0.0 |
| 246 | */ |
| 247 | public function getEmailTemplateTags(array $tags = []): array |
| 248 | { |
| 249 | return array_map(static function ($tag) { |
| 250 | $tag['id'] = $tag['tag']; |
| 251 | $tag['desc'] = html_entity_decode($tag['desc'], ENT_QUOTES); |
| 252 | $tag['description'] = html_entity_decode($tag['description'], ENT_QUOTES); |
| 253 | |
| 254 | return $tag; |
| 255 | }, array_merge($tags, array_values(give()->email_tags->get_tags()))); |
| 256 | } |
| 257 | |
| 258 | /** |
| 259 | * @since 3.0.0 |
| 260 | */ |
| 261 | public function getDonationConfirmationPageTemplateTags(): array |
| 262 | { |
| 263 | $templateTags = $this->getEmailTemplateTags([ |
| 264 | [ |
| 265 | 'tag' => 'first_name', |
| 266 | 'desc' => __('The first name supplied by the donor during their donation.', 'give'), |
| 267 | 'description' => __('The first name supplied by the donor during their donation.', 'give'), |
| 268 | 'func' => null, |
| 269 | "context" => 'donation', |
| 270 | ], |
| 271 | [ |
| 272 | 'tag' => 'last_name', |
| 273 | 'desc' => __('The last name supplied by the donor during their donation.', 'give'), |
| 274 | 'description' => __('The last name supplied by the donor during their donation.', 'give'), |
| 275 | 'func' => null, |
| 276 | "context" => 'donation', |
| 277 | ], |
| 278 | [ |
| 279 | 'tag' => 'email', |
| 280 | 'desc' => __('The email supplied by the donor during their donation.', 'give'), |
| 281 | 'description' => __('The email supplied by the donor during their donation.', 'give'), |
| 282 | 'func' => null, |
| 283 | "context" => 'donation', |
| 284 | ], |
| 285 | ]); |
| 286 | |
| 287 | $supportedContexts = [ |
| 288 | "general", |
| 289 | "form", |
| 290 | "donation", |
| 291 | "donor", |
| 292 | "subscription", |
| 293 | ]; |
| 294 | |
| 295 | array_multisort($templateTags, SORT_ASC); |
| 296 | |
| 297 | return array_values( |
| 298 | array_filter($templateTags, static function ($tag) use ($supportedContexts) { |
| 299 | return !empty($tag['description']) && in_array((string)$tag['context'], $supportedContexts, true); |
| 300 | }) |
| 301 | ); |
| 302 | } |
| 303 | |
| 304 | /** |
| 305 | * @since 3.0.0 |
| 306 | */ |
| 307 | public function jsPathFromPluginRoot(): string |
| 308 | { |
| 309 | return GIVE_PLUGIN_URL . 'build/formBuilderApp.js'; |
| 310 | } |
| 311 | |
| 312 | /** |
| 313 | * @since 3.0.0 |
| 314 | */ |
| 315 | public function jsPathToRegistrars(): string |
| 316 | { |
| 317 | return GIVE_PLUGIN_URL . 'build/formBuilderRegistrars.js'; |
| 318 | } |
| 319 | |
| 320 | /** |
| 321 | * @since 3.0.0 |
| 322 | */ |
| 323 | public function jsRegistrarsDependencies(): array |
| 324 | { |
| 325 | return ScriptAsset::getDependencies(GIVE_PLUGIN_DIR . 'build/formBuilderRegistrars.asset.php'); |
| 326 | } |
| 327 | |
| 328 | /** |
| 329 | * @since 3.0.0 |
| 330 | */ |
| 331 | public function jsDependencies(): array |
| 332 | { |
| 333 | $dependencies = ScriptAsset::getDependencies(GIVE_PLUGIN_DIR . 'build/formBuilderApp.asset.php'); |
| 334 | |
| 335 | return array_merge($dependencies, ['@givewp/form-builder/registrars']); |
| 336 | } |
| 337 | |
| 338 | /** |
| 339 | * @since 3.0.0 |
| 340 | */ |
| 341 | public function getGateways(): array |
| 342 | { |
| 343 | $enabledGateways = array_keys(give_get_option('gateways_v3', [])); |
| 344 | |
| 345 | $builderPaymentGatewayData = array_map(static function ($gatewayClass) use ($enabledGateways) { |
| 346 | /** @var PaymentGateway $gateway */ |
| 347 | $gateway = give($gatewayClass); |
| 348 | |
| 349 | return [ |
| 350 | 'id' => $gateway::id(), |
| 351 | 'enabled' => in_array($gateway::id(), $enabledGateways, true), |
| 352 | 'label' => give_get_gateway_checkout_label($gateway::id(), 3) ?? $gateway->getPaymentMethodLabel(), |
| 353 | 'supportsSubscriptions' => $gateway->supportsSubscriptions(), |
| 354 | ]; |
| 355 | }, give()->gateways->getPaymentGateways(3)); |
| 356 | |
| 357 | return array_values($builderPaymentGatewayData); |
| 358 | } |
| 359 | |
| 360 | /** |
| 361 | * In the Form Builder custom fields have meta keys. These meta keys are used for both the field name and the meta, |
| 362 | * as not to be too confusing. This array is used to prevent the user from creating meta keys that conflict with the |
| 363 | * existing meta or field names. |
| 364 | * |
| 365 | * @since 4.3.2 Add country, state, city, zip, address1, and address2 to the disallowed field names. |
| 366 | * @since 3.0.0 |
| 367 | */ |
| 368 | protected function getDisallowedFieldNames(): array |
| 369 | { |
| 370 | $disallowedFieldNames = array_merge( |
| 371 | Donation::propertyKeys(), |
| 372 | array_values(DonationMetaKeys::toArray()), |
| 373 | Donor::propertyKeys(), |
| 374 | array_values(DonorMetaKeys::toArray()), |
| 375 | Subscription::propertyKeys(), |
| 376 | [ |
| 377 | 'fund_id', |
| 378 | 'login', |
| 379 | 'consent', |
| 380 | 'donation-summary', |
| 381 | 'country', |
| 382 | 'state', |
| 383 | 'city', |
| 384 | 'zip', |
| 385 | 'address1', |
| 386 | 'address2', |
| 387 | ] |
| 388 | ); |
| 389 | |
| 390 | return array_values(array_unique($disallowedFieldNames)); |
| 391 | } |
| 392 | |
| 393 | /** |
| 394 | * @since 4.1.0 |
| 395 | */ |
| 396 | private function getCampaignColors(int $formId): array |
| 397 | { |
| 398 | /** @var Campaign $campaign */ |
| 399 | $campaign = give()->campaigns->getByFormId($formId); |
| 400 | |
| 401 | if ($campaign) { |
| 402 | return [ |
| 403 | 'primaryColor' => $campaign->primaryColor, |
| 404 | 'secondaryColor' => $campaign->secondaryColor, |
| 405 | ]; |
| 406 | } |
| 407 | |
| 408 | return [ |
| 409 | 'primaryColor' => '', |
| 410 | 'secondaryColor' => '', |
| 411 | ]; |
| 412 | } |
| 413 | } |
| 414 |