Colorpicker.php
6 years ago
Field.php
5 years ago
File.php
6 years ago
Group.php
5 years ago
Media.php
6 years ago
Radio.php
6 years ago
Text.php
6 years ago
Textarea.php
6 years ago
Wysiwyg.php
6 years ago
Field.php
154 lines
| 1 | <?php |
| 2 | namespace Give\FormAPI\Form; |
| 3 | |
| 4 | use Give\Framework\Exceptions\Primitives\InvalidArgumentException; |
| 5 | |
| 6 | abstract class Field { |
| 7 | |
| 8 | /** |
| 9 | * Field id |
| 10 | * |
| 11 | * @since 2.7.0 |
| 12 | * @var string |
| 13 | */ |
| 14 | public $id; |
| 15 | |
| 16 | /** |
| 17 | * Field name |
| 18 | * |
| 19 | * @since 2.7.0 |
| 20 | * @var string |
| 21 | */ |
| 22 | public $name; |
| 23 | |
| 24 | /** |
| 25 | * Field description |
| 26 | * |
| 27 | * @since 2.7.0 |
| 28 | * @var string |
| 29 | */ |
| 30 | public $desc = ''; |
| 31 | |
| 32 | /** |
| 33 | * Field type |
| 34 | * |
| 35 | * @since 2.7.0 |
| 36 | * @var string |
| 37 | */ |
| 38 | public $type; |
| 39 | |
| 40 | /** |
| 41 | * Field style |
| 42 | * |
| 43 | * @since 2.7.0 |
| 44 | * @var string |
| 45 | */ |
| 46 | public $style = ''; |
| 47 | |
| 48 | /** |
| 49 | * Field wrapper class. |
| 50 | * |
| 51 | * @since 2.7.0 |
| 52 | * @var string |
| 53 | */ |
| 54 | public $wrapperClass = ''; |
| 55 | |
| 56 | /** |
| 57 | * Field value. |
| 58 | * |
| 59 | * @since 2.7.0 |
| 60 | * @var string |
| 61 | */ |
| 62 | public $value = null; |
| 63 | |
| 64 | /** |
| 65 | * Field default value. |
| 66 | * |
| 67 | * @since 2.7.0 |
| 68 | * @var string |
| 69 | */ |
| 70 | public $defaultValue = null; |
| 71 | |
| 72 | /** |
| 73 | * Field attribues. |
| 74 | * |
| 75 | * @since 2.7.0 |
| 76 | * @var string |
| 77 | */ |
| 78 | public $attributes = []; |
| 79 | |
| 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 | } |
| 98 | |
| 99 | |
| 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(); |
| 110 | |
| 111 | $field->validate( $array ); |
| 112 | $field->parse( $array ); |
| 113 | |
| 114 | return $field; |
| 115 | } |
| 116 | |
| 117 | |
| 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. |
| 127 | |
| 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 | } |
| 153 | } |
| 154 |