xref: /plugin/struct/meta/Column.php (revision ae697e1fdde33cb7ccee28cd51db309f9021629c) 
11c502704SAndreas Gohr<?php
21c502704SAndreas Gohr
31c502704SAndreas Gohrnamespace plugin\struct\meta;
41c502704SAndreas Gohr
51c502704SAndreas Gohruse plugin\struct\types\AbstractBaseType;
61c502704SAndreas Gohr
71c502704SAndreas Gohr/**
81c502704SAndreas Gohr * Class Column
91c502704SAndreas Gohr *
101c502704SAndreas Gohr * This represents a single column within a schema and contains the configured BaseType as well as the
117182938bSAndreas Gohr * column reference to the data table.
127182938bSAndreas Gohr *
137182938bSAndreas Gohr * It basically combines the information how a column's content behaves (as defines in the BaseType and its
147182938bSAndreas Gohr * configuration) with where to find that content and adds some basic meta data (like sort or enabled)
151c502704SAndreas Gohr *
161c502704SAndreas Gohr * @package plugin\struct\meta
171c502704SAndreas Gohr */
181c502704SAndreas Gohrclass Column {
191c502704SAndreas Gohr
201c502704SAndreas Gohr    /** @var int fields are sorted by this value */
211c502704SAndreas Gohr    protected $sort;
221c502704SAndreas Gohr    /** @var AbstractBaseType the type of this column */
231c502704SAndreas Gohr    protected $type;
241c502704SAndreas Gohr    /** @var int the ID of the currently used type */
251c502704SAndreas Gohr    protected $tid;
261c502704SAndreas Gohr    /** @var int the column in the datatable. columns count from 1 */
271c502704SAndreas Gohr    protected $colref;
281c502704SAndreas Gohr    /** @var bool is this column still enabled? */
291c502704SAndreas Gohr    protected $enabled=true;
301c502704SAndreas Gohr
311c502704SAndreas Gohr    /**
321c502704SAndreas Gohr     * Column constructor.
331c502704SAndreas Gohr     * @param int $sort
341c502704SAndreas Gohr     * @param AbstractBaseType $type
351c502704SAndreas Gohr     * @param int $tid
361c502704SAndreas Gohr     * @param int $colref
371c502704SAndreas Gohr     * @param bool $enabled
381c502704SAndreas Gohr     */
391c502704SAndreas Gohr    public function __construct($sort, AbstractBaseType $type, $tid = 0, $colref=0, $enabled=true) {
401c502704SAndreas Gohr        $this->sort = (int) $sort;
411c502704SAndreas Gohr        $this->type = $type;
421c502704SAndreas Gohr        $this->tid = (int) $tid;
431c502704SAndreas Gohr        $this->colref = (int) $colref;
441c502704SAndreas Gohr        $this->enabled = (bool) $enabled;
451c502704SAndreas Gohr    }
461c502704SAndreas Gohr
471c502704SAndreas Gohr    /**
481c502704SAndreas Gohr     * @return int
491c502704SAndreas Gohr     */
501c502704SAndreas Gohr    public function getSort() {
511c502704SAndreas Gohr        return $this->sort;
521c502704SAndreas Gohr    }
531c502704SAndreas Gohr
541c502704SAndreas Gohr    /**
551c502704SAndreas Gohr     * @return int
561c502704SAndreas Gohr     */
571c502704SAndreas Gohr    public function getTid() {
581c502704SAndreas Gohr        return $this->tid;
591c502704SAndreas Gohr    }
601c502704SAndreas Gohr
611c502704SAndreas Gohr    /**
621c502704SAndreas Gohr     * @return AbstractBaseType
631c502704SAndreas Gohr     */
641c502704SAndreas Gohr    public function getType() {
651c502704SAndreas Gohr        return $this->type;
661c502704SAndreas Gohr    }
671c502704SAndreas Gohr
681c502704SAndreas Gohr    /**
691c502704SAndreas Gohr     * @return int
701c502704SAndreas Gohr     */
711c502704SAndreas Gohr    public function getColref() {
721c502704SAndreas Gohr        return $this->colref;
731c502704SAndreas Gohr    }
741c502704SAndreas Gohr
751c502704SAndreas Gohr    /**
761c502704SAndreas Gohr     * @return boolean
771c502704SAndreas Gohr     */
781c502704SAndreas Gohr    public function isEnabled() {
791c502704SAndreas Gohr        return $this->enabled;
801c502704SAndreas Gohr    }
811c502704SAndreas Gohr
82*ae697e1fSAndreas Gohr    /**
83*ae697e1fSAndreas Gohr     * Returns a list of all available types
84*ae697e1fSAndreas Gohr     *
85*ae697e1fSAndreas Gohr     * @return array
86*ae697e1fSAndreas Gohr     */
87*ae697e1fSAndreas Gohr    static public function allTypes() {
88*ae697e1fSAndreas Gohr        $types = array();
89*ae697e1fSAndreas Gohr        $files = glob(DOKU_PLUGIN . 'struct/types/*.php');
90*ae697e1fSAndreas Gohr        foreach($files as $file) {
91*ae697e1fSAndreas Gohr            $file = basename($file, '.php');
92*ae697e1fSAndreas Gohr            if(substr($file, 0, 8) == 'Abstract') continue;
93*ae697e1fSAndreas Gohr            $types[] = $file;
94*ae697e1fSAndreas Gohr        }
95*ae697e1fSAndreas Gohr        sort($types);
961c502704SAndreas Gohr
97*ae697e1fSAndreas Gohr        return $types;
98*ae697e1fSAndreas Gohr    }
991c502704SAndreas Gohr
1001c502704SAndreas Gohr}
101