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

flexible-checkout-fields / src / Settings / Option / OptionInterface.php

flexible-checkout-fields / src / Settings / Option Last commit date

OptionInterface.php

182 lines

1	<?php
2
3	namespace WPDesk\FCF\Free\Settings\Option;
4
5	/**
6	* Interface for option of field.
7	*/
8	interface OptionInterface {
9
10	/**
11	* Returns name of option.
12	*
13	* @return string Option name.
14	*/
15	public function get_option_name(): string;
16
17	/**
18	* Returns name of option tab.
19	*
20	* @return string Tab name.
21	*/
22	public function get_option_tab(): string;
23
24	/**
25	* Returns type of option.
26	*
27	* @return string Option name.
28	*/
29	public function get_option_type(): string;
30
31	/**
32	* Returns label of option.
33	*
34	* @return string Option label.
35	*/
36	public function get_option_label(): string;
37
38	/**
39	* Returns label of option row (for Repeater field).
40	*
41	* @return string Option row label.
42	*/
43	public function get_option_row_label(): string;
44
45	/**
46	* Returns content for label tooltip.
47	*
48	* @return string Tooltip content.
49	*/
50	public function get_label_tooltip(): string;
51
52	/**
53	* Returns URL for label tooltip.
54	*
55	* @return string Tooltip URL.
56	*/
57	public function get_label_tooltip_url(): string;
58
59	/**
60	* Returns list of HTML attributes for field with their values.
61	*
62	* @return array Atts for field.
63	*/
64	public function get_input_atts(): array;
65
66	/**
67	* Returns pattern to display value (%s will be replaced by option value).
68	* It works only for text or textarea fields.
69	*
70	* @return string Pattern to display value.
71	*/
72	public function get_print_pattern(): string;
73
74	/**
75	* Returns status if option are readonly.
76	*
77	* @return bool Readonly status of option.
78	*/
79	public function is_readonly(): bool;
80
81	/**
82	* Returns list of validation rules for field.
83	* Key is regular expression without delimiters, value is message of validation error.
84	*
85	* @return array Validation rules.
86	*/
87	public function get_validation_rules(): array;
88
89	/**
90	* Returns name of option and regex for its value that must be true to display this field.
91	* Key is name of field, value is regular expression without delimiters.
92	*
93	* @return array Option names with regexes.
94	*/
95	public function get_options_regexes_to_display(): array;
96
97	/**
98	* Returns name of option whose value will create list of rows for Repeater field.
99	*
100	* @return string Option name.
101	*/
102	public function get_option_name_to_rows(): string;
103
104	/**
105	* Returns available values of option, if exists.
106	*
107	* @return array List of option values.
108	*/
109	public function get_values(): array;
110
111	/**
112	* Returns default value of option.
113	*
114	* @return string\|array Default value.
115	*/
116	public function get_default_value();
117
118	/**
119	* Returns endpoint route to retrieve values.
120	*
121	* @return string Route name of endpoint.
122	*/
123	public function get_endpoint_route(): string;
124
125	/**
126	* Returns option names passed to REST API to retrieve values.
127	*
128	* @return array Option keys.
129	*/
130	public function get_endpoint_option_names(): array;
131
132	/**
133	* Returns status if values from endpoint should be refreshed automatically (triggered by refresh event).
134	*
135	* @return bool Status of auto-refreshed values.
136	*/
137	public function is_endpoint_autorefreshed(): bool;
138
139	/**
140	* Returns status whether change of option value initiates refresh event.
141	*
142	* @return bool Status of refresh event.
143	*/
144	public function is_refresh_trigger(): bool;
145
146	/**
147	* Returns subfields of option, if exists.
148	*
149	* @return OptionInterface[] List of option children.
150	*/
151	public function get_children(): array;
152
153	/**
154	* Filters option value from all unsafe strings.
155	*
156	* @param string\|array $field_value Original option value.
157	*
158	* @return string\|array Updated value of option.
159	*/
160	public function sanitize_option_value( $field_value );
161
162	/**
163	* Returns updated settings of field contain values for this option.
164	*
165	* @param array $field_data Original settings of field.
166	* @param array $field_settings Settings of field.
167	*
168	* @return array Updated settings of field.
169	*/
170	public function update_field_data( array $field_data, array $field_settings ): array;
171
172	/**
173	* Returns updated settings of field contain submitted values.
174	*
175	* @param array $field_data Current settings of field.
176	* @param array $field_settings Settings of field.
177	*
178	* @return array Updated settings of field.
179	*/
180	public function save_field_data( array $field_data, array $field_settings ): array;
181	}
182