109 lines
2.1 KiB
PHP
109 lines
2.1 KiB
PHP
<?php
|
|
|
|
namespace AutomateWoo\Async_Events;
|
|
|
|
use AutomateWoo\ActionScheduler\ActionSchedulerInterface;
|
|
|
|
/**
|
|
* Class Abstract_Async_Event
|
|
*
|
|
* @since 4.8.0
|
|
*/
|
|
abstract class Abstract_Async_Event {
|
|
|
|
/**
|
|
* The unique name/ID of the event.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $event_name;
|
|
|
|
/**
|
|
* Set any events that this event is dependant on.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $event_dependencies;
|
|
|
|
/**
|
|
* @var ActionSchedulerInterface
|
|
*/
|
|
protected $action_scheduler;
|
|
|
|
/**
|
|
* Init the event.
|
|
*/
|
|
abstract public function init();
|
|
|
|
/**
|
|
* Abstract_Async_Event constructor.
|
|
*
|
|
* @param ActionSchedulerInterface $action_scheduler
|
|
*/
|
|
public function __construct( ActionSchedulerInterface $action_scheduler ) {
|
|
$this->action_scheduler = $action_scheduler;
|
|
}
|
|
|
|
/**
|
|
* Get the event name.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_event_name() {
|
|
return $this->event_name;
|
|
}
|
|
|
|
/**
|
|
* Set the event name.
|
|
*
|
|
* @param string $event_name
|
|
*/
|
|
public function set_event_name( $event_name ) {
|
|
$this->event_name = $event_name;
|
|
}
|
|
|
|
/**
|
|
* Get the events this event is dependant on.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_event_dependencies() {
|
|
return (array) $this->event_dependencies;
|
|
}
|
|
|
|
/**
|
|
* Set the events this event is dependant on.
|
|
*
|
|
* @deprecated in 5.2.0 because it's preferable for events to define their own dependencies.
|
|
*
|
|
* @param array|string $event_dependencies
|
|
*/
|
|
public function set_event_dependencies( $event_dependencies ) {
|
|
wc_deprecated_function( __METHOD__, '5.2.0' );
|
|
$this->event_dependencies = $event_dependencies;
|
|
}
|
|
|
|
/**
|
|
* Get the async event hook name.
|
|
*
|
|
* @since 5.2.0
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_hook_name(): string {
|
|
return "automatewoo/async/{$this->get_event_name()}";
|
|
}
|
|
|
|
/**
|
|
* Create async event.
|
|
*
|
|
* Uses $this->get_hook_name() for the hook name.
|
|
*
|
|
* @param array $event_args The args for the event.
|
|
*
|
|
* @since 5.2.0
|
|
*/
|
|
protected function create_async_event( array $event_args ) {
|
|
$this->action_scheduler->enqueue_async_action( $this->get_hook_name(), $event_args );
|
|
}
|
|
}
|
