xref: /plugin/struct/meta/AccessDataValidator.php (revision 025cb9da4274aac00be48202c8eb49058f2dd283)
193ca6f4fSAndreas Gohr<?php
293ca6f4fSAndreas Gohr
393ca6f4fSAndreas Gohrnamespace dokuwiki\plugin\struct\meta;
493ca6f4fSAndreas Gohr
593ca6f4fSAndreas Gohr/**
693ca6f4fSAndreas Gohr * Validate the data for a whole schema
793ca6f4fSAndreas Gohr *
893ca6f4fSAndreas Gohr * Should be aquired through AccessDataTable::getValidator()
993ca6f4fSAndreas Gohr */
1093ca6f4fSAndreas Gohrclass AccessDataValidator extends ValueValidator {
1193ca6f4fSAndreas Gohr
1293ca6f4fSAndreas Gohr    /** @var AccessTable */
1393ca6f4fSAndreas Gohr    protected $access;
1493ca6f4fSAndreas Gohr
1593ca6f4fSAndreas Gohr    /** @var array */
1693ca6f4fSAndreas Gohr    protected $data;
1793ca6f4fSAndreas Gohr
1893ca6f4fSAndreas Gohr    /**
1993ca6f4fSAndreas Gohr     * ValidationResult constructor.
2093ca6f4fSAndreas Gohr     * @param AccessTable $access
2193ca6f4fSAndreas Gohr     * @param array $data the data to validate (and save)
2293ca6f4fSAndreas Gohr     */
2393ca6f4fSAndreas Gohr    public function __construct(AccessTable $access, $data) {
2493ca6f4fSAndreas Gohr        parent::__construct();
2593ca6f4fSAndreas Gohr        $this->access = $access;
2693ca6f4fSAndreas Gohr        $this->data = $data;
2793ca6f4fSAndreas Gohr    }
2893ca6f4fSAndreas Gohr
2993ca6f4fSAndreas Gohr    /**
3093ca6f4fSAndreas Gohr     * Validate the given data
3193ca6f4fSAndreas Gohr     *
3293ca6f4fSAndreas Gohr     * checks for assignments
3393ca6f4fSAndreas Gohr     * validates
3493ca6f4fSAndreas Gohr     * returns changed data only
3593ca6f4fSAndreas Gohr     *
3693ca6f4fSAndreas Gohr     * @param array $data array('schema' => ( 'fieldlabel' => 'value', ...))
3793ca6f4fSAndreas Gohr     * @param string $pageid
3893ca6f4fSAndreas Gohr     * @param string[] $errors validation errors
3993ca6f4fSAndreas Gohr     * @return AccessDataValidator[]|bool savable data or false on validation error
4093ca6f4fSAndreas Gohr     */
4193ca6f4fSAndreas Gohr    static public function validateDataForPage($data, $pageid, &$errors) {
4293ca6f4fSAndreas Gohr        $tosave = array();
4393ca6f4fSAndreas Gohr        $valid = true;
4493ca6f4fSAndreas Gohr        $errors = array();
4593ca6f4fSAndreas Gohr
46*025cb9daSAndreas Gohr        $assignments = Assignments::getInstance();
4793ca6f4fSAndreas Gohr        $tables = $assignments->getPageAssignments($pageid);
4893ca6f4fSAndreas Gohr        foreach($tables as $table) {
4993ca6f4fSAndreas Gohr            $access = AccessTable::byTableName($table, $pageid);
5093ca6f4fSAndreas Gohr            $validation = $access->getValidator($data[$table]);
5193ca6f4fSAndreas Gohr            if(!$validation->validate()) {
5293ca6f4fSAndreas Gohr                $valid = false;
5393ca6f4fSAndreas Gohr                $errors = array_merge($errors, $validation->getErrors());
5493ca6f4fSAndreas Gohr            } else {
5593ca6f4fSAndreas Gohr                if($validation->hasChanges()) {
5693ca6f4fSAndreas Gohr                    $tosave[] = $validation;
5793ca6f4fSAndreas Gohr                }
5893ca6f4fSAndreas Gohr            }
5993ca6f4fSAndreas Gohr        }
6093ca6f4fSAndreas Gohr        if($valid) return $tosave;
6193ca6f4fSAndreas Gohr        return false;
6293ca6f4fSAndreas Gohr    }
6393ca6f4fSAndreas Gohr
6493ca6f4fSAndreas Gohr    /**
6593ca6f4fSAndreas Gohr     * Validate the data. This will clean the data according to type!
6693ca6f4fSAndreas Gohr     *
6793ca6f4fSAndreas Gohr     * @return bool
6893ca6f4fSAndreas Gohr     */
6993ca6f4fSAndreas Gohr    public function validate() {
7093ca6f4fSAndreas Gohr        $result = true;
7193ca6f4fSAndreas Gohr        foreach($this->access->getSchema()->getColumns() as $col) {
7293ca6f4fSAndreas Gohr            $label = $col->getType()->getLabel();
7393ca6f4fSAndreas Gohr            $result = $result && $this->validateValue($col, $this->data[$label]);
7493ca6f4fSAndreas Gohr        }
7593ca6f4fSAndreas Gohr        return $result;
7693ca6f4fSAndreas Gohr    }
7793ca6f4fSAndreas Gohr
7893ca6f4fSAndreas Gohr    /**
7993ca6f4fSAndreas Gohr     * Check if the data changed (selects current data)
8093ca6f4fSAndreas Gohr     *
8193ca6f4fSAndreas Gohr     * @return bool
8293ca6f4fSAndreas Gohr     */
8393ca6f4fSAndreas Gohr    public function hasChanges() {
8493ca6f4fSAndreas Gohr        $olddata = $this->access->getDataArray();
8593ca6f4fSAndreas Gohr        return ($olddata != $this->data);
8693ca6f4fSAndreas Gohr    }
8793ca6f4fSAndreas Gohr
8893ca6f4fSAndreas Gohr    /**
8993ca6f4fSAndreas Gohr     * @return AccessTable
9093ca6f4fSAndreas Gohr     */
9193ca6f4fSAndreas Gohr    public function getAccessTable() {
9293ca6f4fSAndreas Gohr        return $this->access;
9393ca6f4fSAndreas Gohr    }
9493ca6f4fSAndreas Gohr
9593ca6f4fSAndreas Gohr    /**
9693ca6f4fSAndreas Gohr     * Access the data after it has been cleand in the validation process
9793ca6f4fSAndreas Gohr     *
9893ca6f4fSAndreas Gohr     * @return array
9993ca6f4fSAndreas Gohr     */
10093ca6f4fSAndreas Gohr    public function getCleanData() {
10193ca6f4fSAndreas Gohr        return $this->data;
10293ca6f4fSAndreas Gohr    }
10393ca6f4fSAndreas Gohr
10493ca6f4fSAndreas Gohr    /**
10593ca6f4fSAndreas Gohr     * Saves the data
10693ca6f4fSAndreas Gohr     *
10793ca6f4fSAndreas Gohr     * This saves no matter what. You have to chcek validation results and changes on your own!
10893ca6f4fSAndreas Gohr     *
10993ca6f4fSAndreas Gohr     * @param int $ts the timestamp to use when saving the data
11093ca6f4fSAndreas Gohr     * @return bool
11193ca6f4fSAndreas Gohr     */
11293ca6f4fSAndreas Gohr    public function saveData($ts = 0) {
11393ca6f4fSAndreas Gohr        $this->access->setTimestamp($ts);
11493ca6f4fSAndreas Gohr        return $this->access->saveData($this->data);
11593ca6f4fSAndreas Gohr    }
11693ca6f4fSAndreas Gohr
11793ca6f4fSAndreas Gohr}
118