Field
1 week ago
Form
1 week ago
Persistence
1 week ago
Renderer
1 week ago
Resolver
1 week ago
Sanitizer
1 week ago
Serializer
1 week ago
Validator
1 week ago
ContainerForm.php
1 week ago
Escaper.php
1 week ago
Field.php
1 week ago
FieldProvider.php
1 week ago
FieldRenderer.php
1 week ago
FieldsDataReceiver.php
1 week ago
Form.php
1 week ago
Sanitizer.php
1 week ago
Serializer.php
1 week ago
Validator.php
1 week ago
Field.php
135 lines
| 1 | <?php |
| 2 | |
| 3 | namespace FSVendor\WPDesk\Forms; |
| 4 | |
| 5 | use FSVendor\WPDesk\Forms\Field\BasicField; |
| 6 | /** |
| 7 | * The idea is that from the moment the factory returns this interface it's values cannot be changed. |
| 8 | * And that is why here are only the getters. |
| 9 | * |
| 10 | * The: Validation, Serialization, Sanitization features are provided trough delegated classes (get_validator, get_serializer ...) |
| 11 | * |
| 12 | * @package WPDesk\Forms |
| 13 | */ |
| 14 | interface Field |
| 15 | { |
| 16 | /** @return string */ |
| 17 | public function get_name(); |
| 18 | /** @return mixed */ |
| 19 | public function get_default_value(); |
| 20 | /** @return string */ |
| 21 | public function get_template_name(); |
| 22 | /** |
| 23 | * When this field is used on form this field will force it's own template. |
| 24 | * |
| 25 | * return bool |
| 26 | */ |
| 27 | public function should_override_form_template(); |
| 28 | /** |
| 29 | * HTML label. |
| 30 | * |
| 31 | * @return string |
| 32 | */ |
| 33 | public function get_label(); |
| 34 | /** bool */ |
| 35 | public function has_label(); |
| 36 | /** |
| 37 | * Description for field. It can be shown near the field. |
| 38 | * |
| 39 | * @return string |
| 40 | */ |
| 41 | public function get_description(); |
| 42 | /** |
| 43 | * Additional field description that should be shown in optional hover tip. |
| 44 | * |
| 45 | * @return string |
| 46 | */ |
| 47 | public function get_description_tip(); |
| 48 | /** @return bool */ |
| 49 | public function has_description_tip(); |
| 50 | /** @return bool */ |
| 51 | public function has_description(); |
| 52 | /** |
| 53 | * @return bool |
| 54 | */ |
| 55 | public function is_readonly(); |
| 56 | /** @return bool */ |
| 57 | public function is_disabled(); |
| 58 | /** @return string */ |
| 59 | public function get_id(); |
| 60 | /** @bool */ |
| 61 | public function is_required(); |
| 62 | /** @return bool */ |
| 63 | public function has_placeholder(); |
| 64 | /** @return string */ |
| 65 | public function get_placeholder(); |
| 66 | /** |
| 67 | * @param string[] $except |
| 68 | * |
| 69 | * @return string[] name->value |
| 70 | */ |
| 71 | public function get_attributes($except = []); |
| 72 | /** |
| 73 | * @param string $name |
| 74 | * @param string $default |
| 75 | * |
| 76 | * @return string |
| 77 | */ |
| 78 | public function get_attribute($name, $default = null); |
| 79 | /** @return bool */ |
| 80 | public function is_attribute_set($name); |
| 81 | /** |
| 82 | * @param string $name |
| 83 | * |
| 84 | * @return string |
| 85 | */ |
| 86 | public function get_meta_value($name); |
| 87 | /** @return bool */ |
| 88 | public function is_meta_value_set($name); |
| 89 | /** |
| 90 | * @return string |
| 91 | */ |
| 92 | public function get_classes(); |
| 93 | /** bool */ |
| 94 | public function has_classes(); |
| 95 | /** @return bool */ |
| 96 | public function is_class_set($name); |
| 97 | /** bool */ |
| 98 | public function has_data(); |
| 99 | /** |
| 100 | * @return array |
| 101 | */ |
| 102 | public function get_data(); |
| 103 | /** |
| 104 | * @param string $data_name |
| 105 | * @param string $data_value |
| 106 | * |
| 107 | * @return $this |
| 108 | */ |
| 109 | public function add_data($data_name, $data_value); |
| 110 | /** |
| 111 | * @param string $data_name |
| 112 | * |
| 113 | * @return $this |
| 114 | */ |
| 115 | public function unset_data($data_name); |
| 116 | /** |
| 117 | * @return mixed |
| 118 | */ |
| 119 | public function get_possible_values(); |
| 120 | /** |
| 121 | * @return bool |
| 122 | */ |
| 123 | public function is_multiple(); |
| 124 | /** |
| 125 | * @return Validator |
| 126 | */ |
| 127 | public function get_validator(); |
| 128 | /** |
| 129 | * @return Sanitizer |
| 130 | */ |
| 131 | public function get_sanitizer(); |
| 132 | /** @return Serializer */ |
| 133 | public function get_serializer(); |
| 134 | } |
| 135 |