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