xref: /plugin/struct/meta/Column.php (revision ba662a609884bbbecde8cffec91014be306b652b)

<?php

namespace dokuwiki\plugin\struct\meta;

use dokuwiki\Extension\Event;
use dokuwiki\plugin\struct\types\AbstractBaseType;

/**
 * Class Column
 *
 * This represents a single column within a schema and contains the configured BaseType as well as the
 * column reference to the data table.
 *
 * It basically combines the information how a column's content behaves (as defines in the BaseType and its
 * configuration) with where to find that content and adds some basic meta data (like sort or enabled)
 *
 * @package dokuwiki\plugin\struct\meta
 */
class Column
{
    /** @var int fields are sorted by this value */
    protected $sort;
    /** @var AbstractBaseType the type of this column */
    protected $type;
    /** @var int the column in the datatable. columns count from 1 */
    protected $colref;
    /** @var bool is this column still enabled? */
    protected $enabled = true;
    /** @var  string backreference to the table this column is part of */
    protected $table;

    /**
     * Column constructor.
     * @param int $sort
     * @param AbstractBaseType $type
     * @param int $colref
     * @param bool $enabled
     * @param string $table
     */
    public function __construct($sort, AbstractBaseType $type, $colref = 0, $enabled = true, $table = '')
    {
        $this->sort = (int)$sort;
        $this->type = $type;
        $this->colref = (int)$colref;
        $this->enabled = (bool)$enabled;
        $this->table = $table;
    }

    /**
     * @return int
     */
    public function getSort()
    {
        return $this->sort;
    }

    /**
     * @return int
     */
    public function getTid()
    {
        return $this->type->getTid();
    }

    /**
     * @return string
     */
    public function getLabel()
    {
        return $this->type->getLabel();
    }

    /**
     * @return string the label prepended with the table name
     */
    public function getFullQualifiedLabel()
    {
        if (!$this->table) throw new StructException('No table set for this column');
        return $this->table . '.' . $this->getLabel();
    }

    /**
     * @return string
     */
    public function getTranslatedLabel()
    {
        return $this->type->getTranslatedLabel();
    }

    /**
     * @return string
     */
    public function getTranslatedHint()
    {
        return $this->type->getTranslatedHint();
    }

    /**
     * @return AbstractBaseType
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * @return int
     */
    public function getColref()
    {
        return $this->colref;
    }

    /**
     * Returns the column name (without a table)
     *
     * @param bool $enforceSingleColumn Throw an exception if $this is a multi column
     * @return string
     */
    public function getColName($enforceSingleColumn = true)
    {
        if ($enforceSingleColumn && $this->isMulti())
            throw new StructException('Calling getColName on a multi value column makes no sense.');
        return 'col' . $this->colref;
    }

    /**
     * Returns the full column name. When table is set, prefixed by the table name
     *
     * @param bool $enforceSingleColumn Throw an exception if $this is a multi column
     * @return string
     */
    public function getFullColName($enforceSingleColumn = true)
    {
        $col = $this->getColName($enforceSingleColumn);
        if ($this->table) $col = 'data_' . $this->table . '.' . $col;
        return $col;
    }

    /**
     * @return boolean
     */
    public function isEnabled()
    {
        return $this->enabled;
    }

    /**
     * @return string
     */
    public function getTable()
    {
        return $this->table;
    }

    /**
     * @return bool
     */
    public function isMulti()
    {
        return $this->type->isMulti();
    }

    /**
     * @return bool
     */
    public function isVisibleInEditor()
    {
        return $this->getType()->isVisibleInEditor();
    }

    /**
     * @return bool
     */
    public function isVisibleInPage()
    {
        return $this->getType()->isVisibleInPage();
    }

    /**
     * Returns a list of all available types and their class names
     *
     * @param bool $reload forces reloading the types
     * @return array
     */
    public static function allTypes($reload = false)
    {
        static $map = null;
        if (!is_null($map) && !$reload) return $map;

        // get our own types
        $map = [];
        $files = glob(DOKU_PLUGIN . 'struct/types/*.php');
        foreach ($files as $file) {
            $file = basename($file, '.php');
            if (str_starts_with($file, 'Abstract')) continue;
            if (str_starts_with($file, 'Trait')) continue;
            if (str_starts_with($file, 'Auto')) continue;
            $map[$file] = 'dokuwiki\\plugin\\struct\\types\\' . $file;
        }

        // let plugins add their own
        Event::createAndTrigger('PLUGIN_STRUCT_TYPECLASS_INIT', $map);

        ksort($map);
        return $map;
    }
}