class.ilADTLocation.php

Go to the documentation of this file.

<?php

class ilADTLocation extends ilADT
{
        protected $longitude; // [float]
        protected $latitude; // [float]
        protected $zoom; // [int]
                
        const ADT_VALIDATION_ERROR_LONGITUDE = "loc1";
        const ADT_VALIDATION_ERROR_LATITUDE = "loc2";
        
        
        // definition
        
        protected function isValidDefinition(ilADTDefinition $a_def)
        {
                return ($a_def instanceof ilADTLocationDefinition);
        }
        
        
        // default
        
        public function reset()
        {
                parent::reset();
                
                $this->setZoom(9);
                $this->setLatitude();
                $this->setLongitude();
        }
        
        
        // properties
        
        public function setLongitude($a_value = null)
        {               
                if($a_value !== null)
                {
                        $a_value = (float)$a_value;
                }
                $this->longitude = $a_value;
        }
        
        public function getLongitude()
        {
                return $this->longitude;
        }
        
        public function setLatitude($a_value = null)
        {               
                if($a_value !== null)
                {
                        $a_value = (float)$a_value;
                }
                $this->latitude = $a_value;
        }
        
        public function getLatitude()
        {
                return $this->latitude;
        }
        
        public function getZoom()
        {
                return $this->zoom;
        }
        
        public function setZoom($a_value)
        {
                $this->zoom = max(1, abs((int)$a_value));
        }
        
        
        // comparison

        public function equals(ilADT $a_adt)
        {               
                if($this->getDefinition()->isComparableTo($a_adt))
                {
                        return ($this->getLongitude() == $a_adt->getLongitude() &&
                                $this->getLatitude() == $a_adt->getLatitude());
                }
        }
                                
        public function isLarger(ilADT $a_adt)
        {
                // return null?
        }
        
        public function isSmaller(ilADT $a_adt)
        {
                // return null?
        }

        
        // null
        
        public function isNull()
        {
                return ($this->getLongitude() === null && $this->getLatitude() === null);
        }
        
        
        // validation
        
        public function isValid()
        {
                $valid = parent::isValid();
                
                // zoom?

                $long = $this->getLongitude();
                $lat = $this->getLatitude();
                if($long !== null && $lat !== null)
                {                       
                        // 0 - (+-)180
                        if($long < -180 || $long > 180)
                        {
                                $this->addValidationError(self::ADT_VALIDATION_ERROR_LONGITUDE);
                                $valid = false;
                        }
                        // 0 - (+-)90
                        if($lat < -90 || $lat > 90)
                        {
                                $this->addValidationError(self::ADT_VALIDATION_ERROR_LATITUDE);
                                $valid = false;
                        }                                       
                }                                               
                
                return $valid;
        }
        
        
        // check
        
        public function translateErrorCode($a_code)
        {
                global $lng;
                
                // $lng->txt("msg_wrong_format");
                
                switch($a_code)
                {                       
                        case self::ADT_VALIDATION_ERROR_LONGITUDE:              
                                return $lng->txt("adt_error_longitude");
                                        
                        case self::ADT_VALIDATION_ERROR_LATITUDE:               
                                return $lng->txt("adt_error_latitude");
                        
                        default:
                                // all other / unknown "codes"
                                return parent::translateErrorCode($a_code);
                }
        }
        
        public function getCheckSum()
        {
                if(!$this->isNull())
                {
                        return md5($this->getLongitude().
                                        "#".$this->getLatitude().
                                        "#".$this->getZoom());
                }
        }               
}

?>