ilADTLocation Class Reference

Inheritance diagram for ilADTLocation:

Collaboration diagram for ilADTLocation:

Public Member Functions
	reset ()
	setLongitude (?float $a_value=null)
	getLongitude ()
	setLatitude (?float $a_value=null)
	getLatitude ()
	getZoom ()
	setZoom ($a_value)
	equals (ilADT $a_adt)
	isLarger (ilADT $a_adt)
	isSmaller (ilADT $a_adt)
	isNull ()
	isValid ()
	translateErrorCode (string $a_code)
	getCheckSum ()
	exportStdClass ()
	importStdClass (?stdClass $a_std)
Public Member Functions inherited from ilADT
	__construct (ilADTDefinition $a_def)
	getType ()
	Get type (from class/instance) More...
	reset ()
	Init property defaults. 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)
	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 ()
	getValidationErrors ()
	Get all validation error codes. More...
	translateErrorCode (string $a_code)
	Translate error-code to human-readable message. More...
	getCheckSum ()
	Get unique checksum. More...
	exportStdClass ()
	Export value as stdClass. More...
	importStdClass (?stdClass $a_std)
	Import value from stdClass. 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)
Protected Member Functions inherited from ilADT
	isValidDefinition (ilADTDefinition $a_def)
	Check if definition is valid for ADT. More...
	setDefinition (ilADTDefinition $a_def)
	Set definition. More...
	getDefinition ()
	Get definition. More...
	addValidationError (string $a_error_code)

Protected Attributes
float	$longitude
float	$latitude
int	$zoom
Protected Attributes inherited from ilADT
ilADTDefinition	$definition
ilLanguage	$lng
array	$validation_errors = []

Detailed Description

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

Member Function Documentation

equals()

ilADTLocation::equals

(

ilADT

$a_adt

)

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

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

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

Here is the call graph for this function:

exportStdClass()

ilADTLocation::exportStdClass

(

)

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

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

                                    : ?stdClass
    {
        if (!$this->isNull()) {
            $obj = new stdClass();
            $obj->lat = $this->getLatitude();
            $obj->long = $this->getLongitude();
            $obj->zoom = $this->getZoom();
            return $obj;
        }
        return null;
    }

Here is the call graph for this function:

getCheckSum()

ilADTLocation::getCheckSum

(

)

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

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

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

Here is the call graph for this function:

getLatitude()

ilADTLocation::getLatitude

(

)

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

References $latitude.

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

                                 : ?float
    {
        return $this->latitude;
    }

Here is the caller graph for this function:

getLongitude()

ilADTLocation::getLongitude

(

)

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

References $longitude.

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

                                  : ?float
    {
        return $this->longitude;
    }

Here is the caller graph for this function:

getZoom()

ilADTLocation::getZoom

(

)

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

References $zoom.

Referenced by exportStdClass(), and getCheckSum().

                             : ?int
    {
        return $this->zoom;
    }

Here is the caller graph for this function:

importStdClass()

ilADTLocation::importStdClass

(

?stdClass

$a_std

)

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

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

                                                    : void
    {
        if (is_object($a_std)) {
            $this->setLatitude($a_std->lat);
            $this->setLongitude($a_std->long);
            $this->setZoom($a_std->zoom);
        }
    }

Here is the call graph for this function:

isLarger()

ilADTLocation::isLarger

(

ilADT

$a_adt

)

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

References null.

                                          : ?bool
    {
        return null;
    }

isNull()

ilADTLocation::isNull

(

)

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

References getLatitude(), getLongitude(), and null.

Referenced by exportStdClass(), and getCheckSum().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isSmaller()

ilADTLocation::isSmaller

(

ilADT

$a_adt

)

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

References null.

                                           : ?bool
    {
        return null;
    }

isValid()

ilADTLocation::isValid

(

)

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

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

                             : bool
    {
        $valid = parent::isValid();
        $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;
    }

Here is the call graph for this function:

isValidDefinition()

ilADTLocation::isValidDefinition ( ilADTDefinition  $a_def )

protected

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

                                                                : bool
    {
        return $a_def instanceof ilADTLocationDefinition;
    }

reset()

ilADTLocation::reset

(

)

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

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

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

Here is the call graph for this function:

setLatitude()

ilADTLocation::setLatitude

(

?float

$a_value = null

)

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

Referenced by importStdClass(), and reset().

                                                       : void
    {
        $this->latitude = $a_value;
    }

Here is the caller graph for this function:

setLongitude()

ilADTLocation::setLongitude

(

?float

$a_value = null

)

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

Referenced by importStdClass(), and reset().

                                                        : void
    {
        $this->longitude = $a_value;
    }

Here is the caller graph for this function:

setZoom()

ilADTLocation::setZoom

(

$a_value

)

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

Referenced by importStdClass(), and reset().

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

Here is the caller graph for this function:

translateErrorCode()

ilADTLocation::translateErrorCode

(

string

$a_code

)

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

References ILIAS\Repository\lng().

                                                      : string
    {
        switch ($a_code) {
            case self::ADT_VALIDATION_ERROR_LONGITUDE:
                return $this->lng->txt("adt_error_longitude");

            case self::ADT_VALIDATION_ERROR_LATITUDE:
                return $this->lng->txt("adt_error_latitude");

            default:
                return parent::translateErrorCode($a_code);
        }
    }

Here is the call graph for this function:

Field Documentation

$latitude

float ilADTLocation::$latitude

protected

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

Referenced by getLatitude().

$longitude

float ilADTLocation::$longitude

protected

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

Referenced by getLongitude().

$zoom

int ilADTLocation::$zoom

protected

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

Referenced by getZoom().

ADT_VALIDATION_ERROR_LATITUDE

const ilADTLocation::ADT_VALIDATION_ERROR_LATITUDE = "loc2"

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

ADT_VALIDATION_ERROR_LONGITUDE

const ilADTLocation::ADT_VALIDATION_ERROR_LONGITUDE = "loc1"

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

---

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

• components/ILIAS/ADT/classes/Types/Location/class.ilADTLocation.php