vikbooking / admin / helpers / src / task / driverinterface.php

driverinterface.php in VikBooking Hotel Booking Engine & PMS trunk, at admin/helpers/src/task/driverinterface.php

89 lines 2.4 KB

Raw Download Zip

1	<?php
2	/**
3	* @package VikBooking
4	* @subpackage core
5	* @author E4J s.r.l.
6	* @copyright Copyright (C) 2025 E4J s.r.l. All Rights Reserved.
7	* @license http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL
8	* @link https://vikwp.com
9	*/
10
11	// No direct access
12	defined('ABSPATH') or die('No script kiddies please!');
13
14	/**
15	* Task driver interface.
16	*
17	* @since 1.18.0 (J) - 1.8.0 (WP)
18	*/
19	interface VBOTaskDriverinterface
20	{
21	/**
22	* Returns the ID of the task driver used to build the class name.
23	*
24	* @return string A unique identifier.
25	*/
26	public function getID();
27
28	/**
29	* Returns the name of the task driver.
30	*
31	* @return string The driver readable name.
32	*/
33	public function getName();
34
35	/**
36	* Returns the task driver icon.
37	*
38	* @return string The font-icon class identifier.
39	*/
40	public function getIcon();
41
42	/**
43	* Returns the task driver parameters.
44	*
45	* @return array List of driver parameters.
46	*/
47	public function getParams();
48
49	/**
50	* Can be used to inject custom HTML within the task management layout.
51	*
52	* @param string $position The position where the output will be displayed.
53	* @param VBOTaskTaskregistry $task The task we are updating.
54	* @param VBOTaskArea $area The area this task belongs to.
55	*
56	* @return string The HTML to output.
57	*
58	* @since 1.18.15 (J) - 1.8.15 (WP)
59	*/
60	public function onManageTask(string $position, VBOTaskTaskregistry $task, VBOTaskArea $area);
61
62	/**
63	* Executes and schedules (eventually) the task(s) upon a booking confirmation.
64	*
65	* @param VBOTaskBooking $booking The task booking object.
66	*
67	* @return void
68	*/
69	public function scheduleBookingConfirmation(VBOTaskBooking $booking);
70
71	/**
72	* Executes and schedules (eventually) the task(s) upon a booking alteration.
73	*
74	* @param VBOTaskBooking $booking The task booking object.
75	*
76	* @return void
77	*/
78	public function scheduleBookingAlteration(VBOTaskBooking $booking);
79
80	/**
81	* Executes and schedules (eventually) the task(s) upon a booking cancellation.
82	*
83	* @param VBOTaskBooking $booking The task booking object.
84	*
85	* @return void
86	*/
87	public function scheduleBookingCancellation(VBOTaskBooking $booking);
88	}
89