Inheritance diagram for ilADTLocation:

Collaboration diagram for ilADTLocation:

Public Member Functions
	reset ()
	Init property defaults. More...

	setLongitude ($a_value=null)

	getLongitude ()

	setLatitude ($a_value=null)

	getLatitude ()

	getZoom ()

	setZoom ($a_value)

	equals (ilADT $a_adt)
	Check if given ADT equals self. More...

	isLarger (ilADT $a_adt)
	Check if given ADT is larger than self. More...

	isSmaller (ilADT $a_adt)
	Check if given ADT is smaller than self. More...

	isNull ()
	Is currently null. More...

	isValid ()
	Is currently valid. More...

	translateErrorCode ($a_code)
	Translate error-code to human-readable message. More...

	getCheckSum ()
	Get unique checksum. More...

Public Member Functions inherited from ilADT
	__construct (ilADTDefinition $a_def)
	Constructor. More...

	getType ()
	Get type (from class/instance) More...

	getCopyOfDefinition ()
	Get copy of definition. More...

	equals (ilADT $a_adt)
	Check if given ADT equals self. More...

	isLarger (ilADT $a_adt)
	Check if given ADT is larger than self. More...

	isLargerOrEqual (ilADT $a_adt)
	Check if given ADT is larger or equal than self. More...

	isSmaller (ilADT $a_adt)
	Check if given ADT is smaller than self. More...

	isSmallerOrEqual (ilADT $a_adt)
	Check if given ADT is smaller or equal than self. More...

	isInbetween (ilADT $a_adt_from, ilADT $a_adt_to)
	Check if self is inbetween given ADTs (exclusive) More...

	isInbetweenOrEqual (ilADT $a_adt_from, ilADT $a_adt_to)
	Check if self is inbetween given ADTs (inclusive) More...

	isNull ()
	Is currently null. More...

	isValid ()
	Is currently valid. More...

	getValidationErrors ()
	Get all validation error codes. More...

	translateErrorCode ($a_code)
	Translate error-code to human-readable message. More...

	getCheckSum ()
	Get unique checksum. More...

Data Fields
const	ADT_VALIDATION_ERROR_LONGITUDE = "loc1"

const	ADT_VALIDATION_ERROR_LATITUDE = "loc2"

Data Fields inherited from ilADT
const	ADT_VALIDATION_ERROR_NULL_NOT_ALLOWED = "adt1"

const	ADT_VALIDATION_ERROR_MAX_LENGTH = "adt2"

const	ADT_VALIDATION_ERROR_MAX_SIZE = "adt3"

const	ADT_VALIDATION_ERROR_MIN = "adt4"

const	ADT_VALIDATION_ERROR_MAX = "adt5"

const	ADT_VALIDATION_DATE = "adt6"

const	ADT_VALIDATION_ERROR_INVALID_NODE = 'adt7'

Protected Member Functions
	isValidDefinition (ilADTDefinition $a_def)
	Check if definition is valid for ADT. More...

Protected Member Functions inherited from ilADT
	reset ()
	Init property defaults. More...

	isValidDefinition (ilADTDefinition $a_def)
	Check if definition is valid for ADT. More...

	setDefinition (ilADTDefinition $a_def)
	Set definition. More...

	getDefinition ()
	Get definition. More...

	addValidationError ($a_error_code)
	Add validation error code. More...

Protected Attributes
	$longitude

	$latitude

	$zoom

Protected Attributes inherited from ilADT
	$definition

	$validation_errors = []

Detailed Description

Definition at line 3 of file class.ilADTLocation.php.

Member Function Documentation

◆ equals()

ilADTLocation::equals ( ilADT $a_adt )

Check if given ADT equals self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

Definition at line 74 of file class.ilADTLocation.php.

    {
        if ($this->getDefinition()->isComparableTo($a_adt)) {
            return ($this->getLongitude() == $a_adt->getLongitude() &&
                $this->getLatitude() == $a_adt->getLatitude());
        }
    }

References ilADT\getDefinition(), and getLongitude().

Here is the call graph for this function:

◆ getCheckSum()

ilADTLocation::getCheckSum ( )

Get unique checksum.

Returns: string

Reimplemented from ilADT.

Definition at line 149 of file class.ilADTLocation.php.

    {
        if (!$this->isNull()) {
            return md5($this->getLongitude() .
                    "#" . $this->getLatitude() .
                    "#" . $this->getZoom());
        }
    }

References getLatitude(), getLongitude(), getZoom(), and isNull().

Here is the call graph for this function:

◆ getLatitude()

ilADTLocation::getLatitude ( )

Definition at line 56 of file class.ilADTLocation.php.

    {
        return $this->latitude;
    }

References $latitude.

Referenced by getCheckSum(), isNull(), and isValid().

Here is the caller graph for this function:

◆ getLongitude()

ilADTLocation::getLongitude ( )

Definition at line 43 of file class.ilADTLocation.php.

    {
        return $this->longitude;
    }

References $longitude.

Referenced by equals(), getCheckSum(), isNull(), and isValid().

Here is the caller graph for this function:

◆ getZoom()

ilADTLocation::getZoom ( )

Definition at line 61 of file class.ilADTLocation.php.

    {
        return $this->zoom;
    }

References $zoom.

Referenced by getCheckSum().

Here is the caller graph for this function:

◆ isLarger()

ilADTLocation::isLarger ( ilADT $a_adt )

Check if given ADT is larger than self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

Definition at line 82 of file class.ilADTLocation.php.

    {
        // return null?
    }

◆ isNull()

ilADTLocation::isNull ( )

Is currently null.

Returns: bool

Reimplemented from ilADT.

Definition at line 95 of file class.ilADTLocation.php.

    {
        return ($this->getLongitude() === null && $this->getLatitude() === null);
    }

References getLatitude(), and getLongitude().

Referenced by getCheckSum().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSmaller()

ilADTLocation::isSmaller ( ilADT $a_adt )

Check if given ADT is smaller than self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

Definition at line 87 of file class.ilADTLocation.php.

    {
        // return null?
    }

◆ isValid()

ilADTLocation::isValid ( )

Is currently valid.

Returns: boolean

Reimplemented from ilADT.

Definition at line 103 of file class.ilADTLocation.php.

    {
        $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;
    }

References $valid, ilADT\addValidationError(), getLatitude(), and getLongitude().

Here is the call graph for this function:

◆ isValidDefinition()

ilADTLocation::isValidDefinition ( ilADTDefinition $a_def )

protected

Check if definition is valid for ADT.

Returns: bool;

Reimplemented from ilADT.

Definition at line 15 of file class.ilADTLocation.php.

    {
        return ($a_def instanceof ilADTLocationDefinition);
    }

◆ reset()

ilADTLocation::reset ( )

Init property defaults.

Reimplemented from ilADT.

Definition at line 23 of file class.ilADTLocation.php.

    {
        parent::reset();
        
        $this->setZoom(9);
        $this->setLatitude();
        $this->setLongitude();
    }

References setLatitude(), setLongitude(), and setZoom().

Here is the call graph for this function:

◆ setLatitude()

ilADTLocation::setLatitude ( $a_value = null )

Definition at line 48 of file class.ilADTLocation.php.

    {
        if ($a_value !== null) {
            $a_value = (float) $a_value;
        }
        $this->latitude = $a_value;
    }

Referenced by reset().

Here is the caller graph for this function:

◆ setLongitude()

ilADTLocation::setLongitude ( $a_value = null )

Definition at line 35 of file class.ilADTLocation.php.

    {
        if ($a_value !== null) {
            $a_value = (float) $a_value;
        }
        $this->longitude = $a_value;
    }

Referenced by reset().

Here is the caller graph for this function:

◆ setZoom()

ilADTLocation::setZoom ( $a_value )

Definition at line 66 of file class.ilADTLocation.php.

    {
        $this->zoom = max(1, abs((int) $a_value));
    }

Referenced by reset().

Here is the caller graph for this function:

◆ translateErrorCode()

ilADTLocation::translateErrorCode ( $a_code )

Translate error-code to human-readable message.

Exceptions

Exception

Parameters

int $a_code

Returns: string

Reimplemented from ilADT.

Definition at line 130 of file class.ilADTLocation.php.

    {
        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);
        }
    }

References $lng, ADT_VALIDATION_ERROR_LATITUDE, and ADT_VALIDATION_ERROR_LONGITUDE.

Field Documentation

◆ $latitude

ilADTLocation::$latitude

protected

Definition at line 6 of file class.ilADTLocation.php.

Referenced by getLatitude().

◆ $longitude

ilADTLocation::$longitude

protected

Definition at line 5 of file class.ilADTLocation.php.

Referenced by getLongitude().

◆ $zoom

ilADTLocation::$zoom

protected

Definition at line 7 of file class.ilADTLocation.php.

Referenced by getZoom().

◆ ADT_VALIDATION_ERROR_LATITUDE

const ilADTLocation::ADT_VALIDATION_ERROR_LATITUDE = "loc2"

Definition at line 10 of file class.ilADTLocation.php.

Referenced by translateErrorCode().

◆ ADT_VALIDATION_ERROR_LONGITUDE

const ilADTLocation::ADT_VALIDATION_ERROR_LONGITUDE = "loc1"

Definition at line 9 of file class.ilADTLocation.php.

Referenced by translateErrorCode().

The documentation for this class was generated from the following file:

Services/ADT/classes/Types/Location/class.ilADTLocation.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ equals()

◆ getCheckSum()

◆ getLatitude()

◆ getLongitude()

◆ getZoom()

◆ isLarger()

◆ isNull()

◆ isSmaller()

◆ isValid()

◆ isValidDefinition()

◆ reset()

◆ setLatitude()

◆ setLongitude()

◆ setZoom()

◆ translateErrorCode()

Field Documentation

◆ $latitude

◆ $longitude

◆ $zoom

◆ ADT_VALIDATION_ERROR_LATITUDE

◆ ADT_VALIDATION_ERROR_LONGITUDE