xref: /plugin/struct/meta/UserColumn.php (revision a0b3799e3857209811ed06eddf7c60cec2980a26)
1<?php
2
3namespace dokuwiki\plugin\struct\meta;
4
5use dokuwiki\plugin\struct\types\User;
6
7/**
8 * Class UserColumn
9 *
10 * Just like a column, but does not reference one of the col* data columns but the lasteditor column in the titles table.
11 *
12 * @package dokuwiki\plugin\struct\meta
13 */
14class UserColumn extends Column {
15
16    /**
17     * PageColumn constructor.
18     *
19     * @param int $sort
20     * @param User $type
21     * @param string $table
22     */
23    public function __construct($sort, User $type, $table='') {
24        if($type->isMulti()) throw new StructException('UserColumns can not be multi value types!');
25        parent::__construct($sort, $type, 0, true, $table);
26        $this->getType()->setContext($this);
27    }
28
29    public function getColref() {
30        throw new StructException('Accessing the colref of a UserColumn makes no sense');
31    }
32
33    /**
34     * @param bool $enforceSingleColumn ignored
35     * @return string
36     */
37    public function getColName($enforceSingleColumn = true) {
38        return 'lasteditor';
39    }
40
41    /**
42     * @param bool $enforceSingleColumn ignored
43     * @return string
44     */
45    public function getFullColName($enforceSingleColumn = true) {
46        $col = 'titles.'.$this->getColName($enforceSingleColumn);
47        return $col;
48    }
49
50    /**
51     * @return string always '%lasteditor%'
52     */
53    public function getLabel() {
54        return '%lasteditor%';
55    }
56
57    /**
58     * @return string always '%lasteditor%'
59     */
60    public function getFullQualifiedLabel() {
61        // There is only one pageid for each row because we JOIN on it
62        // so we do not prefix it with the table
63        return $this->getLabel();
64    }
65
66    /**
67     * @return string preconfigured label
68     */
69    public function getTranslatedLabel() {
70        /** @var \helper_plugin_struct_config $helper */
71        $helper = plugin_load('helper', 'struct_config');
72        return $helper->getLang('userlabel');
73    }
74
75}
76