1ed3de3d6SAndreas Gohr<?php 2ba766201SAndreas Gohruse dokuwiki\plugin\struct\meta\Column; 3ba766201SAndreas Gohruse dokuwiki\plugin\struct\meta\Schema; 4ba766201SAndreas Gohruse dokuwiki\plugin\struct\meta\StructException; 5ba766201SAndreas Gohruse dokuwiki\plugin\struct\meta\Value; 6*93ca6f4fSAndreas Gohruse dokuwiki\plugin\struct\meta\ValueValidator; 7ed3de3d6SAndreas Gohr 8ed3de3d6SAndreas Gohr/** 93ad9c1eaSAndreas Gohr * Allows adding a single struct field as a bureaucracy field 103ad9c1eaSAndreas Gohr * 113ad9c1eaSAndreas Gohr * This class is used when a field of the type struct_field is encountered in the 123ad9c1eaSAndreas Gohr * bureaucracy syntax. 13ed3de3d6SAndreas Gohr */ 14ed3de3d6SAndreas Gohrclass helper_plugin_struct_field extends helper_plugin_bureaucracy_field { 15ed3de3d6SAndreas Gohr 163ad9c1eaSAndreas Gohr /** @var Column */ 173ad9c1eaSAndreas Gohr public $column; 18ed3de3d6SAndreas Gohr 193ad9c1eaSAndreas Gohr /** 203ad9c1eaSAndreas Gohr * Initialize the appropriate column 213ad9c1eaSAndreas Gohr * 223ad9c1eaSAndreas Gohr * @param array $args 233ad9c1eaSAndreas Gohr */ 243ad9c1eaSAndreas Gohr public function initialize($args) { 253ad9c1eaSAndreas Gohr parent::initialize($args); 26ed3de3d6SAndreas Gohr 273ad9c1eaSAndreas Gohr // find the column 283ad9c1eaSAndreas Gohr try { 293ad9c1eaSAndreas Gohr $this->column = $this->findColumn($this->opt['label']); 303ad9c1eaSAndreas Gohr } catch(StructException $e) { 313ad9c1eaSAndreas Gohr msg(hsc($e->getMessage()), -1); 323ad9c1eaSAndreas Gohr } 333ad9c1eaSAndreas Gohr } 343ad9c1eaSAndreas Gohr 353ad9c1eaSAndreas Gohr /** 366c71c031SAndreas Gohr * Sets the value and validates it 373ad9c1eaSAndreas Gohr * 386c71c031SAndreas Gohr * @param mixed $value 396c71c031SAndreas Gohr * @return bool value was set successfully validated 403ad9c1eaSAndreas Gohr */ 416c71c031SAndreas Gohr protected function setVal($value) { 426c71c031SAndreas Gohr if(!$this->column) { 436c71c031SAndreas Gohr $value = ''; 446c71c031SAndreas Gohr } else { 45*93ca6f4fSAndreas Gohr $validator = new ValueValidator(); 466c71c031SAndreas Gohr $this->error = !$validator->validateValue($this->column, $value); 476c71c031SAndreas Gohr if($this->error) { 486c71c031SAndreas Gohr foreach($validator->getErrors() as $error) { 496c71c031SAndreas Gohr msg(hsc($error), -1); 506c71c031SAndreas Gohr } 516c71c031SAndreas Gohr } 526c71c031SAndreas Gohr } 536c71c031SAndreas Gohr 546c71c031SAndreas Gohr if($value === array() || $value === '') { 556c71c031SAndreas Gohr if(!isset($this->opt['optional'])) { 566c71c031SAndreas Gohr $this->error = true; 576c71c031SAndreas Gohr msg(sprintf($this->getLang('e_required'), hsc($this->opt['label'])), -1); 586c71c031SAndreas Gohr } 596c71c031SAndreas Gohr } 606c71c031SAndreas Gohr 616c71c031SAndreas Gohr $this->opt['value'] = $value; 626c71c031SAndreas Gohr return !$this->error; 633ad9c1eaSAndreas Gohr } 643ad9c1eaSAndreas Gohr 653ad9c1eaSAndreas Gohr /** 663ad9c1eaSAndreas Gohr * Creates the HTML for the field 673ad9c1eaSAndreas Gohr * 683ad9c1eaSAndreas Gohr * @param array $params 693ad9c1eaSAndreas Gohr * @param Doku_Form $form 703ad9c1eaSAndreas Gohr * @param int $formid 713ad9c1eaSAndreas Gohr */ 723ad9c1eaSAndreas Gohr public function renderfield($params, Doku_Form $form, $formid) { 733ad9c1eaSAndreas Gohr if(!$this->column) return; 743ad9c1eaSAndreas Gohr 753ad9c1eaSAndreas Gohr // this is what parent does 763ad9c1eaSAndreas Gohr $this->_handlePreload(); 773ad9c1eaSAndreas Gohr if(!$form->_infieldset) { 783ad9c1eaSAndreas Gohr $form->startFieldset(''); 793ad9c1eaSAndreas Gohr } 803ad9c1eaSAndreas Gohr if($this->error) { 813ad9c1eaSAndreas Gohr $params['class'] = 'bureaucracy_error'; 823ad9c1eaSAndreas Gohr } 833ad9c1eaSAndreas Gohr 843ad9c1eaSAndreas Gohr // output the field 853ad9c1eaSAndreas Gohr $value = new Value($this->column, $this->opt['value']); 8695838d50SAndreas Gohr $field = $this->makeField($value, $params['name']); 873ad9c1eaSAndreas Gohr $form->addElement($field); 883ad9c1eaSAndreas Gohr } 893ad9c1eaSAndreas Gohr 9095838d50SAndreas Gohr /** 9195838d50SAndreas Gohr * Create the input field 9295838d50SAndreas Gohr * 9395838d50SAndreas Gohr * @param Value $field 9495838d50SAndreas Gohr * @param String $name field's name 9595838d50SAndreas Gohr * @return string 9695838d50SAndreas Gohr */ 9795838d50SAndreas Gohr protected function makeField(Value $field, $name) { 9895838d50SAndreas Gohr $trans = hsc($field->getColumn()->getTranslatedLabel()); 9995838d50SAndreas Gohr $hint = hsc($field->getColumn()->getTranslatedHint()); 10095838d50SAndreas Gohr $class = $hint ? 'hashint' : ''; 10195838d50SAndreas Gohr $lclass = $this->error ? 'bureaucracy_error' : ''; 10295838d50SAndreas Gohr $colname = $field->getColumn()->getFullQualifiedLabel(); 1039bdb73ceSAndreas Gohr $required = $this->opt['optional'] ? '' : ' <sup>*</sup>'; 10495838d50SAndreas Gohr 10595838d50SAndreas Gohr $input = $field->getValueEditor($name); 10695838d50SAndreas Gohr 10795838d50SAndreas Gohr $html = ''; 10895838d50SAndreas Gohr $html .= "<label class=\"$lclass\" data-column=\"$colname\">"; 10995838d50SAndreas Gohr $html .= "<span class=\"label $class\" title=\"$hint\">$trans$required</span>"; 11095838d50SAndreas Gohr $html .= "<span class=\"input\">$input</span>"; 11195838d50SAndreas Gohr $html .= '</label>'; 11295838d50SAndreas Gohr 11395838d50SAndreas Gohr return $html; 11495838d50SAndreas Gohr } 11595838d50SAndreas Gohr 1163ad9c1eaSAndreas Gohr /** 1173ad9c1eaSAndreas Gohr * Tries to find the correct column and schema 1183ad9c1eaSAndreas Gohr * 1193ad9c1eaSAndreas Gohr * @throws StructException 1203ad9c1eaSAndreas Gohr * @param string $colname 121ba766201SAndreas Gohr * @return \dokuwiki\plugin\struct\meta\Column 1223ad9c1eaSAndreas Gohr */ 1233ad9c1eaSAndreas Gohr protected function findColumn($colname) { 1243ad9c1eaSAndreas Gohr list($table, $label) = explode('.', $colname, 2); 1253ad9c1eaSAndreas Gohr if(!$table || !$label) { 1263ad9c1eaSAndreas Gohr throw new StructException('Field \'%s\' not given in schema.field form', $colname); 1273ad9c1eaSAndreas Gohr } 1283ad9c1eaSAndreas Gohr $schema = new Schema($table); 1293ad9c1eaSAndreas Gohr return $schema->findColumn($label); 1303ad9c1eaSAndreas Gohr } 1313ad9c1eaSAndreas Gohr 1323ad9c1eaSAndreas Gohr /** 1333ad9c1eaSAndreas Gohr * This ensures all language strings are still working 1343ad9c1eaSAndreas Gohr * 1353ad9c1eaSAndreas Gohr * @return string always 'bureaucracy' 1363ad9c1eaSAndreas Gohr */ 1373ad9c1eaSAndreas Gohr public function getPluginName() { 1383ad9c1eaSAndreas Gohr return 'bureaucracy'; 1393ad9c1eaSAndreas Gohr } 140ed3de3d6SAndreas Gohr 141ed3de3d6SAndreas Gohr} 142