vikbooking / admin / helpers / src / help / wizard / instruction.php

instruction.php in VikBooking Hotel Booking Engine & PMS trunk, at admin/helpers/src/help/wizard/instruction.php

95 lines 2.0 KB

Raw Download Zip

1	<?php
2	/**
3	* @package VikBooking
4	* @subpackage core
5	* @author E4J s.r.l.
6	* @copyright Copyright (C) 2021 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	* Wizard help instruction interface.
16	*
17	* @since 1.18.2 (J) - 1.8.2 (WP)
18	*/
19	interface VBOHelpWizardInstruction
20	{
21	/**
22	* Returns the instruction unique identifier.
23	*
24	* @return string
25	*/
26	public function getID();
27
28	/**
29	* Returns the instruction title.
30	*
31	* @return string
32	*/
33	public function getTitle();
34
35	/**
36	* Returns the instruction icon (FontAwesome).
37	*
38	* @return string
39	*/
40	public function getIcon();
41
42	/**
43	* Instructions with higher priority will be prompted first.
44	*
45	* @return int
46	*/
47	public function getPriority();
48
49	/**
50	* Checks whether the instruction is supported by the current customer.
51	*
52	* @return bool
53	*/
54	public function isSupported();
55
56	/**
57	* Checks whether the (supported) instruction has been already configured.
58	*
59	* @return bool
60	*/
61	public function isConfigured();
62
63	/**
64	* Shows the instruction details.
65	*
66	* @return string
67	*/
68	public function show();
69
70	/**
71	* Checks whether the instruction can be dismissed.
72	*
73	* @return bool
74	*/
75	public function isDismissible();
76
77	/**
78	* Checks whether the instruction can be processed.
79	*
80	* @param string\|null &$btnText A custom text to display for the "Process" button.
81	*
82	* @return bool
83	*/
84	public function isProcessable(?string &$btnText = null);
85
86	/**
87	* Processes the instruction.
88	*
89	* @param array $args
90	*
91	* @return mixed The returned value will be propagated to the caller.
92	*/
93	public function process(array $args = []);
94	}
95