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

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

102 lines 1.9 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	abstract class VBOHelpWizardInstructionaware implements VBOHelpWizardInstruction
20	{
21	/**
22	* @inheritDoc
23	*/
24	public function getTitle()
25	{
26	$id = preg_replace("/[^a-zA-Z0-9]+/", '_', $this->getID());
27	return JText::translate('VBO_HELP_WIZARD_' . strtoupper($id));
28	}
29
30	/**
31	* @inheritDoc
32	*/
33	public function getIcon()
34	{
35	return VikBookingIcons::i('exclamation');
36	}
37
38	/**
39	* @inheritDoc
40	*/
41	public function getPriority()
42	{
43	// medium priority
44	return 99;
45	}
46
47	/**
48	* @inheritDoc
49	*/
50	public function isSupported()
51	{
52	// always supported by default
53	return true;
54	}
55
56	/**
57	* @inheritDoc
58	*/
59	public function show()
60	{
61	$data = array_merge($this->getLayoutData(), [
62	'instruction' => $this,
63	]);
64
65	return JLayoutHelper::render('helpwizard.' . $this->getID(), $data);
66	}
67
68	/**
69	* @inheritDoc
70	*/
71	public function isDismissible()
72	{
73	return true;
74	}
75
76	/**
77	* @inheritDoc
78	*/
79	public function isProcessable(?string &$btnText = null)
80	{
81	return false;
82	}
83
84	/**
85	* @inheritDoc
86	*/
87	public function process(array $args = [])
88	{
89	// do nothing by default
90	}
91
92	/**
93	* The display data to be passed to the rendering layout.
94	*
95	* @return array
96	*/
97	protected function getLayoutData()
98	{
99	return [];
100	}
101	}
102