TypeInterface.php — Flexible Checkout Fields for WooCommerce – WooCommerce Checkout Manager trunk

flexible-checkout-fields / src / Field / Type / TypeInterface.php

flexible-checkout-fields / src / Field / Type Last commit date

TypeInterface.php

82 lines

1	<?php
2
3	namespace WPDesk\FCF\Free\Field\Type;
4
5	use WPDesk\FCF\Free\Settings\Option\OptionInterface;
6
7	/**
8	* Interface of field type.
9	*/
10	interface TypeInterface {
11
12	/**
13	* Returns value of field type.
14	*
15	* @return string Field type.
16	*/
17	public function get_field_type(): string;
18
19	/**
20	* Returns value of field type used in HTML.
21	*
22	* @return string Field type.
23	*/
24	public function get_raw_field_type(): string;
25
26	/**
27	* Returns reserved field names, overriding this field type for selected field names.
28	*
29	* @return array Field names.
30	*/
31	public function get_reserved_field_names(): array;
32
33	/**
34	* Returns label of field type.
35	*
36	* @return string Field label.
37	*/
38	public function get_field_type_label(): string;
39
40	/**
41	* Returns key of field group.
42	*
43	* @return string\|null
44	*/
45	public function get_field_group();
46
47	/**
48	* Returns field icon as CSS Class supported by Icomoon.
49	*
50	* @return string Field icon.
51	*/
52	public function get_field_type_icon(): string;
53
54	/**
55	* Returns whether field type is hidden.
56	*
57	* @return bool Status if field type is hidden.
58	*/
59	public function is_hidden(): bool;
60
61	/**
62	* Returns whether field type is available for plugin version.
63	*
64	* @return bool Status if field type is available.
65	*/
66	public function is_available(): bool;
67
68	/**
69	* Returns list of options objects for field settings.
70	*
71	* @return OptionInterface[] List of field options objects.
72	*/
73	public function get_options_objects(): array;
74
75	/**
76	* Returns list of options for field settings.
77	*
78	* @return array List of field options.
79	*/
80	public function get_options(): array;
81	}
82