xref: /plugin/struct/meta/AccessTablePage.php (revision 659863b45d8a74a59fefc4b46132e0006d7a63b6) 
1<?php
2
3namespace dokuwiki\plugin\struct\meta;
4
5/**
6 * Class AccessTableData
7 * @package dokuwiki\plugin\struct\meta
8 *
9 * This class is for accessing the data stored for a page in a schema
10 *
11 */
12class AccessTablePage extends AccessTable
13{
14    public const DEFAULT_PAGE_RID = 0;
15
16    public function __construct($schema, $pid, $ts = 0, $rid = 0)
17    {
18        $ts = $ts ?: time();
19        parent::__construct($schema, $pid, $ts, $rid);
20    }
21
22    /**
23     * adds an empty data set for this schema and page
24     *
25     * This is basically a delete for the schema fields of a page
26     *
27     * @return bool
28     */
29    public function clearData()
30    {
31        $data = array();
32
33        foreach ($this->schema->getColumns() as $col) {
34            if ($col->isMulti()) {
35                $data[$col->getLabel()] = array();
36            } else {
37                $data[$col->getLabel()] = null;
38            }
39        }
40
41        return $this->saveData($data);
42    }
43
44    /**
45     * @return int|bool
46     */
47    protected function getLastRevisionTimestamp()
48    {
49        $table = 'data_' . $this->schema->getTable();
50        $where = "WHERE pid = ?";
51        $opts = [$this->pid];
52        if ($this->ts) {
53            $where .= " AND REV > 0 AND rev <= ?";
54            $opts[] = $this->ts;
55        }
56
57        /** @noinspection SqlResolve */
58        $sql = "SELECT rev FROM $table $where ORDER BY rev DESC LIMIT 1";
59        $res = $this->sqlite->query($sql, $opts);
60        $ret = $this->sqlite->res2single($res);
61        $this->sqlite->res_close($res);
62        // make sure we don't cast empty result to 0 (serial data has rev = 0)
63        if ($ret !== false) $ret = (int)$ret;
64        return $ret;
65    }
66
67    /**
68     * @inheritDoc
69     */
70    protected function validateTypeData($data)
71    {
72        if ($this->ts == 0) {
73            throw new StructException("Saving with zero timestamp does not work.");
74        }
75        return true;
76    }
77
78    /**
79     * Remove latest status from previous page data
80     */
81    protected function beforeSave()
82    {
83        /** @noinspection SqlResolve */
84        $ok = $this->sqlite->query(
85            "UPDATE $this->stable SET latest = 0 WHERE latest = 1 AND pid = ? AND rid = 0",
86            [$this->pid]
87        );
88        /** @noinspection SqlResolve */
89        return $ok && $this->sqlite->query(
90            "UPDATE $this->mtable SET latest = 0 WHERE latest = 1 AND pid = ? AND rid = 0",
91            [$this->pid]
92        );
93    }
94
95    /**
96     * Names of non-input columns to be inserted into SQL query.
97     * Field 'published' is skipped because only plugins use it and
98     * we don't want to interfere with the default NULL value
99     */
100    protected function getSingleNoninputCols()
101    {
102        return ['rid, pid, rev, latest'];
103    }
104
105    /**
106     * @inheritDoc
107     */
108    protected function getSingleNoninputValues()
109    {
110        return [self::DEFAULT_PAGE_RID, $this->pid, $this->ts, 1];
111    }
112
113    /**
114     * @inheritDoc
115     */
116    protected function getMultiSql()
117    {
118        /** @noinspection SqlResolve */
119        return "INSERT INTO $this->mtable (latest, rev, pid, rid, colref, row, value) VALUES (?,?,?,?,?,?,?)";
120    }
121
122    /**
123     * @inheritDoc
124     */
125    protected function getMultiNoninputValues()
126    {
127        return [AccessTable::DEFAULT_LATEST, $this->ts, $this->pid, self::DEFAULT_PAGE_RID];
128    }
129}
130