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

give / includes / class-give-cron.php

give / includes Last commit date

class-give-cron.php

232 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	return $schedules;
96	}
97
98	/**
99	* Schedules our events
100	*
101	* @return void
102	* @since 1.3.2
103	* @access public
104	*/
105	public function __schedule_events() {
106	$this->monthly_events();
107	$this->weekly_events();
108	$this->daily_events();
109	}
110
111	/**
112	* Schedule monthly events
113	*
114	* @return void
115	* @since 2.5.0
116	* @access private
117	*/
118	private function monthly_events() {
119	if ( ! wp_next_scheduled( 'give_monthly_scheduled_events' ) ) {
120	wp_schedule_event( current_time( 'timestamp' ), 'monthly', 'give_monthly_scheduled_events' );
121	}
122	}
123
124	/**
125	* Schedule weekly events
126	*
127	* @return void
128	* @since 1.3.2
129	* @access private
130	*/
131	private function weekly_events() {
132	if ( ! wp_next_scheduled( 'give_weekly_scheduled_events' ) ) {
133	wp_schedule_event( current_time( 'timestamp' ), 'weekly', 'give_weekly_scheduled_events' );
134	}
135	}
136
137	/**
138	* Schedule daily events
139	*
140	* @return void
141	* @since 1.3.2
142	* @access private
143	*/
144	private function daily_events() {
145	if ( ! wp_next_scheduled( 'give_daily_scheduled_events' ) ) {
146	wp_schedule_event( current_time( 'timestamp' ), 'daily', 'give_daily_scheduled_events' );
147	}
148	}
149
150	/**
151	* get cron job action name
152	*
153	* @param string $type
154	*
155	* @return string
156	* @since 1.8.13
157	* @access public
158	*/
159	public static function get_cron_action( $type = 'weekly' ) {
160	$cron_action = '';
161
162	switch ( $type ) {
163	case 'daily':
164	$cron_action = 'give_daily_scheduled_events';
165	break;
166
167	case 'monthly':
168	$cron_action = 'give_monthly_scheduled_events';
169	break;
170
171	case 'weekly':
172	$cron_action = 'give_weekly_scheduled_events';
173	break;
174	}
175
176	return $cron_action;
177	}
178
179	/**
180	* Add action to cron action
181	*
182	* @param string $callback
183	* @param string $type
184	*
185	* @since 1.8.13
186	* @access private
187	*/
188	private static function add_event( $callback, $type = 'weekly' ) {
189	$cron_event = self::get_cron_action( $type );
190	add_action( $cron_event, $callback );
191	}
192
193	/**
194	* Add weekly event
195	*
196	* @param string $callback
197	*
198	* @since 1.8.13
199	* @access public
200	*/
201	public static function add_weekly_event( $callback ) {
202	self::add_event( $callback );
203	}
204
205	/**
206	* Add daily event
207	*
208	* @param $callback
209	*
210	* @since 1.8.13
211	* @access public
212	*/
213	public static function add_daily_event( $callback ) {
214	self::add_event( $callback, 'daily' );
215	}
216
217	/**
218	* Add monthly event
219	*
220	* @param $callback
221	*
222	* @since 2.5.0
223	* @access public
224	*/
225	public static function add_monthly_event( $callback ) {
226	self::add_event( $callback, 'monthly' );
227	}
228	}
229
230	// Initiate class.
231	Give_Cron::get_instance();
232