BlockRenderController.php
144 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\DonationForms\Blocks\DonationFormBlock\Controllers; |
| 4 | |
| 5 | use Give\DonationForms\Actions\GenerateDonationConfirmationReceiptViewRouteUrl; |
| 6 | use Give\DonationForms\Actions\GenerateDonationFormViewRouteUrl; |
| 7 | use Give\DonationForms\Blocks\DonationFormBlock\DataTransferObjects\BlockAttributes; |
| 8 | use Give\DonationForms\DataTransferObjects\DonationConfirmationReceiptViewRouteData; |
| 9 | use Give\DonationForms\Models\DonationForm; |
| 10 | use Give\Framework\EnqueueScript; |
| 11 | use Give\Framework\Routes\RouteListener; |
| 12 | use Give\Helpers\Language; |
| 13 | |
| 14 | class BlockRenderController |
| 15 | { |
| 16 | /** |
| 17 | * @since 4.1.0 |
| 18 | */ |
| 19 | protected static int $embedInstance = 0; |
| 20 | |
| 21 | /** |
| 22 | * @since 4.7.0 detach check for gutenberg editor to make this more reusable |
| 23 | * @since 4.1.0 updated with embed ID instance fallback when block ID is not set. |
| 24 | * @since 3.22.0 Add locale support |
| 25 | * @since 3.2.0 include form url for new tab format. |
| 26 | * @since 3.0.0 |
| 27 | * |
| 28 | * @return string|null |
| 29 | */ |
| 30 | public function render(array $attributes) |
| 31 | { |
| 32 | static::$embedInstance++; |
| 33 | |
| 34 | $blockAttributes = BlockAttributes::fromArray($attributes); |
| 35 | |
| 36 | if (!$blockAttributes->formId) { |
| 37 | return null; |
| 38 | } |
| 39 | |
| 40 | $this->loadEmbedScript(); |
| 41 | |
| 42 | /** @var DonationForm $donationForm */ |
| 43 | $donationForm = DonationForm::find($blockAttributes->formId); |
| 44 | |
| 45 | $embedId = $blockAttributes->blockId ?? 'givewp-embed-' . static::$embedInstance; |
| 46 | |
| 47 | $locale = Language::getLocale(); |
| 48 | $viewUrl = $this->getViewUrl($donationForm, $embedId); |
| 49 | $formUrl = esc_url(add_query_arg(['p' => $blockAttributes->formId], site_url('?post_type=give_forms'))); |
| 50 | $formViewUrl = $this->getFormViewUrl($donationForm); |
| 51 | $colorSettings = $donationForm->getColorSettings(); |
| 52 | |
| 53 | /** |
| 54 | * Note: iframe-resizer uses querySelectorAll so using a data attribute makes the most sense to target. |
| 55 | * It will also generate a dynamic ID - so when we have multiple embeds on a page there will be no conflict. |
| 56 | */ |
| 57 | return "<div class='root-data-givewp-embed' data-form-locale='$locale' data-form-url='$formUrl' data-form-view-url='$formViewUrl' data-src='$viewUrl' data-givewp-embed-id='$embedId' data-form-format='$blockAttributes->formFormat' data-open-form-button='$blockAttributes->openFormButton' style='--givewp-primary-color: {$colorSettings['primaryColor']}; --givewp-secondary-color: {$colorSettings['secondaryColor']};'></div>"; |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * Return early if we're still inside the editor to avoid server side effects |
| 62 | * |
| 63 | * @since 4.7.0 |
| 64 | * |
| 65 | * @return boolean |
| 66 | */ |
| 67 | public function isGutenbergEditor(): bool |
| 68 | { |
| 69 | return !empty($_REQUEST['post']) || !empty($_REQUEST['action']) || !empty($_REQUEST['_locale']); |
| 70 | } |
| 71 | |
| 72 | /** |
| 73 | * If the page loads with our receipt route listener args then we need to render the receipt. |
| 74 | * |
| 75 | * @since 3.0.0 |
| 76 | */ |
| 77 | protected function shouldDisplayDonationConfirmationReceipt(string $embedId): bool |
| 78 | { |
| 79 | $routeListener = new RouteListener( |
| 80 | 'donation-completed', |
| 81 | 'show-donation-confirmation-receipt' |
| 82 | ); |
| 83 | |
| 84 | return $routeListener->isValid($_GET, function ($request) use ($embedId) { |
| 85 | $isset = isset($request['givewp-embed-id'], $request['givewp-receipt-id']); |
| 86 | |
| 87 | return $isset && $request['givewp-embed-id'] === $embedId && DonationConfirmationReceiptViewRouteData::isReceiptIdValid( |
| 88 | $request['givewp-receipt-id'] |
| 89 | ); |
| 90 | }); |
| 91 | } |
| 92 | |
| 93 | /** |
| 94 | * Get the iframe URL. |
| 95 | * This could either be the donation form view or the donation confirmation receipt view. |
| 96 | * |
| 97 | * @since 3.0.0 |
| 98 | */ |
| 99 | private function getViewUrl(DonationForm $donationForm, string $embedId): string |
| 100 | { |
| 101 | if ($this->shouldDisplayDonationConfirmationReceipt($embedId)) { |
| 102 | $receiptId = give_clean($_GET['givewp-receipt-id']); |
| 103 | |
| 104 | return (new GenerateDonationConfirmationReceiptViewRouteUrl())($receiptId); |
| 105 | } |
| 106 | |
| 107 | return $this->getFormViewUrl($donationForm); |
| 108 | } |
| 109 | |
| 110 | /** |
| 111 | * @since 3.4.0 |
| 112 | */ |
| 113 | private function getFormViewUrl(DonationForm $donationForm): string |
| 114 | { |
| 115 | return (new GenerateDonationFormViewRouteUrl())($donationForm->id); |
| 116 | } |
| 117 | |
| 118 | /** |
| 119 | * |
| 120 | * Load embed givewp script to resize iframe |
| 121 | * @see https://github.com/davidjbradshaw/iframe-resizer |
| 122 | * |
| 123 | * @since 3.0.0 |
| 124 | */ |
| 125 | protected function loadEmbedScript() |
| 126 | { |
| 127 | (new EnqueueScript( |
| 128 | 'givewp-donation-form-embed-app', |
| 129 | 'build/donationFormBlockApp.js', |
| 130 | GIVE_PLUGIN_DIR, |
| 131 | GIVE_PLUGIN_URL, |
| 132 | 'give' |
| 133 | )) |
| 134 | ->dependencies(['jquery']) |
| 135 | ->loadInFooter() |
| 136 | ->enqueue(); |
| 137 | |
| 138 | wp_enqueue_style( |
| 139 | 'givewp-donation-form-embed-app', |
| 140 | GIVE_PLUGIN_URL . 'build/donationFormBlockApp.css' |
| 141 | ); |
| 142 | } |
| 143 | } |
| 144 |