ilADTLocationSearchBridgeSingle Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilADTLocationSearchBridgeSingle:

Collaboration diagram for ilADTLocationSearchBridgeSingle:

Public Member Functions
	__construct (ilADTDefinition $a_adt_def)
	loadFilter ()
	addToForm ()
	importFromPost (array $a_post=null)
	isValid ()
	getSQLCondition (string $a_element_id, int $mode=self::SQL_LIKE, array $quotedWords=[])
	getSerializedValue ()
	setSerializedValue (string $a_value)
Public Member Functions inherited from ilADTSearchBridgeSingle
	getADT ()
	Get ADT. More...
	isNull ()
	isValid ()
	validate ()
Public Member Functions inherited from ilADTSearchBridge
	__construct (ilADTDefinition $a_adt_def)
	isNull ()
	setForm (ilPropertyFormGUI $a_form)
	getForm ()
	setElementId (string $a_value)
	getElementId ()
	setTitle (string $a_value)
	getTitle ()
	getSearchColumn ()
	setTableGUI (ilTable2GUI $a_table)
	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)
	validate ()
	Validate current data. More...
	getSQLCondition (string $a_element_id, int $mode=self::SQL_LIKE, array $quotedWords=[])
	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 (string $a_value)
	Set current value(s) in serialized form (for easy persisting) More...

Protected Member Functions
	isValidADTDefinition (ilADTDefinition $a_adt_def)
	shouldBeImportedFromPost ($a_post)
	getBoundingBox (float $a_latitude, float $a_longitude, int $a_radius)
	Get bounding box for location circum search. More...
Protected Member Functions inherited from ilADTSearchBridgeSingle
	setDefinition (ilADTDefinition $a_adt_def)
Protected Member Functions inherited from ilADTSearchBridge
	isValidADTDefinition (ilADTDefinition $a_adt_def)
	setDefinition (ilADTDefinition $a_adt_def)
	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 (string $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
int	$radius = null
bool	$force_valid = false
ilLanguage	$lng
Protected Attributes inherited from ilADTSearchBridgeSingle
ilADT	$adt
Protected Attributes inherited from ilADTSearchBridge
ilPropertyFormGUI	$form = null
ilTable2GUI	$table_gui = null
array	$table_filter_fields = []
string	$id = ''
string	$title = ''
string	$info = ''
ilLanguage	$lng
ilDBInterface	$db
HttpServices	$http

Additional Inherited Members
Data Fields inherited from ilADTSearchBridge
const	SQL_STRICT = 1
const	SQL_LIKE = 2
const	SQL_LIKE_END = 3
const	SQL_LIKE_START = 4
const	DEFAULT_SEARCH_COLUMN = 'value'

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.d.nosp@m.e

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

Constructor & Destructor Documentation

__construct()

ilADTLocationSearchBridgeSingle::__construct

(

ilADTDefinition

$a_adt_def

)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\lng().

    {
        global $DIC;

        $this->lng = $DIC->language();
        parent::__construct($a_adt_def);
    }

Here is the call graph for this function:

Member Function Documentation

addToForm()

ilADTLocationSearchBridgeSingle::addToForm

(

)

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

References ilADTSearchBridgeSingle\$adt, ilADTSearchBridge\addToElementId(), ilADTSearchBridge\addToParentElement(), ilADTSearchBridgeSingle\getADT(), ilMapUtil\getDefaultSettings(), ilADTSearchBridge\getElementId(), ilADTSearchBridge\getTitle(), ilADT\isNull(), ILIAS\Repository\lng(), ilLocationInputGUI\setLongitude(), and ilNumberInputGUI\setSize().

                               : void
    {
        $adt = $this->getADT();

        $default = false;
        if ($adt->isNull()) {
            // see ilPersonalProfileGUI::addLocationToForm()

            // use installation default
            $def = ilMapUtil::getDefaultSettings();
            $adt->setLatitude((float) ($def["latitude"] ?? null));
            $adt->setLongitude((float) ($def["longitude"] ?? null));
            $adt->setZoom((int) ($def["zoom"] ?? 0));

            $default = true;
        }

        $optional = new ilCheckboxInputGUI($this->getTitle(), $this->addToElementId("tgl"));

        if (!$default && !$adt->isNull()) {
            $optional->setChecked(true);
        }

        $loc = new ilLocationInputGUI($this->lng->txt("location"), $this->getElementId());
        $loc->setLongitude($adt->getLongitude());
        $loc->setLatitude($adt->getLatitude());
        $loc->setZoom($adt->getZoom());
        $optional->addSubItem($loc);

        $rad = new ilNumberInputGUI($this->lng->txt("form_location_radius"), $this->addToElementId("rad"));
        $rad->setSize(4);
        $rad->setSuffix($this->lng->txt("form_location_radius_km"));
        $rad->setValue($this->radius);
        $rad->setRequired(true);
        $optional->addSubItem($rad);

        $this->addToParentElement($optional);
    }

Here is the call graph for this function:

getBoundingBox()

ilADTLocationSearchBridgeSingle::getBoundingBox ( float  $a_latitude, float  $a_longitude, int  $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 145 of file class.ilADTLocationSearchBridgeSingle.php.

Referenced by getSQLCondition().

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

Here is the caller graph for this function:

getSerializedValue()

ilADTLocationSearchBridgeSingle::getSerializedValue

(

)

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

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

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

Here is the call graph for this function:

getSQLCondition()

ilADTLocationSearchBridgeSingle::getSQLCondition	(	string	$a_element_id,
		int	$mode = self::SQL_LIKE,
		array	$quotedWords = []
	)

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

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

                                                                                                            : string
    {
        if (!$this->isNull() && $this->isValid()) {
            $box = $this->getBoundingBox(
                $this->getADT()->getLatitude(),
                $this->getADT()->getLongitude(),
                $this->radius
            );

            $res = [];
            $res[] = $a_element_id . "_lat >= " . $this->db->quote($box["lat"]["min"], "float");
            $res[] = $a_element_id . "_lat <= " . $this->db->quote($box["lat"]["max"], "float");
            $res[] = $a_element_id . "_long >= " . $this->db->quote($box["long"]["min"], "float");
            $res[] = $a_element_id . "_long <= " . $this->db->quote($box["long"]["max"], "float");

            return "(" . implode(" AND ", $res) . ")";
        }
        return '';
    }

Here is the call graph for this function:

importFromPost()

ilADTLocationSearchBridgeSingle::importFromPost

(

array

$a_post = null

)

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

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

                                                        : bool
    {
        $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;
        }
        return true;
    }

Here is the call graph for this function:

isValid()

ilADTLocationSearchBridgeSingle::isValid

(

)

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

Referenced by getSerializedValue(), and getSQLCondition().

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

Here is the caller graph for this function:

isValidADTDefinition()

ilADTLocationSearchBridgeSingle::isValidADTDefinition ( ilADTDefinition  $a_adt_def )

protected

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

                                                                       : bool
    {
        return ($a_adt_def instanceof ilADTLocationDefinition);
    }

loadFilter()

ilADTLocationSearchBridgeSingle::loadFilter

(

)

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

References ilADTSearchBridge\readFilter().

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

Here is the call graph for this function:

setSerializedValue()

ilADTLocationSearchBridgeSingle::setSerializedValue

(

string

$a_value

)

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

References ilADTSearchBridgeSingle\getADT(), and ILIAS\Repository\int().

                                                       : void
    {
        $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"];
        }
    }

Here is the call graph for this function:

shouldBeImportedFromPost()

ilADTLocationSearchBridgeSingle::shouldBeImportedFromPost (   $a_post )

protected

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

Referenced by importFromPost().

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

Here is the caller graph for this function:

Field Documentation

$force_valid

bool ilADTLocationSearchBridgeSingle::$force_valid = false

protected

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

$lng

ilLanguage ilADTLocationSearchBridgeSingle::$lng

protected

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

$radius

int ilADTLocationSearchBridgeSingle::$radius = null

protected

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

---

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

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