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; 28*63d51bbfSAndreas Gohr /** @var string backreference to the table this column is part of */ 29*63d51bbfSAndreas 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 37*63d51bbfSAndreas Gohr * @param string $table 381c502704SAndreas Gohr */ 39*63d51bbfSAndreas 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; 44*63d51bbfSAndreas 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 /** 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 82ae697e1fSAndreas Gohr /** 83*63d51bbfSAndreas Gohr * @return string 84*63d51bbfSAndreas Gohr */ 85*63d51bbfSAndreas Gohr public function getTable() { 86*63d51bbfSAndreas Gohr return $this->table; 87*63d51bbfSAndreas Gohr } 88*63d51bbfSAndreas Gohr 89*63d51bbfSAndreas Gohr /** 90ae697e1fSAndreas Gohr * Returns a list of all available types 91ae697e1fSAndreas Gohr * 92ae697e1fSAndreas Gohr * @return array 93ae697e1fSAndreas Gohr */ 94ae697e1fSAndreas Gohr static public function allTypes() { 95ae697e1fSAndreas Gohr $types = array(); 96ae697e1fSAndreas Gohr $files = glob(DOKU_PLUGIN . 'struct/types/*.php'); 97ae697e1fSAndreas Gohr foreach($files as $file) { 98ae697e1fSAndreas Gohr $file = basename($file, '.php'); 99ae697e1fSAndreas Gohr if(substr($file, 0, 8) == 'Abstract') continue; 100ae697e1fSAndreas Gohr $types[] = $file; 101ae697e1fSAndreas Gohr } 102ae697e1fSAndreas Gohr sort($types); 1031c502704SAndreas Gohr 104ae697e1fSAndreas Gohr return $types; 105ae697e1fSAndreas Gohr } 1061c502704SAndreas Gohr 1071c502704SAndreas Gohr} 108