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 column in the datatable. columns count from 1 */ 251c502704SAndreas Gohr protected $colref; 261c502704SAndreas Gohr /** @var bool is this column still enabled? */ 271c502704SAndreas Gohr protected $enabled=true; 2863d51bbfSAndreas Gohr /** @var string backreference to the table this column is part of */ 2963d51bbfSAndreas Gohr protected $table; 301c502704SAndreas Gohr 311c502704SAndreas Gohr /** 321c502704SAndreas Gohr * Column constructor. 331c502704SAndreas Gohr * @param int $sort 341c502704SAndreas Gohr * @param AbstractBaseType $type 351c502704SAndreas Gohr * @param int $colref 361c502704SAndreas Gohr * @param bool $enabled 3763d51bbfSAndreas Gohr * @param string $table 381c502704SAndreas Gohr */ 3963d51bbfSAndreas Gohr public function __construct($sort, AbstractBaseType $type, $colref=0, $enabled=true, $table='') { 401c502704SAndreas Gohr $this->sort = (int) $sort; 411c502704SAndreas Gohr $this->type = $type; 421c502704SAndreas Gohr $this->colref = (int) $colref; 431c502704SAndreas Gohr $this->enabled = (bool) $enabled; 4463d51bbfSAndreas Gohr $this->table = $table; 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() { 5804eb61a6SAndreas Gohr return $this->type->getTid(); 591c502704SAndreas Gohr } 601c502704SAndreas Gohr 611c502704SAndreas Gohr /** 6290ae6c2dSAndreas Gohr * @return string 6390ae6c2dSAndreas Gohr */ 6490ae6c2dSAndreas Gohr public function getLabel() { 6590ae6c2dSAndreas Gohr return $this->type->getLabel(); 6690ae6c2dSAndreas Gohr } 6790ae6c2dSAndreas Gohr 6890ae6c2dSAndreas Gohr /** 691c502704SAndreas Gohr * @return AbstractBaseType 701c502704SAndreas Gohr */ 711c502704SAndreas Gohr public function getType() { 721c502704SAndreas Gohr return $this->type; 731c502704SAndreas Gohr } 741c502704SAndreas Gohr 751c502704SAndreas Gohr /** 761c502704SAndreas Gohr * @return int 771c502704SAndreas Gohr */ 781c502704SAndreas Gohr public function getColref() { 791c502704SAndreas Gohr return $this->colref; 801c502704SAndreas Gohr } 811c502704SAndreas Gohr 821c502704SAndreas Gohr /** 83d1b04e89SAndreas Gohr * Returns the full column name. When table is set, prefixed by the table name 84d1b04e89SAndreas Gohr * 85d1b04e89SAndreas Gohr * @return string 86d1b04e89SAndreas Gohr */ 87d1b04e89SAndreas Gohr public function getColName() { 88*5b2d2a8cSAndreas Gohr if($this->isMulti()) throw new StructException('Calling getColName on a multi value column makes no sense.'); 89*5b2d2a8cSAndreas Gohr 90d1b04e89SAndreas Gohr $col = 'col'.$this->colref; 91*5b2d2a8cSAndreas Gohr if($this->table) $col = 'data_'.$this->table.'.'.$col; 92d1b04e89SAndreas Gohr return $col; 93d1b04e89SAndreas Gohr } 94d1b04e89SAndreas Gohr 95d1b04e89SAndreas Gohr /** 961c502704SAndreas Gohr * @return boolean 971c502704SAndreas Gohr */ 981c502704SAndreas Gohr public function isEnabled() { 991c502704SAndreas Gohr return $this->enabled; 1001c502704SAndreas Gohr } 1011c502704SAndreas Gohr 102ae697e1fSAndreas Gohr /** 10363d51bbfSAndreas Gohr * @return string 10463d51bbfSAndreas Gohr */ 10563d51bbfSAndreas Gohr public function getTable() { 10663d51bbfSAndreas Gohr return $this->table; 10763d51bbfSAndreas Gohr } 10863d51bbfSAndreas Gohr 10963d51bbfSAndreas Gohr /** 11090ae6c2dSAndreas Gohr * @return bool 11190ae6c2dSAndreas Gohr */ 11290ae6c2dSAndreas Gohr public function isMulti() { 11390ae6c2dSAndreas Gohr return $this->type->isMulti(); 11490ae6c2dSAndreas Gohr } 11590ae6c2dSAndreas Gohr 11690ae6c2dSAndreas Gohr /** 117ae697e1fSAndreas Gohr * Returns a list of all available types 118ae697e1fSAndreas Gohr * 119ae697e1fSAndreas Gohr * @return array 120ae697e1fSAndreas Gohr */ 121ae697e1fSAndreas Gohr static public function allTypes() { 122ae697e1fSAndreas Gohr $types = array(); 123ae697e1fSAndreas Gohr $files = glob(DOKU_PLUGIN . 'struct/types/*.php'); 124ae697e1fSAndreas Gohr foreach($files as $file) { 125ae697e1fSAndreas Gohr $file = basename($file, '.php'); 126ae697e1fSAndreas Gohr if(substr($file, 0, 8) == 'Abstract') continue; 127ae697e1fSAndreas Gohr $types[] = $file; 128ae697e1fSAndreas Gohr } 129ae697e1fSAndreas Gohr sort($types); 1301c502704SAndreas Gohr 131ae697e1fSAndreas Gohr return $types; 132ae697e1fSAndreas Gohr } 1331c502704SAndreas Gohr 1341c502704SAndreas Gohr} 135