xref: /plugin/struct/meta/PageColumn.php (revision cc129a41a779bce93843a6136effc63582ed87cc) 
1<?php
2
3namespace dokuwiki\plugin\struct\meta;
4
5use dokuwiki\plugin\struct\types\AbstractBaseType;
6
7/**
8 * Class PageColumn
9 *
10 * Just like a column, but does not reference one of the col* data columns but the pid column.
11 *
12 * @package dokuwiki\plugin\struct\meta
13 */
14class PageColumn extends Column {
15
16    /**
17     * PageColumn constructor.
18     *
19     * @param int $sort
20     * @param AbstractBaseType $type This should be Page or Title
21     * @param string $table
22     */
23    public function __construct($sort, AbstractBaseType $type, $table='') {
24        if($type->isMulti()) throw new StructException('PageColumns can not be multi value types!');
25        parent::__construct($sort, $type, 0, true, $table);
26    }
27
28    public function getColref() {
29        throw new StructException('Accessing the colref of a PageColumn makes no sense');
30    }
31
32    /**
33     * @return string
34     */
35    public function getColName() {
36        $col = 'pid';
37        if($this->table) $col = 'data_'.$this->table.'.'.$col;
38        return $col;
39    }
40
41    /**
42     * @return string always '%pageid%'
43     */
44    public function getLabel() {
45        return '%pageid%';
46    }
47
48    /**
49     * @return string always '%pageid%'
50     */
51    public function getFullQualifiedLabel() {
52        // There is only one pageid for each row because we JOIN on it
53        // so we do not prefix it with the table
54        return '%pageid%';
55    }
56
57}
58