← All changes | src/FormAPI/Form/Field.php +130 -143 4.16.0 → 2.17.0 View file →

		@@ -1,166 +1,153 @@
1	1	<?php
2		-
3	2	namespace Give\FormAPI\Form;
4	3
5	4	use Give\Framework\Exceptions\Primitives\InvalidArgumentException;
6	5
7		-abstract class Field
8		-{
	6	+abstract class Field {
9	7
10		- /**
11		- * Field id
12		- *
13		- * @since 2.7.0
14		- * @var string
15		- */
16		- public $id;
	8	+ /**
	9	+ * Field id
	10	+ *
	11	+ * @since 2.7.0
	12	+ * @var string
	13	+ */
	14	+ public $id;
17	15
18		- /**
19		- * Field name
20		- *
21		- * @since 2.7.0
22		- * @var string
23		- */
24		- public $name;
	16	+ /**
	17	+ * Field name
	18	+ *
	19	+ * @since 2.7.0
	20	+ * @var string
	21	+ */
	22	+ public $name;
25	23
26		- /**
27		- * Field description
28		- *
29		- * @since 2.7.0
30		- * @var string
31		- */
32		- public $desc = '';
	24	+ /**
	25	+ * Field description
	26	+ *
	27	+ * @since 2.7.0
	28	+ * @var string
	29	+ */
	30	+ public $desc = '';
33	31
34		- /**
35		- * Field type
36		- *
37		- * @since 2.7.0
38		- * @var string
39		- */
40		- public $type;
	32	+ /**
	33	+ * Field type
	34	+ *
	35	+ * @since 2.7.0
	36	+ * @var string
	37	+ */
	38	+ public $type;
41	39
42		- /**
43		- * Field style
44		- *
45		- * @since 2.7.0
46		- * @var string
47		- */
48		- public $style = '';
	40	+ /**
	41	+ * Field style
	42	+ *
	43	+ * @since 2.7.0
	44	+ * @var string
	45	+ */
	46	+ public $style = '';
49	47
50		- /**
51		- * Field wrapper class.
52		- *
53		- * @since 2.7.0
54		- * @var string
55		- */
56		- public $wrapperClass = '';
	48	+ /**
	49	+ * Field wrapper class.
	50	+ *
	51	+ * @since 2.7.0
	52	+ * @var string
	53	+ */
	54	+ public $wrapperClass = '';
57	55
58		- /**
59		- * Field value.
60		- *
61		- * @since 2.7.0
62		- * @var string
63		- */
64		- public $value = null;
	56	+ /**
	57	+ * Field value.
	58	+ *
	59	+ * @since 2.7.0
	60	+ * @var string
	61	+ */
	62	+ public $value = null;
65	63
66		- /**
67		- * Field default value.
68		- *
69		- * @since 2.7.0
70		- * @var string
71		- */
72		- public $defaultValue = null;
	64	+ /**
	65	+ * Field default value.
	66	+ *
	67	+ * @since 2.7.0
	68	+ * @var string
	69	+ */
	70	+ public $defaultValue = null;
73	71
74		- /**
75		- * Field attributes.
76		- *
77		- * @since 2.7.0
78		- * @var string
79		- */
80		- public $attributes = [];
	72	+ /**
	73	+ * Field attribues.
	74	+ *
	75	+ * @since 2.7.0
	76	+ * @var string
	77	+ */
	78	+ public $attributes = [];
81	79
82		- final public function __construct()
83		- {
84		- }
	80	+ /**
	81	+ * Parse field arguments
	82	+ *
	83	+ * @since 2.7.0
	84	+ * @param array $array
	85	+ * @return mixed
	86	+ */
	87	+ public function parse( $array ) {
	88	+ $this->id = $array['id'];
	89	+ $this->name = $array['name'];
	90	+ $this->type = $array['type'];
	91	+ $this->desc = isset( $array['desc'] ) ? $array['desc'] : '';
	92	+ $this->style = isset( $array['style'] ) ? $array['style'] : '';
	93	+ $this->wrapperClass = isset( $array['wrapper_class'] ) ? $array['wrapper_class'] : '';
	94	+ $this->defaultValue = isset( $array['default'] ) ? $array['default'] : null;
	95	+ $this->value = isset( $array['value'] ) ? $array['value'] : null;
	96	+ $this->attributes = isset( $array['attributes'] ) ? $array['attributes'] : [];
	97	+ }
85	98
86		- /**
87		- * Parse field arguments
88		- *
89		- * @since 2.7.0
90		- *
91		- * @param array $array
92		- *
93		- * @return mixed
94		- */
95		- public function parse($array)
96		- {
97		- $this->id = $array['id'];
98		- $this->name = $array['name'];
99		- $this->type = $array['type'];
100		- $this->desc = isset($array['desc']) ? $array['desc'] : '';
101		- $this->style = isset($array['style']) ? $array['style'] : '';
102		- $this->wrapperClass = isset($array['wrapper_class']) ? $array['wrapper_class'] : '';
103		- $this->defaultValue = isset($array['default']) ? $array['default'] : null;
104		- $this->value = isset($array['value']) ? $array['value'] : null;
105		- $this->attributes = isset($array['attributes']) ? $array['attributes'] : [];
106		- }
107	99
108		- /**
109		- * Get Field object.
110		- *
111		- * @since 2.7.0
112		- *
113		- * @param array $array
114		- *
115		- * @return static
116		- */
117		- public static function fromArray($array)
118		- {
119		- $field = new static();
	100	+ /**
	101	+ * Get Field object.
	102	+ *
	103	+ * @since 2.7.0
	104	+ * @param array $array
	105	+ *
	106	+ * @return static
	107	+ */
	108	+ public static function fromArray( $array ) {
	109	+ $field = new static();
120	110
121		- $field->validate($array);
122		- $field->parse($array);
	111	+ $field->validate( $array );
	112	+ $field->parse( $array );
123	113
124		- return $field;
125		- }
	114	+ return $field;
	115	+ }
126	116
127		- /**
128		- * Validate field arguments
129		- *
130		- * @since 2.7.0
131		- *
132		- * @param $array
133		- */
134		- public function validate($array)
135		- {
136		- $required = ['id', 'name', 'type'];
137		- $array = array_filter($array); // Remove empty values.
138	117
139		- if (array_diff($required, array_keys($array))) {
140		- throw new InvalidArgumentException(
141		- __('To create a TextField object, please provide valid id, name and type.', 'give')
142		- );
143		- }
144		- }
	118	+ /**
	119	+ * Validate field arguments
	120	+ *
	121	+ * @since 2.7.0
	122	+ * @param $array
	123	+ */
	124	+ public function validate( $array ) {
	125	+ $required = [ 'id', 'name', 'type' ];
	126	+ $array = array_filter( $array ); // Remove empty values.
145	127
146		- /**
147		- * Convert field object to array.
148		- *
149		- * @since 2.7.0
150		- * @return array
151		- */
152		- public function toArray()
153		- {
154		- return [
155		- 'id' => $this->id,
156		- 'name' => $this->name,
157		- 'type' => $this->type,
158		- 'desc' => $this->desc,
159		- 'style' => $this->style,
160		- 'wrapper_class' => $this->wrapperClass,
161		- 'value' => $this->value,
162		- 'default' => $this->defaultValue,
163		- 'attributes' => $this->attributes,
164		- ];
165		- }
	128	+ if ( array_diff( $required, array_keys( $array ) ) ) {
	129	+ throw new InvalidArgumentException( __( 'To create a TextField object, please provide valid id, name and type.', 'give' ) );
	130	+ }
	131	+ }
	132	+
	133	+
	134	+ /**
	135	+ * Convert field object to array.
	136	+ *
	137	+ * @since 2.7.0
	138	+ * @return array
	139	+ */
	140	+ public function toArray() {
	141	+ return [
	142	+ 'id' => $this->id,
	143	+ 'name' => $this->name,
	144	+ 'type' => $this->type,
	145	+ 'desc' => $this->desc,
	146	+ 'style' => $this->style,
	147	+ 'wrapper_class' => $this->wrapperClass,
	148	+ 'value' => $this->value,
	149	+ 'default' => $this->defaultValue,
	150	+ 'attributes' => $this->attributes,
	151	+ ];
	152	+ }
166	153	}