Inheritance diagram for ilADTLocationSearchBridgeSingle:

Collaboration diagram for ilADTLocationSearchBridgeSingle:

Public Member Functions
	loadFilter ()
	Load filter value(s) into ADT. More...

	addToForm ()
	Add ADT-specific fields to form. More...

	importFromPost (array $a_post=null)
	Import values from (search) form request POST data. More...

	isValid ()

	getSQLCondition ($a_element_id)
	Get SQL condition for current value(s) More...

	getSerializedValue ()
	Get current value(s) in serialized form (for easy persisting) More...

	setSerializedValue ($a_value)
	Set current value(s) in serialized form (for easy persisting) More...

Public Member Functions inherited from ilADTSearchBridgeSingle
	getADT ()
	Get ADT. More...

	isNull ()
	Is null ? More...

	isValid ()

	validate ()
	Validate current data. More...

Public Member Functions inherited from ilADTSearchBridge
	__construct (ilADTDefinition $a_adt_def)
	Constructor. More...

	isNull ()
	Is null ? More...

	setForm (ilPropertyFormGUI $a_form)
	Set form. More...

	getForm ()
	Get form. More...

	setElementId ($a_value)
	Set element id (aka form field) More...

	getElementId ()
	Get element id. More...

	setTitle ($a_value)
	Set title (aka form field caption) More...

	getTitle ()
	Get title. More...

	setTableGUI (ilTable2GUI $a_table)
	Set table gui (for filter mode) More...

	getTableGUI ()
	Get table gui. More...

	loadFilter ()
	Load filter value(s) into ADT. More...

	addToForm ()
	Add ADT-specific fields to form. More...

	importFromPost (array $a_post=null)
	Import values from (search) form request POST data. More...

	validate ()
	Validate current data. More...

	getSQLCondition ($a_element_id)
	Get SQL condition for current value(s) More...

	isInCondition (ilADT $a_adt)
	Compare directly against ADT. More...

	getSerializedValue ()
	Get current value(s) in serialized form (for easy persisting) More...

	setSerializedValue ($a_value)
	Set current value(s) in serialized form (for easy persisting) More...

Protected Member Functions
	isValidADTDefinition (ilADTDefinition $a_adt_def)
	Check if given ADT definition is valid. More...

	shouldBeImportedFromPost ($a_post)
	Check if incoming values should be imported at all. More...

	getBoundingBox ($a_latitude, $a_longitude, $a_radius)
	Get bounding box for location circum search. More...

Protected Member Functions inherited from ilADTSearchBridgeSingle
	setDefinition (ilADTDefinition $a_adt_def)
	Set ADT definition. More...

Protected Member Functions inherited from ilADTSearchBridge
	isValidADTDefinition (ilADTDefinition $a_adt_def)
	Check if given ADT definition is valid. More...

	setDefinition (ilADTDefinition $a_adt_def)
	Set ADT definition. More...

	writeFilter ($a_value=null)
	Write value(s) to filter store (in session) More...

	readFilter ()
	Load value(s) from filter store (in session) More...

	addToParentElement (ilFormPropertyGUI $a_field)
	Add form field to parent element. More...

	addToElementId ($a_add)
	Add sub-element. More...

	shouldBeImportedFromPost ($a_post)
	Check if incoming values should be imported at all. More...

	extractPostValues (array $a_post=null)
	Extract data from (post) values. More...

Protected Attributes
	$radius

Protected Attributes inherited from ilADTSearchBridgeSingle
	$adt

Protected Attributes inherited from ilADTSearchBridge
	$form

	$table_gui

	$table_filter_fields = []

	$id

	$title

	$info

Detailed Description

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

Member Function Documentation

◆ addToForm()

ilADTLocationSearchBridgeSingle::addToForm ( )

Add ADT-specific fields to form.

Reimplemented from ilADTSearchBridge.

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

    {
        global $lng;
        
        $adt = $this->getADT();
        
        $default = false;
        if ($adt->isNull()) {
            // see ilPersonalProfileGUI::addLocationToForm()
            
            // use installation default
            include_once("./Services/Maps/classes/class.ilMapUtil.php");
            $def = ilMapUtil::getDefaultSettings();
            $adt->setLatitude($def["latitude"]);
            $adt->setLongitude($def["longitude"]);
            $adt->setZoom($def["zoom"]);
            
            $default = true;
        }
        
        $optional = new ilCheckboxInputGUI($this->getTitle(), $this->addToElementId("tgl"));
        
        if (!$default && !$adt->isNull()) {
            $optional->setChecked(true);
        }
            
        $loc = new ilLocationInputGUI($lng->txt("location"), $this->getElementId());
        $loc->setLongitude($adt->getLongitude());
        $loc->setLatitude($adt->getLatitude());
        $loc->setZoom($adt->getZoom());
        $optional->addSubItem($loc);
            
        $rad = new ilNumberInputGUI($lng->txt("form_location_radius"), $this->addToElementId("rad"));
        $rad->setSize(4);
        $rad->setSuffix($lng->txt("form_location_radius_km"));
        $rad->setValue($this->radius);
        $rad->setRequired(true);
        $optional->addSubItem($rad);
                
        $this->addToParentElement($optional);
    }

References ilADTSearchBridgeSingle\$adt, $def, $lng, ilADTSearchBridge\addToElementId(), ilADTSearchBridge\addToParentElement(), ilADTSearchBridgeSingle\getADT(), ilMapUtil\getDefaultSettings(), and ilADTSearchBridge\getTitle().

Here is the call graph for this function:

◆ getBoundingBox()

ilADTLocationSearchBridgeSingle::getBoundingBox	(	$a_latitude,
		$a_longitude,
		$a_radius
	)

protected

Get bounding box for location circum search.

Parameters

float	$a_latitude
float	$a_longitude
int	$a_radius

Returns: array

Definition at line 120 of file class.ilADTLocationSearchBridgeSingle.php.

    {
        $earth_radius = 6371;
        
        // http://www.d-mueller.de/blog/umkreissuche-latlong-und-der-radius/
        $max_lat = $a_latitude + rad2deg($a_radius/$earth_radius);
        $min_lat = $a_latitude - rad2deg($a_radius/$earth_radius);
        $max_long = $a_longitude + rad2deg($a_radius/$earth_radius/cos(deg2rad($a_latitude)));
        $min_long = $a_longitude - rad2deg($a_radius/$earth_radius/cos(deg2rad($a_latitude)));
 
        return array(
            "lat" => array("min"=>$min_lat, "max"=>$max_lat)
            ,"long" => array("min"=>$min_long, "max"=>$max_long)
        );
    }

Referenced by getSQLCondition().

Here is the caller graph for this function:

◆ getSerializedValue()

ilADTLocationSearchBridgeSingle::getSerializedValue ( )

Get current value(s) in serialized form (for easy persisting)

Returns: string

Reimplemented from ilADTSearchBridge.

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

    {
        if (!$this->isNull() && $this->isValid()) {
            return serialize(array(
                "lat" => $this->getADT()->getLatitude()
                ,"long" => $this->getADT()->getLongitude()
                ,"zoom" => $this->getADT()->getZoom()
                ,"radius" => (int) $this->radius
            ));
        }
    }

References ilADTSearchBridgeSingle\getADT(), ilADTSearchBridgeSingle\isNull(), and isValid().

Here is the call graph for this function:

◆ getSQLCondition()

ilADTLocationSearchBridgeSingle::getSQLCondition ( $a_element_id )

Get SQL condition for current value(s)

Parameters

string $a_element_id

Returns: string

Reimplemented from ilADTSearchBridge.

Definition at line 139 of file class.ilADTLocationSearchBridgeSingle.php.

    {
        global $ilDB;
        
        if (!$this->isNull() && $this->isValid()) {
            $box = $this->getBoundingBox($this->getADT()->getLatitude(), $this->getADT()->getLongitude(), $this->radius);
                        
            $res = array();
            $res[] = $a_element_id . "_lat >= " . $ilDB->quote($box["lat"]["min"], "float");
            $res[] = $a_element_id . "_lat <= " . $ilDB->quote($box["lat"]["max"], "float");
            $res[] = $a_element_id . "_long >= " . $ilDB->quote($box["long"]["min"], "float");
            $res[] = $a_element_id . "_long <= " . $ilDB->quote($box["long"]["max"], "float");
                
            return "(" . implode(" AND ", $res) . ")";
        }
    }

References $ilDB, $res, ilADTSearchBridgeSingle\getADT(), getBoundingBox(), ilADTSearchBridgeSingle\isNull(), and isValid().

Here is the call graph for this function:

◆ importFromPost()

ilADTLocationSearchBridgeSingle::importFromPost ( array $a_post = null )

Import values from (search) form request POST data.

Returns: bool

Reimplemented from ilADTSearchBridge.

Definition at line 75 of file class.ilADTLocationSearchBridgeSingle.php.

    {
        $post = $this->extractPostValues($a_post);
                
        if ($post && $this->shouldBeImportedFromPost($post)) {
            $tgl = $this->getForm()->getItemByPostVar($this->addToElementId("tgl"));
            $tgl->setChecked(true);
            
            $item = $this->getForm()->getItemByPostVar($this->getElementId());
            $item->setLongitude($post["longitude"]);
            $item->setLatitude($post["latitude"]);
            $item->setZoom($post["zoom"]);
            
            $this->radius = (int) $post["rad"];
                        
            $this->getADT()->setLongitude($post["longitude"]);
            $this->getADT()->setLatitude($post["latitude"]);
            $this->getADT()->setZoom($post["zoom"]);
        } else {
            // optional empty is valid
            $this->force_valid = true;
            
            $this->getADT()->setLongitude(null);
            $this->getADT()->setLatitude(null);
            $this->getADT()->setZoom(null);
            $this->radius = null;
        }
    }

References $post, ilADTSearchBridge\addToElementId(), ilADTSearchBridge\extractPostValues(), ilADTSearchBridgeSingle\getADT(), ilADTSearchBridge\getElementId(), ilADTSearchBridge\getForm(), and shouldBeImportedFromPost().

Here is the call graph for this function:

◆ isValid()

ilADTLocationSearchBridgeSingle::isValid ( )

Reimplemented from ilADTSearchBridgeSingle.

Definition at line 104 of file class.ilADTLocationSearchBridgeSingle.php.

    {
        return (parent::isValid() && ((int) $this->radius || (bool) $this->force_valid));
    }

Referenced by getSerializedValue(), and getSQLCondition().

Here is the caller graph for this function:

◆ isValidADTDefinition()

ilADTLocationSearchBridgeSingle::isValidADTDefinition ( ilADTDefinition $a_adt_def )

protected

Check if given ADT definition is valid.

:TODO: This could be avoided with type-specifc constructors :TODO: bridge base class?

Parameters

ilADTDefinition $a_adt_def

Reimplemented from ilADTSearchBridge.

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

    {
        return ($a_adt_def instanceof ilADTLocationDefinition);
    }

◆ loadFilter()

ilADTLocationSearchBridgeSingle::loadFilter ( )

Load filter value(s) into ADT.

Reimplemented from ilADTSearchBridge.

Definition at line 17 of file class.ilADTLocationSearchBridgeSingle.php.

    {
        $value = $this->readFilter();
        if ($value !== null) {
            // :TODO:
        }
    }

References ilADTSearchBridge\readFilter().

Here is the call graph for this function:

◆ setSerializedValue()

ilADTLocationSearchBridgeSingle::setSerializedValue ( $a_value )

Set current value(s) in serialized form (for easy persisting)

Parameters

string

Reimplemented from ilADTSearchBridge.

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

    {
        $a_value = unserialize($a_value);
        if (is_array($a_value)) {
            $this->getADT()->setLatitude($a_value["lat"]);
            $this->getADT()->setLongitude($a_value["long"]);
            $this->getADT()->setZoom($a_value["zoom"]);
            $this->radius = (int) $a_value["radius"];
        }
    }

References ilADTSearchBridgeSingle\getADT().

Here is the call graph for this function:

◆ shouldBeImportedFromPost()

ilADTLocationSearchBridgeSingle::shouldBeImportedFromPost ( $a_post )

protected

Check if incoming values should be imported at all.

Parameters

mixed $a_post

Returns: bool

Reimplemented from ilADTSearchBridge.

Definition at line 70 of file class.ilADTLocationSearchBridgeSingle.php.

    {
        return (bool) $a_post["tgl"];
    }

Referenced by importFromPost().

Here is the caller graph for this function:

Field Documentation

◆ $radius

ilADTLocationSearchBridgeSingle::$radius

protected

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

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addToForm()

◆ getBoundingBox()

◆ getSerializedValue()

◆ getSQLCondition()

◆ importFromPost()

◆ isValid()

◆ isValidADTDefinition()

◆ loadFilter()

◆ setSerializedValue()

◆ shouldBeImportedFromPost()

Field Documentation

◆ $radius