xref: /plugin/bez/mdl/Entity.php (revision a0cd8c785f18b483f73582b411767428d04a78f6)
1de02284cSSzymon Olewniczak<?php
2de02284cSSzymon Olewniczak
3de02284cSSzymon Olewniczaknamespace dokuwiki\plugin\bez\mdl;
4de02284cSSzymon Olewniczak/*
5de02284cSSzymon Olewniczak * All fields are stored in object as strings.
6de02284cSSzymon Olewniczak * NULLs are converted to empty string.
7de02284cSSzymon Olewniczak * If any attribute in object === NULL -> it means that it was not initialized
8de02284cSSzymon Olewniczak * But we always inserts NULLs instead of empty strings.
9de02284cSSzymon Olewniczak * https://stackoverflow.com/questions/1267999/mysql-better-to-insert-null-or-empty-string
10de02284cSSzymon Olewniczak **/
11de02284cSSzymon Olewniczak
12de02284cSSzymon Olewniczakuse dokuwiki\plugin\bez\meta\PermissionDeniedException;
138a638198SSzymon Olewniczakuse dokuwiki\plugin\bez\meta\ValidationException;
14de02284cSSzymon Olewniczak
15*a0cd8c78SSzymon Olewniczakabstract class Entity {
16de02284cSSzymon Olewniczak
17de02284cSSzymon Olewniczak    /** @var  Model */
18de02284cSSzymon Olewniczak    protected $model;
19de02284cSSzymon Olewniczak
20de02284cSSzymon Olewniczak    /** @var Validator */
21de02284cSSzymon Olewniczak    protected $validator;
22de02284cSSzymon Olewniczak
23*a0cd8c78SSzymon Olewniczak    /** @var Acl */
24*a0cd8c78SSzymon Olewniczak    protected $acl;
25*a0cd8c78SSzymon Olewniczak
26de02284cSSzymon Olewniczak	abstract public static function get_columns();
27de02284cSSzymon Olewniczak
287fbf4c39SSzymon Olewniczak	public static function get_select_columns() {
297fbf4c39SSzymon Olewniczak        $class = get_called_class();
307fbf4c39SSzymon Olewniczak	    return $class::get_columns();
317fbf4c39SSzymon Olewniczak    }
327fbf4c39SSzymon Olewniczak
33de02284cSSzymon Olewniczak	public function get_assoc($filter=NULL) {
34de02284cSSzymon Olewniczak		$assoc = array();
35de02284cSSzymon Olewniczak
367fbf4c39SSzymon Olewniczak        $columns = $this->get_select_columns();
37de02284cSSzymon Olewniczak        if ($filter !== NULL) {
38de02284cSSzymon Olewniczak            $columns = array_intersect($columns, $filter);
39de02284cSSzymon Olewniczak        }
40de02284cSSzymon Olewniczak
41de02284cSSzymon Olewniczak		foreach ($columns as $col) {
42de02284cSSzymon Olewniczak			$assoc[$col] = $this->$col;
43de02284cSSzymon Olewniczak		}
44de02284cSSzymon Olewniczak		return $assoc;
45de02284cSSzymon Olewniczak	}
46de02284cSSzymon Olewniczak
47de02284cSSzymon Olewniczak    public function get_table_name() {
48de02284cSSzymon Olewniczak        $class = (new \ReflectionClass($this))->getShortName();
49de02284cSSzymon Olewniczak		return lcfirst($class);
50de02284cSSzymon Olewniczak	}
51de02284cSSzymon Olewniczak
52de02284cSSzymon Olewniczak	public function __get($property) {
53de02284cSSzymon Olewniczak        if (!property_exists($this, $property) || !in_array($property, $this->get_columns())) {
54de02284cSSzymon Olewniczak            throw new \Exception('there is no column: "'.$property. '"" in table: "' . $this->get_table_name() . '"');
55de02284cSSzymon Olewniczak        }
56de02284cSSzymon Olewniczak
57*a0cd8c78SSzymon Olewniczak        //it slows down the execution and must be solved diffirently
5820e189b9SSzymon Olewniczak//        if ($this->acl_of($property) < BEZ_PERMISSION_VIEW) {
5920e189b9SSzymon Olewniczak//            throw new PermissionDeniedException();
6020e189b9SSzymon Olewniczak//        }
61de02284cSSzymon Olewniczak
62de02284cSSzymon Olewniczak        return $this->$property;
63de02284cSSzymon Olewniczak
64de02284cSSzymon Olewniczak	}
65de02284cSSzymon Olewniczak
66de02284cSSzymon Olewniczak    protected function set_property($property, $value) {
67*a0cd8c78SSzymon Olewniczak        if ($this->acl_of($property) < BEZ_PERMISSION_CHANGE) {
68*a0cd8c78SSzymon Olewniczak            throw new PermissionDeniedException("cannot change field $property");
69de02284cSSzymon Olewniczak        }
70de02284cSSzymon Olewniczak        $this->$property = $value;
71de02284cSSzymon Olewniczak    }
72de02284cSSzymon Olewniczak
73de02284cSSzymon Olewniczak    protected function set_property_array($array) {
74de02284cSSzymon Olewniczak        foreach ($array as $k => $v) {
75de02284cSSzymon Olewniczak            $this->set_property($k, $v);
76de02284cSSzymon Olewniczak        }
77de02284cSSzymon Olewniczak    }
78de02284cSSzymon Olewniczak
79de02284cSSzymon Olewniczak    public function set_data($post) {
80de02284cSSzymon Olewniczak        $val_data = $this->validator->validate($post);
81de02284cSSzymon Olewniczak		if ($val_data === false) {
82de02284cSSzymon Olewniczak			throw new ValidationException($this->get_table_name(), $this->validator->get_errors());
83de02284cSSzymon Olewniczak		}
84de02284cSSzymon Olewniczak
85de02284cSSzymon Olewniczak		$this->set_property_array($val_data);
86de02284cSSzymon Olewniczak    }
87de02284cSSzymon Olewniczak
887fbf4c39SSzymon Olewniczak    public function changable_fields($filter=NULL) {
89*a0cd8c78SSzymon Olewniczak       $fields = $this->acl->get_list();
907fbf4c39SSzymon Olewniczak
917fbf4c39SSzymon Olewniczak       if ($filter !== NULL) {
927fbf4c39SSzymon Olewniczak           $fields = array_filter($fields, function ($k) use ($filter) {
937fbf4c39SSzymon Olewniczak                return in_array($k, $filter);
947fbf4c39SSzymon Olewniczak           }, ARRAY_FILTER_USE_KEY);
957fbf4c39SSzymon Olewniczak       }
967fbf4c39SSzymon Olewniczak
977fbf4c39SSzymon Olewniczak       return array_keys(array_filter($fields, function ($var) {
987fbf4c39SSzymon Olewniczak           return $var >= BEZ_PERMISSION_CHANGE;
997fbf4c39SSzymon Olewniczak       }));
1007fbf4c39SSzymon Olewniczak    }
101de02284cSSzymon Olewniczak
10253df74e7SSzymon Olewniczak    public function can_be_null($field) {
10353df74e7SSzymon Olewniczak	    $rule = $this->validator->get_rule($field);
10453df74e7SSzymon Olewniczak	    $null = $rule[1];
10553df74e7SSzymon Olewniczak	    if (strtolower($null) == 'null') {
10653df74e7SSzymon Olewniczak	        return true;
10753df74e7SSzymon Olewniczak        }
10853df74e7SSzymon Olewniczak
10953df74e7SSzymon Olewniczak        return false;
11053df74e7SSzymon Olewniczak    }
111de02284cSSzymon Olewniczak
112de02284cSSzymon Olewniczak    public function __construct($model) {
113de02284cSSzymon Olewniczak        $this->model = $model;
114de02284cSSzymon Olewniczak        $this->validator = new Validator($this->model);
115*a0cd8c78SSzymon Olewniczak
116*a0cd8c78SSzymon Olewniczak        $this->acl = new Acl($this->model->get_level(), $this->get_select_columns());
117de02284cSSzymon Olewniczak    }
118*a0cd8c78SSzymon Olewniczak
119*a0cd8c78SSzymon Olewniczak    public function acl_of($field) {
120*a0cd8c78SSzymon Olewniczak        return $this->acl->acl_of($field);
121*a0cd8c78SSzymon Olewniczak    }
122*a0cd8c78SSzymon Olewniczak
123de02284cSSzymon Olewniczak}
124