xref: /plugin/struct/meta/PageColumn.php (revision db7315f6e706af01b3fbe5f63ef0a8a410fd8cf4)
10561158fSAndreas Gohr<?php
20561158fSAndreas Gohr
3ba766201SAndreas Gohrnamespace dokuwiki\plugin\struct\meta;
40561158fSAndreas Gohr
5ba766201SAndreas Gohruse dokuwiki\plugin\struct\types\AbstractBaseType;
60561158fSAndreas Gohr
70561158fSAndreas Gohr/**
80561158fSAndreas Gohr * Class PageColumn
90561158fSAndreas Gohr *
100561158fSAndreas Gohr * Just like a column, but does not reference one of the col* data columns but the pid column.
110561158fSAndreas Gohr *
12ba766201SAndreas Gohr * @package dokuwiki\plugin\struct\meta
130561158fSAndreas Gohr */
140561158fSAndreas Gohrclass PageColumn extends Column {
150561158fSAndreas Gohr
160561158fSAndreas Gohr    /**
170561158fSAndreas Gohr     * PageColumn constructor.
180561158fSAndreas Gohr     *
190561158fSAndreas Gohr     * @param int $sort
200561158fSAndreas Gohr     * @param AbstractBaseType $type This should be Page or Title
210561158fSAndreas Gohr     * @param string $table
220561158fSAndreas Gohr     */
230561158fSAndreas Gohr    public function __construct($sort, AbstractBaseType $type, $table='') {
245b2d2a8cSAndreas Gohr        if($type->isMulti()) throw new StructException('PageColumns can not be multi value types!');
250561158fSAndreas Gohr        parent::__construct($sort, $type, 0, true, $table);
260561158fSAndreas Gohr    }
270561158fSAndreas Gohr
280561158fSAndreas Gohr    public function getColref() {
290561158fSAndreas Gohr        throw new StructException('Accessing the colref of a PageColumn makes no sense');
300561158fSAndreas Gohr    }
310561158fSAndreas Gohr
32d1b04e89SAndreas Gohr    /**
33066fcfb7SMichael Grosse     * @param bool $forceSingleColumn ignored
34d1b04e89SAndreas Gohr     * @return string
35d1b04e89SAndreas Gohr     */
36066fcfb7SMichael Grosse    public function getColName($forceSingleColumn = true) {
3727f6439fSAndreas Gohr        return 'pid';
3827f6439fSAndreas Gohr    }
3927f6439fSAndreas Gohr
4027f6439fSAndreas Gohr    /**
4127f6439fSAndreas Gohr     * @param bool $forceSingleColumn ignored
4227f6439fSAndreas Gohr     * @return string
4327f6439fSAndreas Gohr     */
4427f6439fSAndreas Gohr    public function getFullColName($forceSingleColumn = true) {
4527f6439fSAndreas Gohr        $col = $this->getColName($forceSingleColumn);
465b2d2a8cSAndreas Gohr        if($this->table) $col = 'data_'.$this->table.'.'.$col;
47d1b04e89SAndreas Gohr        return $col;
48d1b04e89SAndreas Gohr    }
49d1b04e89SAndreas Gohr
509447008bSAndreas Gohr    /**
519447008bSAndreas Gohr     * @return string always '%pageid%'
529447008bSAndreas Gohr     */
539447008bSAndreas Gohr    public function getLabel() {
54*db7315f6SAndreas Gohr        $conf = $this->getType()->getConfig();
55*db7315f6SAndreas Gohr        if($conf['usetitles']) {
56*db7315f6SAndreas Gohr            return '%title%';
57*db7315f6SAndreas Gohr        } else {
589447008bSAndreas Gohr            return '%pageid%';
599447008bSAndreas Gohr        }
60*db7315f6SAndreas Gohr    }
619447008bSAndreas Gohr
62c74e0e40SAndreas Gohr    /**
63c74e0e40SAndreas Gohr     * @return string always '%pageid%'
64c74e0e40SAndreas Gohr     */
65c74e0e40SAndreas Gohr    public function getFullQualifiedLabel() {
66c74e0e40SAndreas Gohr        // There is only one pageid for each row because we JOIN on it
67c74e0e40SAndreas Gohr        // so we do not prefix it with the table
68*db7315f6SAndreas Gohr        return $this->getLabel();
69c74e0e40SAndreas Gohr    }
70c74e0e40SAndreas Gohr
710561158fSAndreas Gohr}
72