class.ilAdvancedMDFieldDefinitionInteger.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once "Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php";

class ilAdvancedMDFieldDefinitionInteger extends ilAdvancedMDFieldDefinition
{               
        protected $min; // [integer]
        protected $max; // [integer]
        protected $suffix; // [string]
        
        //
        // generic types
        // 
        
        public function getType()
        {
                return self::TYPE_INTEGER;
        }
        
        public function isFilterSupported() 
        {
                return false;
        }
        
        
        //
        // ADT
        //
        
        protected function initADTDefinition()
        {                               
                $def = ilADTFactory::getInstance()->getDefinitionInstanceByType("Integer");

                $def->setMin($this->getMin());
                $def->setMax($this->getMax());
                $def->setSuffix($this->getSuffix());
                
                return $def;
        }       
        
                
        // 
        // properties
        // 
        
        public function setMin($a_value)
        {
                if($a_value !== null)
                {
                        $a_value = (int)$a_value;
                }
                $this->min = $a_value;
        }

        public function getMin()
        {
                return $this->min;
        }
        
        public function setMax($a_value)
        {
                if($a_value !== null)
                {
                        $a_value = (int)$a_value;
                }
                $this->max = $a_value;
        }

        public function getMax()
        {
                return $this->max;
        }
        
        public function setSuffix($a_value)
        {
                if($a_value !== null)
                {
                        $a_value = trim($a_value);
                }
                $this->suffix = $a_value;
        }

        public function getSuffix()
        {
                return $this->suffix;
        }
        
        
        //
        // definition (NOT ADT-based)
        // 
        
        protected function importFieldDefinition(array $a_def)
        {               
                $this->setMin($a_def["min"]);
                $this->setMax($a_def["max"]);
                $this->setSuffix($a_def["suffix"]);
        }
        
        protected function getFieldDefinition()
        {
                return array(
                        "min" => $this->getMin(),
                        "max" => $this->getMax(),
                        "suffix" => $this->getSuffix()
                );
        }
        
        public function getFieldDefinitionForTableGUI()
        {
                global $lng;
        
                $res = array();
                
                if($this->getMin() !== null)
                {
                        $res[$lng->txt("md_adv_number_min")] = $this->getMin();
                }
                if($this->getMax() !== null)
                {
                        $res[$lng->txt("md_adv_number_max")] = $this->getMax();
                }
                if($this->getSuffix())
                {
                        $res[$lng->txt("md_adv_number_suffix")] = $this->getSuffix();
                }
                
                return $res;
        }
        
        public function addCustomFieldToDefinitionForm(ilPropertyFormGUI $a_form, $a_disabled = false)
        {
                global $lng;
                
                $min = new ilNumberInputGUI($lng->txt("md_adv_number_min"), "min");             
                $min->setValue($this->getMin());
                $min->setSize(10);
                $a_form->addItem($min);
                
                $max = new ilNumberInputGUI($lng->txt("md_adv_number_max"), "max");
                $max->setValue($this->getMax());
                $max->setSize(10);
                $a_form->addItem($max);
                
                $suffix = new ilTextInputGUI($lng->txt("md_adv_number_suffix"), "suffix");
                $suffix->setValue($this->getSuffix());          
                $suffix->setSize(10);
                $a_form->addItem($suffix);
                                
                if($a_disabled)
                {
                        $min->setDisabled(true);
                        $max->setDisabled(true);
                        $suffix->setDisabled(true);
                }                                               
        }
        
        public function importCustomDefinitionFormPostValues(ilPropertyFormGUI $a_form)
        {                               
                $min = $a_form->getInput("min");                
                $this->setMin(($min !== "") ? $min : null);
                
                $max = $a_form->getInput("max");
                $this->setMax(($max !== "") ? $max : null);     
                
                $suffix = $a_form->getInput("suffix");
                $this->setSuffix(($suffix !== "") ? $suffix : null);    
        }       
        
        
        //
        // export/import
        // 
        
        protected function addPropertiesToXML(ilXmlWriter $a_writer)
        {                               
                $a_writer->xmlElement('FieldValue',array("id"=>"min"),$this->getMin());                                 
                $a_writer->xmlElement('FieldValue',array("id"=>"max"),$this->getMax());                                 
                $a_writer->xmlElement('FieldValue',array("id"=>"suffix"),$this->getSuffix());                                   
        }       
        
        public function importXMLProperty($a_key, $a_value)
        {
                if($a_key == "min")
                {
                        $this->setMin($a_value != "" ? $a_value : null);
                }
                if($a_key == "max")
                {
                        $this->setMax($a_value != "" ? $a_value : null);
                }
                if($a_key == "suffix")
                {
                        $this->setSuffix($a_value != "" ? $a_value : null);
                }
        }               
        
        public function getValueForXML(ilADT $element)
        {
                return $element->getNumber();
        }
        
        public function importValueFromXML($a_cdata)
        {
                $this->getADT()->setNumber($a_cdata);
        }       
}

?>