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 /** 69*00f6af48SAndreas Gohr * @return string the label prepended with the table name 70*00f6af48SAndreas Gohr */ 71*00f6af48SAndreas Gohr public function getFullQualifiedLabel() { 72*00f6af48SAndreas Gohr if(!$this->table) throw new StructException('No table set for this column'); 73*00f6af48SAndreas Gohr return $this->table .'.'. $this->getLabel(); 74*00f6af48SAndreas Gohr } 75*00f6af48SAndreas Gohr 76*00f6af48SAndreas Gohr /** 779e9bee91SAndreas Gohr * @return string 789e9bee91SAndreas Gohr */ 799e9bee91SAndreas Gohr public function getTranslatedLabel() { 809e9bee91SAndreas Gohr return $this->type->getTranslatedLabel(); 819e9bee91SAndreas Gohr } 829e9bee91SAndreas Gohr 839e9bee91SAndreas Gohr /** 843a717675SAndreas Gohr * @return string 853a717675SAndreas Gohr */ 863a717675SAndreas Gohr public function getTranslatedHint() { 873a717675SAndreas Gohr return $this->type->getTranslatedHint(); 883a717675SAndreas Gohr } 893a717675SAndreas Gohr 903a717675SAndreas Gohr /** 911c502704SAndreas Gohr * @return AbstractBaseType 921c502704SAndreas Gohr */ 931c502704SAndreas Gohr public function getType() { 941c502704SAndreas Gohr return $this->type; 951c502704SAndreas Gohr } 961c502704SAndreas Gohr 971c502704SAndreas Gohr /** 981c502704SAndreas Gohr * @return int 991c502704SAndreas Gohr */ 1001c502704SAndreas Gohr public function getColref() { 1011c502704SAndreas Gohr return $this->colref; 1021c502704SAndreas Gohr } 1031c502704SAndreas Gohr 1041c502704SAndreas Gohr /** 105d1b04e89SAndreas Gohr * Returns the full column name. When table is set, prefixed by the table name 106d1b04e89SAndreas Gohr * 107d1b04e89SAndreas Gohr * @return string 108d1b04e89SAndreas Gohr */ 109d1b04e89SAndreas Gohr public function getColName() { 1105b2d2a8cSAndreas Gohr if($this->isMulti()) throw new StructException('Calling getColName on a multi value column makes no sense.'); 1115b2d2a8cSAndreas Gohr 112d1b04e89SAndreas Gohr $col = 'col'.$this->colref; 1135b2d2a8cSAndreas Gohr if($this->table) $col = 'data_'.$this->table.'.'.$col; 114d1b04e89SAndreas Gohr return $col; 115d1b04e89SAndreas Gohr } 116d1b04e89SAndreas Gohr 117d1b04e89SAndreas Gohr /** 1181c502704SAndreas Gohr * @return boolean 1191c502704SAndreas Gohr */ 1201c502704SAndreas Gohr public function isEnabled() { 1211c502704SAndreas Gohr return $this->enabled; 1221c502704SAndreas Gohr } 1231c502704SAndreas Gohr 124ae697e1fSAndreas Gohr /** 12563d51bbfSAndreas Gohr * @return string 12663d51bbfSAndreas Gohr */ 12763d51bbfSAndreas Gohr public function getTable() { 12863d51bbfSAndreas Gohr return $this->table; 12963d51bbfSAndreas Gohr } 13063d51bbfSAndreas Gohr 13163d51bbfSAndreas Gohr /** 13290ae6c2dSAndreas Gohr * @return bool 13390ae6c2dSAndreas Gohr */ 13490ae6c2dSAndreas Gohr public function isMulti() { 13590ae6c2dSAndreas Gohr return $this->type->isMulti(); 13690ae6c2dSAndreas Gohr } 13790ae6c2dSAndreas Gohr 13890ae6c2dSAndreas Gohr /** 139ae697e1fSAndreas Gohr * Returns a list of all available types 140ae697e1fSAndreas Gohr * 141ae697e1fSAndreas Gohr * @return array 142ae697e1fSAndreas Gohr */ 143ae697e1fSAndreas Gohr static public function allTypes() { 144ae697e1fSAndreas Gohr $types = array(); 145ae697e1fSAndreas Gohr $files = glob(DOKU_PLUGIN . 'struct/types/*.php'); 146ae697e1fSAndreas Gohr foreach($files as $file) { 147ae697e1fSAndreas Gohr $file = basename($file, '.php'); 148ae697e1fSAndreas Gohr if(substr($file, 0, 8) == 'Abstract') continue; 149ae697e1fSAndreas Gohr $types[] = $file; 150ae697e1fSAndreas Gohr } 151ae697e1fSAndreas Gohr sort($types); 1521c502704SAndreas Gohr 153ae697e1fSAndreas Gohr return $types; 154ae697e1fSAndreas Gohr } 1551c502704SAndreas Gohr 1561c502704SAndreas Gohr} 157