vikbooking / admin / helpers / src / checkin / paxfields.php

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

78 lines 1.9 KB

Raw Download Zip

1	<?php
2	/**
3	* @package VikBooking
4	* @subpackage core
5	* @author Alessio Gaggii - 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	* Declares the methods that a custom pax data field driver should provide.
16	*
17	* @since 1.15.0 (J) - 1.5.0 (WP)
18	*/
19	interface VBOCheckinPaxfields
20	{
21	/**
22	* Returns the name of the current pax data collection driver.
23	*
24	* @return string the name of this driver.
25	*/
26	public function getName();
27
28	/**
29	* Builds the list pax fields labels.
30	*
31	* @return array the list of pax fields labels.
32	*/
33	public function getLabels();
34
35	/**
36	* Builds the list pax fields attributes.
37	*
38	* @return array the list of pax fields attributes.
39	*/
40	public function getAttributes();
41
42	/**
43	* Returns a list of pax fields to collect through this driver.
44	*
45	* @return array the list of pax fields.
46	*/
47	public function listFields();
48
49	/**
50	* Tells whether children should be registered.
51	*
52	* @param bool $precheckin true if requested for front-end pre check-in.
53	*
54	* @return bool true to also register the children.
55	*
56	* @since 1.16.3 (J) - 1.6.3 (WP) added $precheckin argument.
57	*/
58	public function registerChildren($precheckin = false);
59
60	/**
61	* Returns the instance of the given pax field key.
62	*
63	* @param string $key the field key identifier.
64	*
65	* @return VBOCheckinPaxfield the requested pax field object.
66	*/
67	public function getField($key);
68
69	/**
70	* Renders a specific pax field type.
71	*
72	* @param VBOCheckinPaxfield $field the instance of the pax field to render.
73	*
74	* @return string the HTML string to display the field.
75	*/
76	public function render(VBOCheckinPaxfield $field);
77	}
78