vikbooking / admin / helpers / src / task / status / interface.php

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

74 lines 1.7 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 status interface.
16	*
17	* @since 1.18.0 (J) - 1.8.0 (WP)
18	*/
19	interface VBOTaskStatusInterface
20	{
21	/**
22	* Returns the enum value for the task status used to build the class name.
23	*
24	* @return string A unique enum identifier.
25	*/
26	public function getEnum();
27
28	/**
29	* Returns the group enum value to which the task status belong.
30	*
31	* @return string The group enumeration value.
32	*/
33	public function getGroupEnum();
34
35	/**
36	* Returns the name of the task status.
37	*
38	* @return string The status readable name.
39	*/
40	public function getName();
41
42	/**
43	* Returns the color enum for the current task status.
44	*
45	* @return string The task status color enumeration.
46	*/
47	public function getColor();
48
49	/**
50	* Returns the task status group ordering value.
51	*
52	* @return int The status group ordering value.
53	*/
54	public function getOrdering();
55
56	/**
57	* This function should be invoked whenever the provided task applies this status.
58	*
59	* @param int $taskId
60	*
61	* @return void
62	*/
63	public function apply(int $taskId);
64
65	/**
66	* Displays some extra information about this status.
67	*
68	* @param VBOTaskTaskregistry $task
69	*
70	* @return string
71	*/
72	public function display(VBOTaskTaskregistry $task);
73	}
74