Utils.php
246 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Helpers\Form; |
| 4 | |
| 5 | use Give\Controller\Form; |
| 6 | use Give\Helpers\Form\Template\Utils\Frontend; |
| 7 | use Give\Helpers\Utils as GlobalUtils; |
| 8 | |
| 9 | class Utils |
| 10 | { |
| 11 | /** |
| 12 | * Get result if we are viewing embed form or not |
| 13 | * |
| 14 | * @since 2.7.0 |
| 15 | * @return bool |
| 16 | */ |
| 17 | public static function isViewingForm() |
| 18 | { |
| 19 | $base = Give()->routeForm->getBase(); |
| 20 | |
| 21 | return ( |
| 22 | $base === get_query_var('url_prefix') || |
| 23 | (wp_doing_ajax() && false !== strpos(wp_get_referer(), "/{$base}/")) // for ajax |
| 24 | ); |
| 25 | } |
| 26 | |
| 27 | /** |
| 28 | * Get result if we are processing embed form or not |
| 29 | * |
| 30 | * @since 2.7.0 |
| 31 | * @return bool |
| 32 | */ |
| 33 | public static function isProcessingForm() |
| 34 | { |
| 35 | $base = Give()->routeForm->getBase(); |
| 36 | $formName = get_post_field('post_name', Frontend::getFormId()); |
| 37 | $referer = trailingslashit(wp_get_referer()) ?: ''; |
| 38 | |
| 39 | return ! empty($_REQUEST['give_embed_form']) || |
| 40 | false !== strpos($referer, "/{$base}/{$formName}/") || |
| 41 | self::inIframe() || |
| 42 | false !== strpos($referer, 'giveDonationFormInIframe'); |
| 43 | } |
| 44 | |
| 45 | /** |
| 46 | * Get result whether or not performing Give core action on ajax or not. |
| 47 | * |
| 48 | * @since 2.7.0 |
| 49 | * @return bool |
| 50 | */ |
| 51 | public static function isProcessingGiveActionOnAjax() |
| 52 | { |
| 53 | $action = isset($_REQUEST['action']) ? give_clean($_REQUEST['action']) : ''; |
| 54 | $whiteListedAction = ['get_receipt']; |
| 55 | |
| 56 | return $action && wp_doing_ajax() && (0 === strpos($action, 'give_') || in_array( |
| 57 | $action, |
| 58 | $whiteListedAction, |
| 59 | true |
| 60 | )); |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Get result whether or not show failed transaction error. |
| 65 | * |
| 66 | * @since 2.7.0 |
| 67 | * @return bool |
| 68 | */ |
| 69 | public static function canShowFailedDonationError() |
| 70 | { |
| 71 | return ! empty($_REQUEST['showFailedDonationError']); |
| 72 | } |
| 73 | |
| 74 | /** |
| 75 | * This function check whether or not given url is of iframe parent failed page. |
| 76 | * |
| 77 | * @since 2.7.0 |
| 78 | * |
| 79 | * @param string $url |
| 80 | * |
| 81 | * @return string |
| 82 | */ |
| 83 | public static function isIframeParentFailedPageURL($url) |
| 84 | { |
| 85 | $action = GlobalUtils::getQueryParamFromURL($url, 'giveDonationAction'); |
| 86 | |
| 87 | return $action && 'failedDonation' === $action; |
| 88 | } |
| 89 | |
| 90 | /** |
| 91 | * This function check whether or not given url is of iframe parent success page. |
| 92 | * |
| 93 | * @since 2.7.0 |
| 94 | * |
| 95 | * @param string $url |
| 96 | * |
| 97 | * @return string |
| 98 | */ |
| 99 | public static function isIframeParentSuccessPageURL($url) |
| 100 | { |
| 101 | $action = GlobalUtils::getQueryParamFromURL($url, 'giveDonationAction'); |
| 102 | |
| 103 | return $action && 'showReceipt' === $action; |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * This function will create success page URL. |
| 108 | * |
| 109 | * Note: this function is use to get success page url for parent page when perform donation with off-site checkout. |
| 110 | * |
| 111 | * @since 2.7.0 |
| 112 | * |
| 113 | * @param array $args |
| 114 | * @param string|null $url |
| 115 | * |
| 116 | * @return string |
| 117 | */ |
| 118 | public static function createSuccessPageURL($url, $args = []) |
| 119 | { |
| 120 | $args = array_merge($args, ['giveDonationAction' => 'showReceipt']); |
| 121 | |
| 122 | return add_query_arg( |
| 123 | $args, |
| 124 | $url |
| 125 | ); |
| 126 | } |
| 127 | |
| 128 | /** |
| 129 | * Get Iframe parent page URL. |
| 130 | * |
| 131 | * Note: must be use only inside iframe logic. |
| 132 | * |
| 133 | * @since 2.7.0 |
| 134 | */ |
| 135 | public static function getIframeParentURL() |
| 136 | { |
| 137 | return isset($_REQUEST['give-current-url']) ? give_clean($_REQUEST['give-current-url']) : ''; |
| 138 | } |
| 139 | |
| 140 | /** |
| 141 | * Return legacy failed page url. |
| 142 | * |
| 143 | * Wrapper function for give_get_failed_transaction_uri and without embed form filter |
| 144 | * |
| 145 | * @since 2.7.0 |
| 146 | * @return string |
| 147 | */ |
| 148 | public static function getLegacyFailedPageURL() |
| 149 | { |
| 150 | remove_filter('give_get_failed_transaction_uri', [Form::class, 'editFailedPageURI']); |
| 151 | $url = give_get_failed_transaction_uri(); |
| 152 | add_filter('give_get_failed_transaction_uri', [Form::class, 'editFailedPageURI']); |
| 153 | |
| 154 | return $url; |
| 155 | } |
| 156 | |
| 157 | /** |
| 158 | * Return success page url. |
| 159 | * |
| 160 | * Wrapper function for give_get_success_page_uri and without embed form filter. |
| 161 | * |
| 162 | * @since 2.7.0 |
| 163 | * @return string |
| 164 | */ |
| 165 | public static function getSuccessPageURL() |
| 166 | { |
| 167 | remove_filter('give_get_success_page_uri', [Form::class, 'editSuccessPageURI']); |
| 168 | $url = give_get_success_page_uri(); |
| 169 | add_filter('give_get_success_page_uri', [Form::class, 'editSuccessPageURI']); |
| 170 | |
| 171 | return $url; |
| 172 | } |
| 173 | |
| 174 | /** |
| 175 | * Get result if we are viewing embed form receipt or not |
| 176 | * |
| 177 | * @since 2.7.0 |
| 178 | * @return bool |
| 179 | */ |
| 180 | public static function isViewingFormReceipt() |
| 181 | { |
| 182 | return give_is_success_page(); |
| 183 | } |
| 184 | |
| 185 | /** |
| 186 | * This function will create failed transaction page URL. |
| 187 | * |
| 188 | * Note: this function is use to get failed page url for parent page when perform donation with off-site checkout. |
| 189 | * |
| 190 | * @since 2.7.0 |
| 191 | * |
| 192 | * @param array $args |
| 193 | * @param string|null $url |
| 194 | * |
| 195 | * @return string |
| 196 | */ |
| 197 | public static function createFailedPageURL($url, $args = []) |
| 198 | { |
| 199 | $args = array_merge($args, ['giveDonationAction' => 'failedDonation']); |
| 200 | |
| 201 | return add_query_arg( |
| 202 | $args, |
| 203 | $url |
| 204 | ); |
| 205 | } |
| 206 | |
| 207 | /** |
| 208 | * Return if current URL loading in iframe or not. |
| 209 | * |
| 210 | * @since 2.7.0 |
| 211 | * @return bool |
| 212 | */ |
| 213 | public static function inIframe() |
| 214 | { |
| 215 | return ! empty($_GET['giveDonationFormInIframe']); |
| 216 | } |
| 217 | |
| 218 | /** |
| 219 | * Returns whether or not the given form uses the legacy form template |
| 220 | * |
| 221 | * @since 2.7.0 |
| 222 | * |
| 223 | * @param int|null $formID |
| 224 | * |
| 225 | * @return bool |
| 226 | */ |
| 227 | public static function isLegacyForm($formID = null) |
| 228 | { |
| 229 | $formID = $formID ?: Frontend::getFormId(); |
| 230 | $formTemplate = Template::getActiveID($formID); |
| 231 | |
| 232 | return ! $formTemplate || 'legacy' === Template::getActiveID($formID); |
| 233 | } |
| 234 | |
| 235 | /** |
| 236 | * Return whether or not disable donate now button. |
| 237 | * |
| 238 | * @since 2.7.0 |
| 239 | * @return bool |
| 240 | */ |
| 241 | public static function canDisableDonationNowButton() |
| 242 | { |
| 243 | return ! empty($_GET['giveDisableDonateNowButton']); |
| 244 | } |
| 245 | } |
| 246 |