Form.php
197 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Handle Embed Donation Form Route |
| 5 | * |
| 6 | * @package Give |
| 7 | * @since 2.7.0 |
| 8 | */ |
| 9 | |
| 10 | namespace Give\Route; |
| 11 | |
| 12 | use Give\Controller\Form as Controller; |
| 13 | use WP_Post; |
| 14 | |
| 15 | defined( 'ABSPATH' ) || exit; |
| 16 | |
| 17 | /** |
| 18 | * Template class. |
| 19 | * |
| 20 | * @since 2.7.0 |
| 21 | */ |
| 22 | class Form { |
| 23 | /** |
| 24 | * Option name |
| 25 | * |
| 26 | * @since 2.7.0 |
| 27 | * @var string |
| 28 | */ |
| 29 | private $optionName = 'form_page_url_prefix'; |
| 30 | |
| 31 | /** |
| 32 | * Route base |
| 33 | * |
| 34 | * @since 2.7.0 |
| 35 | * @var string |
| 36 | */ |
| 37 | private $defaultBase = 'give'; |
| 38 | |
| 39 | /** |
| 40 | * Route base |
| 41 | * |
| 42 | * @since 2.7.0 |
| 43 | * @var string |
| 44 | */ |
| 45 | private $base; |
| 46 | |
| 47 | /** |
| 48 | * Form constructor. |
| 49 | * |
| 50 | * @param Controller $controller |
| 51 | */ |
| 52 | public function init( $controller ) { |
| 53 | $this->setBasePrefix(); |
| 54 | $controller->init(); |
| 55 | |
| 56 | add_action( 'init', [ $this, 'addRule' ] ); |
| 57 | add_action( 'query_vars', [ $this, 'addQueryVar' ] ); |
| 58 | add_action( 'give-settings_save_advanced', [ $this, 'updateRule' ], 11 ); |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Setup base prefix |
| 63 | * |
| 64 | * @since 2.7.0 |
| 65 | */ |
| 66 | public function setBasePrefix() { |
| 67 | $this->base = give_get_option( $this->optionName, $this->defaultBase ); |
| 68 | } |
| 69 | |
| 70 | |
| 71 | /** |
| 72 | * Add rewrite rule |
| 73 | * |
| 74 | * @since 2.7.0 |
| 75 | */ |
| 76 | public function addRule() { |
| 77 | add_rewrite_rule( |
| 78 | "{$this->base}/(.+?)/?$", |
| 79 | sprintf( |
| 80 | 'index.php?url_prefix=%1$s&give_form_id=$matches[1]', |
| 81 | $this->base |
| 82 | ), |
| 83 | 'top' |
| 84 | ); |
| 85 | } |
| 86 | |
| 87 | |
| 88 | /** |
| 89 | * Add query var |
| 90 | * |
| 91 | * @since 2.7.0 |
| 92 | * @param array $queryVars |
| 93 | * |
| 94 | * @return array |
| 95 | */ |
| 96 | public function addQueryVar( $queryVars ) { |
| 97 | $queryVars[] = 'give_form_id'; |
| 98 | $queryVars[] = 'url_prefix'; |
| 99 | |
| 100 | return $queryVars; |
| 101 | } |
| 102 | |
| 103 | /** |
| 104 | * Get form URL. |
| 105 | * |
| 106 | * @since 2.7.0 |
| 107 | * @since 2.8.0 Add support for all permalink settings. |
| 108 | * @since 2.8.0 Specify URL scheme to avoid mixed content when loaded in the admin. |
| 109 | * |
| 110 | * @param int $form_id |
| 111 | * |
| 112 | * @return string |
| 113 | */ |
| 114 | public function getURL( $form_id ) { |
| 115 | $scheme = ( is_ssl() ) ? 'https' : 'http'; |
| 116 | return get_option( 'permalink_structure' ) |
| 117 | ? home_url( "/{$this->base}/{$form_id}", $scheme ) |
| 118 | : add_query_arg( |
| 119 | [ |
| 120 | 'give_form_id' => $form_id, |
| 121 | 'url_prefix' => $this->base, |
| 122 | ], |
| 123 | home_url( '', $scheme ) |
| 124 | ); |
| 125 | } |
| 126 | |
| 127 | |
| 128 | /** |
| 129 | * Get url base. |
| 130 | * |
| 131 | * @since 2.7.0 |
| 132 | * @return string |
| 133 | */ |
| 134 | public function getBase() { |
| 135 | return $this->base; |
| 136 | } |
| 137 | |
| 138 | /** |
| 139 | * Get url base. |
| 140 | * |
| 141 | * @since 2.7.0 |
| 142 | * @return string |
| 143 | */ |
| 144 | public function getOptionName() { |
| 145 | return $this->optionName; |
| 146 | } |
| 147 | |
| 148 | |
| 149 | /** |
| 150 | * Update route rule |
| 151 | * |
| 152 | * @since 2.7.0 |
| 153 | */ |
| 154 | public function updateRule() { |
| 155 | global $wp_rewrite; |
| 156 | |
| 157 | $updateBase = give_get_option( $this->optionName, $this->defaultBase ); |
| 158 | |
| 159 | if ( $updateBase !== $this->base ) { |
| 160 | $this->base = $updateBase; |
| 161 | |
| 162 | // Save rewrite rule manually. |
| 163 | $this->addRule(); |
| 164 | flush_rewrite_rules(); |
| 165 | $wp_rewrite->wp_rewrite_rules(); |
| 166 | } |
| 167 | } |
| 168 | |
| 169 | /** |
| 170 | * Get queried form ID. |
| 171 | * |
| 172 | * @since 2.7.0 |
| 173 | * @return int |
| 174 | */ |
| 175 | public function getQueriedFormID() { |
| 176 | $formId = 0; |
| 177 | |
| 178 | if ( $queryVar = get_query_var( 'give_form_id' ) ) { |
| 179 | $form = current( |
| 180 | get_posts( |
| 181 | [ |
| 182 | 'name' => $queryVar, |
| 183 | 'numberposts' => 1, |
| 184 | 'post_type' => 'give_forms', |
| 185 | ] |
| 186 | ) |
| 187 | ); |
| 188 | |
| 189 | if ( $form instanceof WP_Post ) { |
| 190 | $formId = $form->ID; |
| 191 | } |
| 192 | } |
| 193 | |
| 194 | return $formId; |
| 195 | } |
| 196 | } |
| 197 |