src/Filter/Field.php line 85

1. <?php
2. namespace App\Filter;
4. use Symfony\Component\HttpFoundation\Request;
6. /**
7.  * Class Field
8.  *
9.  * @package App\Filter
10.  */
11. abstract class Field implements \JsonSerializable {
12.     private $request;
13.     public $values;
15.     /**
16.      * Uri param key name
17.      * @return mixed
18.      */
19.     abstract public function uriParamKey();
21.     /**
22.      * Entity name
23.      * @return mixed
24.      */
25.     abstract public function entityName();
27.     /**
28.      * Condition to compare
29.      * @return mixed
30.      */
31.     abstract public function condition();
33.     /**
34.      * Param Value
35.      * @return mixed
36.      */
37.     abstract public function value();
39.     public function __construct(Request $request){
40.         $this->request = $request;
41.         $this->values = $this->extractValues();
42.     }
44.     /**
45.      * Param value
46.      * @return mixed|null
47.      */
48.     public function singleParamValue(){
49.         return $this->values ?? null;
50.     }
52.     /**
53.      * Entity property name
54.      * @return mixed
55.      */
56.     public function entityProperty(){
57.         return $this->uriParamKey();
58.     }
60.     /**
61.      * Extract values from request
62.      * @return mixed
63.      */
64.     private function extractValues(){
65.         return $this->request->get($this->uriParamKey());
66.     }
68.     /**
69.      * Enforce array for easy check
70.      *
71.      * @return array|mixed
72.      */
73.     private function selectedValues(){
74.         return is_array($this->values) ? $this->values : [$this->values];
75.     }
77.     /**
78.      * Specify data which should be serialized to JSON
79.      *
80.      * @link https://php.net/manual/en/jsonserializable.jsonserialize.php
81.      * @return mixed data which can be serialized by <b>json_encode</b>,
82.      * which is a value of any type other than a resource.
83.      * @since 5.4.0
84.      */
85.     public function jsonSerialize() {
86.         return [
87.             'name' => $this->uriParamKey(),
88.             'value' => $this->value(),
89.         ];
90.     }
91. }