Column.php
116 lines
| 1 | <?php |
| 2 | |
| 3 | namespace IAWP_SCOPED\IAWP\Tables\Columns; |
| 4 | |
| 5 | use IAWP_SCOPED\IAWP\Tables\Groups\Group; |
| 6 | /** @internal */ |
| 7 | class Column |
| 8 | { |
| 9 | private $id; |
| 10 | private $label; |
| 11 | private $visible; |
| 12 | private $type; |
| 13 | private $requires_woocommerce; |
| 14 | private $exportable; |
| 15 | private $options; |
| 16 | private $filter_placeholder; |
| 17 | private $unavailable_for; |
| 18 | private $database_column; |
| 19 | private $is_nullable; |
| 20 | public function __construct($options) |
| 21 | { |
| 22 | $this->id = $options['id']; |
| 23 | $this->label = $options['label']; |
| 24 | $this->visible = $options['visible']; |
| 25 | $this->type = $options['type']; |
| 26 | $this->requires_woocommerce = $options['requires_woocommerce'] ?? \false; |
| 27 | $this->exportable = $options['exportable'] ?? \true; |
| 28 | $this->options = $options['options'] ?? []; |
| 29 | $this->filter_placeholder = $options['filter_placeholder'] ?? ''; |
| 30 | $this->unavailable_for = $options['unavailable_for'] ?? []; |
| 31 | $this->database_column = $options['database_column'] ?? null; |
| 32 | $this->is_nullable = $options['is_nullable'] ?? \false; |
| 33 | } |
| 34 | public function is_enabled_for_group(Group $group) : bool |
| 35 | { |
| 36 | return !\in_array($group->id(), $this->unavailable_for); |
| 37 | } |
| 38 | public function is_group_dependent() : bool |
| 39 | { |
| 40 | return \count($this->unavailable_for) > 0; |
| 41 | } |
| 42 | public function id() : string |
| 43 | { |
| 44 | return $this->id; |
| 45 | } |
| 46 | public function database_column() : string |
| 47 | { |
| 48 | return !\is_null($this->database_column) ? $this->database_column : $this->id; |
| 49 | } |
| 50 | public function label() : string |
| 51 | { |
| 52 | return $this->label; |
| 53 | } |
| 54 | public function visible() : bool |
| 55 | { |
| 56 | return $this->visible; |
| 57 | } |
| 58 | public function type() : string |
| 59 | { |
| 60 | return $this->type; |
| 61 | } |
| 62 | /** |
| 63 | * @return string[] |
| 64 | */ |
| 65 | public function filter_operators() : array |
| 66 | { |
| 67 | switch ($this->type) { |
| 68 | case 'string': |
| 69 | return ['contains', 'exact']; |
| 70 | case 'date': |
| 71 | return ['before', 'after', 'on']; |
| 72 | case 'select': |
| 73 | return ['is', 'isnt']; |
| 74 | default: |
| 75 | // int |
| 76 | return ['greater', 'lesser', 'equal']; |
| 77 | } |
| 78 | } |
| 79 | public function is_valid_filter_operator(string $operator) : bool |
| 80 | { |
| 81 | return \in_array($operator, $this->filter_operators()); |
| 82 | } |
| 83 | public function sort_direction() : string |
| 84 | { |
| 85 | $descending_types = ['int', 'date']; |
| 86 | return \in_array($this->type, $descending_types) ? 'desc' : 'asc'; |
| 87 | } |
| 88 | public function set_visibility(bool $visible) : void |
| 89 | { |
| 90 | $this->visible = $visible; |
| 91 | } |
| 92 | public function requires_woocommerce() : bool |
| 93 | { |
| 94 | return $this->requires_woocommerce; |
| 95 | } |
| 96 | public function exportable() : bool |
| 97 | { |
| 98 | return $this->exportable; |
| 99 | } |
| 100 | /** |
| 101 | * @return array List of possible options for this filter such as a list of authors or list of post categories |
| 102 | */ |
| 103 | public function options() : array |
| 104 | { |
| 105 | return $this->options; |
| 106 | } |
| 107 | public function filter_placeholder() : string |
| 108 | { |
| 109 | return $this->filter_placeholder; |
| 110 | } |
| 111 | public function is_nullable() : bool |
| 112 | { |
| 113 | return $this->is_nullable; |
| 114 | } |
| 115 | } |
| 116 |