class-give-cron.php — GiveWP – Donation Plugin and Fundraising Platform 3.19.4

give / includes / class-give-cron.php

give / includes Last commit date

class-give-cron.php

268 lines

1	<?php
2	/**
3	* Cron
4	*
5	* @package Give
6	* @subpackage Classes/Give_Cron
7	* @copyright Copyright (c) 2016, GiveWP
8	* @license https://opensource.org/licenses/gpl-license GNU Public License
9	* @since 1.3.2
10	*/
11
12	// Exit if accessed directly.
13	if ( ! defined( 'ABSPATH' ) ) {
14	exit;
15	}
16
17
18	/**
19	* Give_Cron Class
20	*
21	* This class handles scheduled events.
22	*
23	* @since 1.3.2
24	*/
25	class Give_Cron {
26
27	/**
28	* Instance.
29	*
30	* @since 1.8.13
31	* @access private
32	* @var
33	*/
34	private static $instance;
35
36	/**
37	* Singleton pattern.
38	*
39	* @since 1.8.13
40	* @access private
41	*/
42	private function __construct() {
43	}
44
45
46	/**
47	* Get instance.
48	*
49	* @return static
50	* @since 1.8.13
51	* @access public
52	*/
53	public static function get_instance() {
54	if ( null === static::$instance ) {
55	self::$instance = new static();
56	self::$instance->setup();
57	}
58
59	return self::$instance;
60	}
61
62
63	/**
64	* Setup
65	*
66	* @since 1.8.13
67	*/
68	private function setup() {
69	add_filter( 'cron_schedules', array( self::$instance, '__add_schedules' ) );
70	add_action( 'wp', array( self::$instance, '__schedule_events' ) );
71	}
72
73	/**
74	* Registers new cron schedules
75	*
76	* @param array $schedules An array of non-default cron schedules.
77	*
78	* @return array An array of non-default cron schedules.
79	* @since 1.3.2
80	* @access public
81	*/
82	public function __add_schedules( $schedules = array() ) {
83	// Adds once weekly to the existing schedules.
84	$schedules['weekly'] = array(
85	'interval' => 604800, // 7 * 24 * 3600
86	'display' => __( 'Once Weekly', 'give' ),
87	);
88
89	// Adds once weekly to the existing schedules.
90	$schedules['monthly'] = array(
91	'interval' => 2592000, // 30 * 24 * 3600
92	'display' => __( 'Once Monthly', 'give' ),
93	);
94
95	// Adds every third day to the existing schedules.
96	$schedules['thricely'] = array(
97	'interval' => 259200, // 3 * 24 * 3600
98	'display' => __( 'Every Third Day', 'give' ),
99	);
100
101	return $schedules;
102	}
103
104	/**
105	* Schedules our events
106	*
107	* @return void
108	* @since 1.3.2
109	* @access public
110	*/
111	public function __schedule_events() {
112	$this->monthly_events();
113	$this->weekly_events();
114	$this->daily_events();
115	$this->thricely_events();
116	}
117
118	/**
119	* Schedule monthly events
120	*
121	* @return void
122	* @since 2.5.0
123	* @access private
124	*/
125	private function monthly_events() {
126	if ( ! wp_next_scheduled( 'give_monthly_scheduled_events' ) ) {
127	wp_schedule_event( current_time( 'timestamp' ), 'monthly', 'give_monthly_scheduled_events' );
128	}
129	}
130
131	/**
132	* Schedule weekly events
133	*
134	* @return void
135	* @since 1.3.2
136	* @access private
137	*/
138	private function weekly_events() {
139	if ( ! wp_next_scheduled( 'give_weekly_scheduled_events' ) ) {
140	wp_schedule_event( current_time( 'timestamp' ), 'weekly', 'give_weekly_scheduled_events' );
141	}
142	}
143
144	/**
145	* Schedule daily events
146	*
147	* @return void
148	* @since 1.3.2
149	* @access private
150	*/
151	private function daily_events() {
152	if ( ! wp_next_scheduled( 'give_daily_scheduled_events' ) ) {
153	wp_schedule_event( current_time( 'timestamp' ), 'daily', 'give_daily_scheduled_events' );
154	}
155	}
156
157	/**
158	* Schedule thricely events
159	*
160	* @return void
161	* @since 2.5.11
162	* @access private
163	*/
164	private function thricely_events() {
165	if ( ! wp_next_scheduled( 'give_thricely_scheduled_events' ) ) {
166	wp_schedule_event( current_time( 'timestamp' ), 'thricely', 'give_thricely_scheduled_events' );
167	}
168	}
169
170	/**
171	* get cron job action name
172	*
173	* @param string $type
174	*
175	* @return string
176	* @since 1.8.13
177	* @access public
178	*/
179	public static function get_cron_action( $type = 'weekly' ) {
180	$cron_action = '';
181
182	switch ( $type ) {
183	case 'daily':
184	$cron_action = 'give_daily_scheduled_events';
185	break;
186
187	case 'thricely':
188	$cron_action = 'give_thricely_scheduled_events';
189	break;
190
191	case 'monthly':
192	$cron_action = 'give_monthly_scheduled_events';
193	break;
194
195	case 'weekly':
196	$cron_action = 'give_weekly_scheduled_events';
197	break;
198	}
199
200	return $cron_action;
201	}
202
203	/**
204	* Add action to cron action
205	*
206	* @param string $callback
207	* @param string $type
208	*
209	* @since 1.8.13
210	* @access private
211	*/
212	private static function add_event( $callback, $type = 'weekly' ) {
213	$cron_event = self::get_cron_action( $type );
214	add_action( $cron_event, $callback );
215	}
216
217	/**
218	* Add weekly event
219	*
220	* @param string $callback
221	*
222	* @since 1.8.13
223	* @access public
224	*/
225	public static function add_weekly_event( $callback ) {
226	self::add_event( $callback );
227	}
228
229	/**
230	* Add daily event
231	*
232	* @param $callback
233	*
234	* @since 1.8.13
235	* @access public
236	*/
237	public static function add_daily_event( $callback ) {
238	self::add_event( $callback, 'daily' );
239	}
240
241	/**
242	* Add thricely event
243	*
244	* @param $callback
245	*
246	* @since 2.5.11
247	* @access public
248	*/
249	public static function add_thricely_event( $callback ) {
250	self::add_event( $callback, 'thricely' );
251	}
252
253	/**
254	* Add monthly event
255	*
256	* @param $callback
257	*
258	* @since 2.5.0
259	* @access public
260	*/
261	public static function add_monthly_event( $callback ) {
262	self::add_event( $callback, 'monthly' );
263	}
264	}
265
266	// Initiate class.
267	Give_Cron::get_instance();
268