ActionScheduler_ActionFactory.php — MailPoet – Newsletters, Email Marketing, and Automation 5.36.0

mailpoet / vendor / woocommerce / action-scheduler / classes / ActionScheduler_ActionFactory.php

mailpoet / vendor / woocommerce / action-scheduler / classes Last commit date

ActionScheduler_ActionFactory.php

161 lines

1	<?php
2	if (!defined('ABSPATH')) exit;
3	class ActionScheduler_ActionFactory {
4	public function get_stored_action( $status, $hook, array $args = array(), ?ActionScheduler_Schedule $schedule = null, $group = '' ) {
5	// The 6th parameter ($priority) is not formally declared in the method signature to maintain compatibility with
6	// third-party subclasses created before this param was added.
7	$priority = func_num_args() >= 6 ? (int) func_get_arg( 5 ) : 10;
8	switch ( $status ) {
9	case ActionScheduler_Store::STATUS_PENDING:
10	$action_class = 'ActionScheduler_Action';
11	break;
12	case ActionScheduler_Store::STATUS_CANCELED:
13	$action_class = 'ActionScheduler_CanceledAction';
14	if ( ! is_null( $schedule ) && ! is_a( $schedule, 'ActionScheduler_CanceledSchedule' ) && ! is_a( $schedule, 'ActionScheduler_NullSchedule' ) ) {
15	$schedule = new ActionScheduler_CanceledSchedule( $schedule->get_date() );
16	}
17	break;
18	default:
19	$action_class = 'ActionScheduler_FinishedAction';
20	break;
21	}
22	$action_class = apply_filters( 'action_scheduler_stored_action_class', $action_class, $status, $hook, $args, $schedule, $group );
23	$action = new $action_class( $hook, $args, $schedule, $group );
24	$action->set_priority( $priority );
25	return apply_filters( 'action_scheduler_stored_action_instance', $action, $hook, $args, $schedule, $group, $priority );
26	}
27	public function async( $hook, $args = array(), $group = '' ) {
28	return $this->async_unique( $hook, $args, $group, false );
29	}
30	public function async_unique( $hook, $args = array(), $group = '', $unique = true ) {
31	$schedule = new ActionScheduler_NullSchedule();
32	$action = new ActionScheduler_Action( $hook, $args, $schedule, $group );
33	return $unique ? $this->store_unique_action( $action, $unique ) : $this->store( $action );
34	}
35	public function single( $hook, $args = array(), $when = null, $group = '' ) {
36	return $this->single_unique( $hook, $args, $when, $group, false );
37	}
38	public function single_unique( $hook, $args = array(), $when = null, $group = '', $unique = true ) {
39	$date = as_get_datetime_object( $when );
40	$schedule = new ActionScheduler_SimpleSchedule( $date );
41	$action = new ActionScheduler_Action( $hook, $args, $schedule, $group );
42	return $unique ? $this->store_unique_action( $action ) : $this->store( $action );
43	}
44	public function recurring( $hook, $args = array(), $first = null, $interval = null, $group = '' ) {
45	return $this->recurring_unique( $hook, $args, $first, $interval, $group, false );
46	}
47	public function recurring_unique( $hook, $args = array(), $first = null, $interval = null, $group = '', $unique = true ) {
48	if ( empty( $interval ) ) {
49	return $this->single_unique( $hook, $args, $first, $group, $unique );
50	}
51	$date = as_get_datetime_object( $first );
52	$schedule = new ActionScheduler_IntervalSchedule( $date, $interval );
53	$action = new ActionScheduler_Action( $hook, $args, $schedule, $group );
54	return $unique ? $this->store_unique_action( $action ) : $this->store( $action );
55	}
56	public function cron( $hook, $args = array(), $base_timestamp = null, $schedule = null, $group = '' ) {
57	return $this->cron_unique( $hook, $args, $base_timestamp, $schedule, $group, false );
58	}
59	public function cron_unique( $hook, $args = array(), $base_timestamp = null, $schedule = null, $group = '', $unique = true ) {
60	if ( empty( $schedule ) ) {
61	return $this->single_unique( $hook, $args, $base_timestamp, $group, $unique );
62	}
63	$date = as_get_datetime_object( $base_timestamp );
64	$cron = CronExpression::factory( $schedule );
65	$schedule = new ActionScheduler_CronSchedule( $date, $cron );
66	$action = new ActionScheduler_Action( $hook, $args, $schedule, $group );
67	return $unique ? $this->store_unique_action( $action ) : $this->store( $action );
68	}
69	public function repeat( $action ) {
70	$schedule = $action->get_schedule();
71	$next = $schedule->get_next( as_get_datetime_object() );
72	if ( is_null( $next ) \|\| ! $schedule->is_recurring() ) {
73	throw new InvalidArgumentException( __( 'Invalid action - must be a recurring action.', 'action-scheduler' ) );
74	}
75	$schedule_class = get_class( $schedule );
76	$new_schedule = new $schedule( $next, $schedule->get_recurrence(), $schedule->get_first_date() );
77	$new_action = new ActionScheduler_Action( $action->get_hook(), $action->get_args(), $new_schedule, $action->get_group() );
78	$new_action->set_priority( $action->get_priority() );
79	return $this->store( $new_action );
80	}
81	public function create( array $options = array() ) {
82	$defaults = array(
83	'type' => 'single',
84	'hook' => '',
85	'arguments' => array(),
86	'group' => '',
87	'unique' => false,
88	'when' => time(),
89	'pattern' => null,
90	'priority' => 10,
91	);
92	$options = array_merge( $defaults, $options );
93	// Cron/recurring actions without a pattern are treated as single actions (this gives calling code the ability
94	// to use functions like as_schedule_recurring_action() to schedule recurring as well as single actions).
95	if ( ( 'cron' === $options['type'] \|\| 'recurring' === $options['type'] ) && empty( $options['pattern'] ) ) {
96	$options['type'] = 'single';
97	}
98	switch ( $options['type'] ) {
99	case 'async':
100	$schedule = new ActionScheduler_NullSchedule();
101	break;
102	case 'cron':
103	$date = as_get_datetime_object( $options['when'] );
104	$cron = CronExpression::factory( $options['pattern'] );
105	$schedule = new ActionScheduler_CronSchedule( $date, $cron );
106	break;
107	case 'recurring':
108	$date = as_get_datetime_object( $options['when'] );
109	$schedule = new ActionScheduler_IntervalSchedule( $date, $options['pattern'] );
110	break;
111	case 'single':
112	$date = as_get_datetime_object( $options['when'] );
113	$schedule = new ActionScheduler_SimpleSchedule( $date );
114	break;
115	default:
116	// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
117	error_log( "Unknown action type '{$options['type']}' specified when trying to create an action for '{$options['hook']}'." );
118	return 0;
119	}
120	$action = new ActionScheduler_Action( $options['hook'], $options['arguments'], $schedule, $options['group'] );
121	$action->set_priority( $options['priority'] );
122	$action_id = 0;
123	try {
124	$action_id = $options['unique'] ? $this->store_unique_action( $action ) : $this->store( $action );
125	} catch ( Exception $e ) {
126	// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log
127	error_log(
128	sprintf(
129	__( 'Caught exception while enqueuing action "%1$s": %2$s', 'action-scheduler' ),
130	$options['hook'],
131	$e->getMessage()
132	)
133	);
134	}
135	return $action_id;
136	}
137	protected function store( ActionScheduler_Action $action ) {
138	$store = ActionScheduler_Store::instance();
139	return $store->save_action( $action );
140	}
141	protected function store_unique_action( ActionScheduler_Action $action ) {
142	$store = ActionScheduler_Store::instance();
143	if ( method_exists( $store, 'save_unique_action' ) ) {
144	return $store->save_unique_action( $action );
145	} else {
146	$existing_action_id = (int) $store->find_action(
147	$action->get_hook(),
148	array(
149	'args' => $action->get_args(),
150	'status' => ActionScheduler_Store::STATUS_PENDING,
151	'group' => $action->get_group(),
152	)
153	);
154	if ( $existing_action_id > 0 ) {
155	return 0;
156	}
157	return $store->save_action( $action );
158	}
159	}
160	}
161