Template
6 years ago
LoadTemplate.php
6 years ago
Template.php
6 years ago
Templates.php
6 years ago
Template.php
314 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Handle basic setup of form template |
| 5 | * |
| 6 | * @package Give |
| 7 | * @since 2.7.0 |
| 8 | */ |
| 9 | |
| 10 | namespace Give\Form; |
| 11 | |
| 12 | use Give\Form\Template\Options; |
| 13 | use Give\Helpers\Form\Template as FormTemplateUtils; |
| 14 | use Give\Helpers\Form\Utils as FormUtils; |
| 15 | use Give\Receipt\DonationReceipt; |
| 16 | |
| 17 | defined( 'ABSPATH' ) || exit; |
| 18 | |
| 19 | /** |
| 20 | * Template class. |
| 21 | * |
| 22 | * @since 2.7.0 |
| 23 | */ |
| 24 | abstract class Template { |
| 25 | /** |
| 26 | * Flag to check whether or not open success page in iframe. |
| 27 | * |
| 28 | * @var bool $openSuccessPageInIframe If set to false then success page will open in window instead of iframe. |
| 29 | */ |
| 30 | public $openSuccessPageInIframe = true; |
| 31 | |
| 32 | /** |
| 33 | * Flag to check whether or not open failed page in iframe. |
| 34 | * |
| 35 | * @var bool $openFailedPageInIframe If set to false then failed page will open in window instead of iframe. |
| 36 | */ |
| 37 | public $openFailedPageInIframe = true; |
| 38 | |
| 39 | /** |
| 40 | * Determines how the form is rendered to the page. |
| 41 | * |
| 42 | * Acceptable values: |
| 43 | * - button (show a button that displays the form when clicked) |
| 44 | * - onpage (render the form right on the page) |
| 45 | * |
| 46 | * @var string |
| 47 | */ |
| 48 | public $donationFormStyle = 'button'; |
| 49 | |
| 50 | /** |
| 51 | * Determines how the form amount choices are rendered to the page. |
| 52 | * |
| 53 | * Acceptable values: |
| 54 | * - buttons (render donation amount choices as button ) |
| 55 | * - radio (render donation amount choices as radio ) |
| 56 | * - dropdown (render donation amount choices in dropdown (select) ) |
| 57 | * |
| 58 | * @var string |
| 59 | */ |
| 60 | public $donationFormLevelsStyle = 'buttons'; |
| 61 | |
| 62 | /** |
| 63 | * Determines how the form field labels render on the page. |
| 64 | * |
| 65 | * Acceptable values: |
| 66 | * - true (render with floating label style) |
| 67 | * - false (render as is) |
| 68 | * |
| 69 | * @var bool |
| 70 | */ |
| 71 | public $floatingLabelsStyle = false; |
| 72 | |
| 73 | /** |
| 74 | * Determines whether or not render form content on page. |
| 75 | * |
| 76 | * Acceptable values: |
| 77 | * - true (render form content on page ) |
| 78 | * - false (do not render form content on page) |
| 79 | * |
| 80 | * @var bool |
| 81 | */ |
| 82 | public $showDonationIntroductionContent = false; |
| 83 | |
| 84 | /** |
| 85 | * Get starting form height |
| 86 | * |
| 87 | * Returns starting height for iframe (in pixels), this is used to predict iframe height before the iframe loads |
| 88 | * Implemented in includes/shortcodes.php: |
| 89 | * |
| 90 | * @param int $formId Form ID |
| 91 | * |
| 92 | * @return int |
| 93 | **/ |
| 94 | public function getFormStartingHeight( $formId ) { |
| 95 | return 600; |
| 96 | } |
| 97 | |
| 98 | /** |
| 99 | * Get form receipt height |
| 100 | * |
| 101 | * Returns receipt height for iframe (in pixels), this is used to predict iframe height before the iframe loads |
| 102 | * Implemented in includes/shortcodes.php: |
| 103 | * Implemented in form donation processing view |
| 104 | * |
| 105 | * @return int |
| 106 | **/ |
| 107 | public function getFormReceiptHeight() { |
| 108 | return 977; |
| 109 | } |
| 110 | |
| 111 | /** |
| 112 | * Get loading view filepath |
| 113 | * |
| 114 | * @return string |
| 115 | * @since 2.7.0 |
| 116 | * |
| 117 | */ |
| 118 | public function getLoadingView() { |
| 119 | return GIVE_PLUGIN_DIR . 'src/Views/Form/defaultLoadingView.php'; |
| 120 | } |
| 121 | |
| 122 | /** |
| 123 | * Get form view filepath |
| 124 | * |
| 125 | * @return string |
| 126 | * @since 2.7.0 |
| 127 | * |
| 128 | */ |
| 129 | public function getFormView() { |
| 130 | return GIVE_PLUGIN_DIR . 'src/Views/Form/defaultFormTemplate.php'; |
| 131 | } |
| 132 | |
| 133 | /** |
| 134 | * Get receipt view filepath |
| 135 | * |
| 136 | * @return string |
| 137 | * @since 2.7.0 |
| 138 | * |
| 139 | */ |
| 140 | public function getReceiptView() { |
| 141 | return GIVE_PLUGIN_DIR . 'src/Views/Form/defaultFormReceiptTemplate.php'; |
| 142 | } |
| 143 | |
| 144 | /** |
| 145 | * return form template ID. |
| 146 | * |
| 147 | * @return string |
| 148 | * @since 2.7.0 |
| 149 | */ |
| 150 | abstract public function getID(); |
| 151 | |
| 152 | /** |
| 153 | * Get form template name. |
| 154 | * |
| 155 | * @return string |
| 156 | * @since 2.7.0 |
| 157 | */ |
| 158 | abstract public function getName(); |
| 159 | |
| 160 | /** |
| 161 | * Get form template image. |
| 162 | * |
| 163 | * @return string |
| 164 | * @since 2.7.0 |
| 165 | */ |
| 166 | abstract public function getImage(); |
| 167 | |
| 168 | /** |
| 169 | * Get options config |
| 170 | * |
| 171 | * @return array |
| 172 | * @since 2.7.0 |
| 173 | */ |
| 174 | abstract public function getOptionsConfig(); |
| 175 | |
| 176 | /** |
| 177 | * Get form template options |
| 178 | * |
| 179 | * @return Options |
| 180 | */ |
| 181 | public function getOptions() { |
| 182 | return Options::fromArray( $this->getOptionsConfig() ); |
| 183 | } |
| 184 | |
| 185 | /** |
| 186 | * Get failed/cancelled donation message. |
| 187 | * |
| 188 | * @return string |
| 189 | * @since 2.7.0 |
| 190 | */ |
| 191 | public function getFailedDonationMessage() { |
| 192 | return esc_html__( |
| 193 | 'We\'re sorry, your donation failed to process. Please try again or contact site support.', |
| 194 | 'give' |
| 195 | ); |
| 196 | } |
| 197 | |
| 198 | |
| 199 | /** |
| 200 | * Get failed donation page URL. |
| 201 | * |
| 202 | * @param int $formId |
| 203 | * |
| 204 | * @return mixed |
| 205 | * @since 2.7.0 |
| 206 | */ |
| 207 | public function getFailedPageURL( $formId ) { |
| 208 | return FormUtils::createFailedPageURL( Give()->routeForm->getURL( get_post_field( 'post_name', $formId ) ) ); |
| 209 | } |
| 210 | |
| 211 | /** |
| 212 | * Get donate now button label text. |
| 213 | * |
| 214 | * @return string |
| 215 | * @since 2.7.0 |
| 216 | */ |
| 217 | public function getDonateNowButtonLabel() { |
| 218 | return __( 'Donate Now', 'give' ); |
| 219 | } |
| 220 | |
| 221 | /** |
| 222 | * Get continue to donation form button label text. |
| 223 | * |
| 224 | * @return string |
| 225 | * @since 2.7.0 |
| 226 | */ |
| 227 | public function getContinueToDonationFormLabel() { |
| 228 | return __( 'Donate Now', 'give' ); |
| 229 | } |
| 230 | |
| 231 | /** |
| 232 | * Get donation introduction text. |
| 233 | * |
| 234 | * @return string|null |
| 235 | * @since 2.7.0 |
| 236 | */ |
| 237 | public function getDonationIntroductionContent() { |
| 238 | return null; |
| 239 | } |
| 240 | |
| 241 | /** |
| 242 | * Return content position on donation form. |
| 243 | * |
| 244 | * Note: Even you are free to add introduction content at any place on donation form |
| 245 | * But still this depends upon form template style and configuration on which places you are allowed to show display introduction content. |
| 246 | * |
| 247 | * @return string|null |
| 248 | * @since 2.7.0 |
| 249 | */ |
| 250 | public function getDonationIntroductionContentPosition() { |
| 251 | return null; |
| 252 | } |
| 253 | |
| 254 | /** |
| 255 | * Get receipt details. |
| 256 | * |
| 257 | * @param int $donationId |
| 258 | * |
| 259 | * @return DonationReceipt |
| 260 | * @since 2.7.0 |
| 261 | */ |
| 262 | public function getReceiptDetails( $donationId ) { |
| 263 | $receipt = new DonationReceipt( $donationId ); |
| 264 | |
| 265 | /** |
| 266 | * Fire the action for receipt object. |
| 267 | * |
| 268 | * @since 2.7.0 |
| 269 | */ |
| 270 | do_action( 'give_new_receipt', $receipt ); |
| 271 | |
| 272 | return $receipt; |
| 273 | } |
| 274 | |
| 275 | /** |
| 276 | * Get form heading |
| 277 | * |
| 278 | * @param int $formId |
| 279 | * |
| 280 | * @return string |
| 281 | * @since 2.7.0 |
| 282 | * |
| 283 | */ |
| 284 | public function getFormHeading( $formId ) { |
| 285 | return get_the_title( $formId ); |
| 286 | } |
| 287 | |
| 288 | /** |
| 289 | * Get form image |
| 290 | * |
| 291 | * @param int $formId |
| 292 | * |
| 293 | * @return string |
| 294 | * @since 2.7.0 |
| 295 | * |
| 296 | */ |
| 297 | public function getFormFeaturedImage( $formId ) { |
| 298 | return get_the_post_thumbnail_url( $formId, 'full' ); |
| 299 | } |
| 300 | |
| 301 | /** |
| 302 | * Get form excerpt |
| 303 | * |
| 304 | * @param int|null $formId |
| 305 | * |
| 306 | * @return string |
| 307 | * @since 2.7.0 |
| 308 | * |
| 309 | */ |
| 310 | public function getFormExcerpt( $formId ) { |
| 311 | return get_the_excerpt( $formId ); |
| 312 | } |
| 313 | } |
| 314 |