1	<?php
2	declare(strict_types=1);
3
4	namespace Korobochkin\WPKit\Cron;
5
6	/**
7	* Interface CronSingleEventInterface
8	* @package Korobochkin\WPKit\Cron
9	*/
10	interface CronSingleEventInterface
11	{
12
13	/**
14	* Returns the event name which can be used as WordPress action name.
15	*
16	* @return string The event name.
17	*/
18	public function getName();
19
20	/**
21	* Sets the event name which can be used as WordPress action name.
22	*
23	* @param $name string The name of event. Prefix it if possibly with your custom plugin or theme slug.
24	*
25	* @return $this For chain calls.
26	*/
27	public function setName($name);
28
29	/**
30	* Returns the hook (function) which WordPress will call.
31	*
32	* @return callable The hook that WordPress will call.
33	*/
34	public function getHook();
35
36	/**
37	* Sets the hook (function) which WordPress will call.
38	*
39	* @param $hook callable The hook that WordPress will call.
40	*
41	* @return $this For chain calls.
42	*/
43	public function setHook($hook);
44
45	/**
46	* Register event in WordPress.
47	*
48	* @throws \RuntimeException
49	*
50	* @return $this
51	*/
52	public function schedule();
53
54	/**
55	* Delete single event in WordPress based on args and timestamp.
56	*
57	* @throws \RuntimeException
58	*
59	* @return $this
60	*/
61	public function unschedule();
62
63	/**
64	* Delete all events in WordPress with event name.
65	*
66	* @return $this For chain calls.
67	*/
68	public function unscheduleAll();
69
70	/**
71	* Returns the timestamp.
72	*
73	* @return int The time you want the event to occur. This must be in a UNIX timestamp format.
74	*/
75	public function getTimestamp();
76
77	/**
78	* Sets the timestamp.
79	*
80	* @param $timestamp int The time you want the event to occur. This must be in a UNIX timestamp format.
81	*
82	* @return $this For chain calls.
83	*/
84	public function setTimestamp($timestamp);
85
86	/**
87	* Mark this even runned ASAP.
88	*
89	* In other words this method setup current timestamp for this event.
90	*
91	* @return $this For chain calls.
92	*/
93	public function immediately();
94
95	/**
96	* Returns the args for this particular event.
97	*
98	* @return array Args which will be passed to event during execution.
99	*/
100	public function getArgs();
101
102	/**
103	* Sets the args for particular event.
104	*
105	* @param $args array Args for event.
106	*
107	* @return $this For chain calls.
108	*/
109	public function setArgs(array $args);
110
111	/**
112	* Returns flag which show existing event.
113	*
114	* @return boolean True if scheduled, false if not.
115	*/
116	public function isScheduled();
117	}