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