1 | <?php |
||
26 | class Give_Email_Access { |
||
27 | |||
28 | /** |
||
29 | * Token exists |
||
30 | * |
||
31 | * @since 1.0 |
||
32 | * @access public |
||
33 | * |
||
34 | * @var bool |
||
35 | */ |
||
36 | public $token_exists = false; |
||
37 | |||
38 | /** |
||
39 | * Token email |
||
40 | * |
||
41 | * @since 1.0 |
||
42 | * @access public |
||
43 | * |
||
44 | * @var bool |
||
45 | */ |
||
46 | public $token_email = false; |
||
47 | |||
48 | /** |
||
49 | * Token |
||
50 | * |
||
51 | * @since 1.0 |
||
52 | * @access public |
||
53 | * |
||
54 | * @var bool |
||
55 | */ |
||
56 | public $token = false; |
||
57 | |||
58 | /** |
||
59 | * Error |
||
60 | * |
||
61 | * @since 1.0 |
||
62 | * @access public |
||
63 | * |
||
64 | * @var string |
||
65 | */ |
||
66 | public $error = ''; |
||
67 | |||
68 | /** |
||
69 | * Verify throttle |
||
70 | * |
||
71 | * @since 1.0 |
||
72 | * @access public |
||
73 | * |
||
74 | * @var |
||
75 | */ |
||
76 | public $verify_throttle; |
||
77 | |||
78 | /** |
||
79 | * Limit throttle |
||
80 | * |
||
81 | * @since 1.8.17 |
||
82 | * @access public |
||
83 | * |
||
84 | * @var |
||
85 | */ |
||
86 | public $limit_throttle; |
||
87 | |||
88 | /** |
||
89 | * Verify expiration |
||
90 | * |
||
91 | * @since 1.0 |
||
92 | * @access private |
||
93 | * |
||
94 | * @var string |
||
95 | */ |
||
96 | private $token_expiration; |
||
97 | |||
98 | /** |
||
99 | * Class Constructor |
||
100 | * |
||
101 | * Set up the Give Email Access Class. |
||
102 | * |
||
103 | * @since 1.0 |
||
104 | * @access public |
||
105 | */ |
||
106 | public function __construct() { |
||
111 | |||
112 | /** |
||
113 | * Setup hooks |
||
114 | * |
||
115 | * @since 2.4.0 |
||
116 | */ |
||
117 | public function setup(){ |
||
118 | |||
119 | $is_email_access_on_page = apply_filters( 'give_is_email_access_on_page', give_is_success_page() || give_is_history_page() ); |
||
120 | |||
121 | if ( $is_email_access_on_page ){ |
||
122 | // Get it started. |
||
123 | add_action( 'wp', array( $this, 'init' ), 14 ); |
||
124 | } |
||
125 | } |
||
126 | |||
127 | /** |
||
128 | * Init |
||
129 | * |
||
130 | * Register defaults and filters |
||
131 | * |
||
132 | * @since 1.0 |
||
133 | * @access public |
||
134 | * |
||
135 | * @return void |
||
136 | */ |
||
137 | public function init() { |
||
164 | |||
165 | /** |
||
166 | * Prevent email spamming. |
||
167 | * |
||
168 | * @param int $donor_id Donor ID. |
||
169 | * |
||
170 | * @since 1.0 |
||
171 | * @access public |
||
172 | * |
||
173 | * @return bool |
||
174 | */ |
||
175 | public function can_send_email( $donor_id ) { |
||
199 | |||
200 | /** |
||
201 | * Send the user's token |
||
202 | * |
||
203 | * @param int $donor_id Donor id. |
||
204 | * @param string $email Donor email. |
||
205 | * |
||
206 | * @since 1.0 |
||
207 | * @access public |
||
208 | * |
||
209 | * @return bool |
||
210 | */ |
||
211 | public function send_email( $donor_id, $email ) { |
||
214 | |||
215 | /** |
||
216 | * This function is used to fetch the token value from query string or cookies based on availability. |
||
217 | * |
||
218 | * @since 2.4.1 |
||
219 | * @access public |
||
220 | * |
||
221 | * @return string |
||
222 | */ |
||
223 | public function get_token() { |
||
234 | |||
235 | /** |
||
236 | * Has the user authenticated? |
||
237 | * |
||
238 | * @since 1.0 |
||
239 | * @access public |
||
240 | * |
||
241 | * @return bool |
||
242 | */ |
||
243 | public function check_for_token() { |
||
266 | |||
267 | /** |
||
268 | * Is this a valid token? |
||
269 | * |
||
270 | * @since 1.0 |
||
271 | * @access public |
||
272 | * |
||
273 | * @param $token string The token. |
||
274 | * |
||
275 | * @return bool |
||
276 | */ |
||
277 | public function is_valid_token( $token ) { |
||
305 | |||
306 | /** |
||
307 | * Add the verify key to DB |
||
308 | * |
||
309 | * @param int $donor_id Donor id. |
||
310 | * @param string $email Donor email. |
||
311 | * @param string $verify_key The verification key. |
||
312 | * |
||
313 | * @since 1.0 |
||
314 | * @access public |
||
315 | * |
||
316 | * @return void |
||
317 | */ |
||
318 | public function set_verify_key( $donor_id, $email, $verify_key ) { |
||
340 | |||
341 | /** |
||
342 | * Is this a valid verify key? |
||
343 | * |
||
344 | * @since 1.0 |
||
345 | * @access public |
||
346 | * |
||
347 | * @param $token string The token. |
||
348 | * |
||
349 | * @return bool |
||
350 | */ |
||
351 | public function is_valid_verify_key( $token ) { |
||
376 | |||
377 | /** |
||
378 | * Users donations args |
||
379 | * |
||
380 | * Force Give to find donations by email, not user ID. |
||
381 | * |
||
382 | * @since 1.0 |
||
383 | * @access public |
||
384 | * |
||
385 | * @param $args array User Donations arguments. |
||
386 | * |
||
387 | * @return mixed |
||
388 | */ |
||
389 | public function users_donations_args( $args ) { |
||
394 | |||
395 | /** |
||
396 | * Create required columns |
||
397 | * |
||
398 | * Create the necessary columns for email access |
||
399 | * |
||
400 | * @since 1.0 |
||
401 | * @access public |
||
402 | * |
||
403 | * @return void |
||
404 | */ |
||
405 | public function create_columns() { |
||
412 | } |
||
413 |