ilMapGUI Class Reference

User interface class for maps. More...

Inheritance diagram for ilMapGUI:

Collaboration diagram for ilMapGUI:

Public Member Functions
	__construct ()
	setMapId (string $map_id)
	getMapId ()
	setWidth (string $width)
	getWidth ()
	setHeight (string $height)
	getHeight ()
	setLatitude (string $latitude)
	getLatitude ()
	setLongitude (string $longitude)
	getLongitude ()
	setZoom (?int $zoom)
	getZoom ()
	setEnableTypeControl (bool $enable_type_control)
	getEnableTypeControl ()
	setEnableNavigationControl (bool $enable_navigation_control)
	getEnableNavigationControl ()
	setEnableUpdateListener (bool $enable_update_listener)
	getEnableUpdateListener ()
	setEnableLargeMapControl (bool $large_map_control)
	getEnableLargeMapControl ()
	setEnableCentralMarker (bool $central_marker)
	getEnableCentralMarker ()
	addUserMarker (int $user_id)
	getHtml ()
	getUserListHtml ()
	Get User List HTML (to be displayed besides the map) More...

Protected Attributes
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
string	$map_id
string	$width
string	$height
string	$latitude
string	$longitude
int	$zoom
bool	$enable_type_control
bool	$enable_update_listener
bool	$enable_navigation_control
array	$user_marker
bool	$large_map_control
bool	$central_marker

Detailed Description

User interface class for maps.

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

Constructor & Destructor Documentation

__construct()

ilMapGUI::__construct

(

)

Definition at line 42 of file class.ilMapGUI.php.

References $DIC, ILIAS\Repository\lng(), and null.

    {
        global $DIC;
        $this->lng = $DIC['lng'];
        $this->tpl = $DIC['tpl'];

        $this->lng->loadLanguageModule("maps");

        $this->map_id = "";
        $this->width = "500px";
        $this->height = "300px";
        $this->latitude = "";
        $this->longitude = "";
        $this->zoom = null;
        $this->enable_type_control = false;
        $this->enable_update_listener = false;
        $this->enable_navigation_control = false;
        $this->user_marker = [];
        $this->large_map_control = false;
        $this->central_marker = false;
    }

Here is the call graph for this function:

Member Function Documentation

addUserMarker()

ilMapGUI::addUserMarker

(

int

$user_id

)

Definition at line 185 of file class.ilMapGUI.php.

References $user_id, getHtml(), and getUserListHtml().

                                               : ilMapGUI
    {
        $this->user_marker[] = $user_id;
        return $this;
    }

Here is the call graph for this function:

getEnableCentralMarker()

ilMapGUI::getEnableCentralMarker

(

)

Definition at line 180 of file class.ilMapGUI.php.

References $central_marker.

Referenced by ilGoogleMapGUI\getHtml(), and ilOpenLayersMapGUI\getHtml().

                                            : bool
    {
        return $this->central_marker;
    }

Here is the caller graph for this function:

getEnableLargeMapControl()

ilMapGUI::getEnableLargeMapControl

(

)

Definition at line 169 of file class.ilMapGUI.php.

References $large_map_control.

Referenced by ilGoogleMapGUI\getHtml().

                                              : bool
    {
        return $this->large_map_control;
    }

Here is the caller graph for this function:

getEnableNavigationControl()

ilMapGUI::getEnableNavigationControl

(

)

Definition at line 147 of file class.ilMapGUI.php.

References $enable_navigation_control.

Referenced by ilGoogleMapGUI\getHtml(), and ilOpenLayersMapGUI\getHtml().

                                                : bool
    {
        return $this->enable_navigation_control;
    }

Here is the caller graph for this function:

getEnableTypeControl()

ilMapGUI::getEnableTypeControl

(

)

Definition at line 136 of file class.ilMapGUI.php.

References $enable_type_control.

Referenced by ilGoogleMapGUI\getHtml().

                                          : bool
    {
        return $this->enable_type_control;
    }

Here is the caller graph for this function:

getEnableUpdateListener()

ilMapGUI::getEnableUpdateListener

(

)

Definition at line 158 of file class.ilMapGUI.php.

References $enable_update_listener.

Referenced by ilGoogleMapGUI\getHtml(), and ilOpenLayersMapGUI\getHtml().

                                             : bool
    {
        return $this->enable_update_listener;
    }

Here is the caller graph for this function:

getHeight()

ilMapGUI::getHeight

(

)

Definition at line 92 of file class.ilMapGUI.php.

References $height.

Referenced by ilGoogleMapGUI\getHtml(), and ilOpenLayersMapGUI\getHtml().

                               : string
    {
        return $this->height;
    }

Here is the caller graph for this function:

getHtml()

ilMapGUI::getHtml ( )

abstract

Referenced by addUserMarker().

Here is the caller graph for this function:

getLatitude()

ilMapGUI::getLatitude

(

)

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

References $latitude.

Referenced by ilGoogleMapGUI\getHtml(), and ilOpenLayersMapGUI\getHtml().

                                 : string
    {
        return $this->latitude;
    }

Here is the caller graph for this function:

getLongitude()

ilMapGUI::getLongitude

(

)

Definition at line 114 of file class.ilMapGUI.php.

References $longitude.

Referenced by ilGoogleMapGUI\getHtml(), and ilOpenLayersMapGUI\getHtml().

                                  : string
    {
        return $this->longitude;
    }

Here is the caller graph for this function:

getMapId()

ilMapGUI::getMapId

(

)

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

References $map_id.

Referenced by ilGoogleMapGUI\getHtml(), ilOpenLayersMapGUI\getHtml(), ilGoogleMapGUI\getUserListHtml(), and ilOpenLayersMapGUI\getUserListHtml().

                              : string
    {
        return $this->map_id;
    }

Here is the caller graph for this function:

getUserListHtml()

ilMapGUI::getUserListHtml ( )

abstract

Get User List HTML (to be displayed besides the map)

Referenced by addUserMarker().

Here is the caller graph for this function:

getWidth()

ilMapGUI::getWidth

(

)

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

References $width.

Referenced by ilGoogleMapGUI\getHtml(), and ilOpenLayersMapGUI\getHtml().

                              : string
    {
        return $this->width;
    }

Here is the caller graph for this function:

getZoom()

ilMapGUI::getZoom

(

)

Definition at line 125 of file class.ilMapGUI.php.

References $zoom.

Referenced by ilGoogleMapGUI\getHtml(), and ilOpenLayersMapGUI\getHtml().

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

Here is the caller graph for this function:

setEnableCentralMarker()

ilMapGUI::setEnableCentralMarker

(

bool

$central_marker

)

Definition at line 174 of file class.ilMapGUI.php.

References $central_marker.

                                                                : ilMapGUI
    {
        $this->central_marker = $central_marker;
        return $this;
    }

setEnableLargeMapControl()

ilMapGUI::setEnableLargeMapControl

(

bool

$large_map_control

)

Definition at line 163 of file class.ilMapGUI.php.

References $large_map_control.

                                                                     : ilMapGUI
    {
        $this->large_map_control = $large_map_control;
        return $this;
    }

setEnableNavigationControl()

ilMapGUI::setEnableNavigationControl

(

bool

$enable_navigation_control

)

Definition at line 141 of file class.ilMapGUI.php.

References $enable_navigation_control.

                                                                               : ilMapGUI
    {
        $this->enable_navigation_control = $enable_navigation_control;
        return $this;
    }

setEnableTypeControl()

ilMapGUI::setEnableTypeControl

(

bool

$enable_type_control

)

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

References $enable_type_control.

                                                                   : ilMapGUI
    {
        $this->enable_type_control = $enable_type_control;
        return $this;
    }

setEnableUpdateListener()

ilMapGUI::setEnableUpdateListener

(

bool

$enable_update_listener

)

Definition at line 152 of file class.ilMapGUI.php.

References $enable_update_listener.

                                                                         : ilMapGUI
    {
        $this->enable_update_listener = $enable_update_listener;
        return $this;
    }

setHeight()

ilMapGUI::setHeight

(

string

$height

)

Definition at line 86 of file class.ilMapGUI.php.

References $height.

                                             : ilMapGUI
    {
        $this->height = $height;
        return $this;
    }

setLatitude()

ilMapGUI::setLatitude

(

string

$latitude

)

Definition at line 97 of file class.ilMapGUI.php.

References $latitude.

                                                 : ilMapGUI
    {
        $this->latitude = $latitude;
        return $this;
    }

setLongitude()

ilMapGUI::setLongitude

(

string

$longitude

)

Definition at line 108 of file class.ilMapGUI.php.

References $longitude.

                                                   : ilMapGUI
    {
        $this->longitude = $longitude;
        return $this;
    }

setMapId()

ilMapGUI::setMapId

(

string

$map_id

)

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

References $map_id.

                                            : ilMapGUI
    {
        $this->map_id = $map_id;
        return $this;
    }

setWidth()

ilMapGUI::setWidth

(

string

$width

)

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

References $width.

                                           : ilMapGUI
    {
        $this->width = $width;
        return $this;
    }

setZoom()

ilMapGUI::setZoom

(

?int

$zoom

)

Definition at line 119 of file class.ilMapGUI.php.

References $zoom.

                                       : ilMapGUI
    {
        $this->zoom = $zoom;
        return $this;
    }

Field Documentation

$central_marker

bool ilMapGUI::$central_marker

protected

Definition at line 40 of file class.ilMapGUI.php.

Referenced by getEnableCentralMarker(), ilGoogleMapGUI\getHtml(), ilOpenLayersMapGUI\getHtml(), and setEnableCentralMarker().

$enable_navigation_control

bool ilMapGUI::$enable_navigation_control

protected

Definition at line 36 of file class.ilMapGUI.php.

Referenced by getEnableNavigationControl(), and setEnableNavigationControl().

$enable_type_control

bool ilMapGUI::$enable_type_control

protected

Definition at line 34 of file class.ilMapGUI.php.

Referenced by getEnableTypeControl(), and setEnableTypeControl().

$enable_update_listener

bool ilMapGUI::$enable_update_listener

protected

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

Referenced by getEnableUpdateListener(), and setEnableUpdateListener().

$height

string ilMapGUI::$height

protected

Definition at line 30 of file class.ilMapGUI.php.

Referenced by getHeight(), and setHeight().

$large_map_control

bool ilMapGUI::$large_map_control

protected

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

Referenced by getEnableLargeMapControl(), ilGoogleMapGUI\getHtml(), and setEnableLargeMapControl().

$latitude

string ilMapGUI::$latitude

protected

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

Referenced by getLatitude(), and setLatitude().

$lng

ilLanguage ilMapGUI::$lng

protected

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

$longitude

string ilMapGUI::$longitude

protected

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

Referenced by getLongitude(), and setLongitude().

$map_id

string ilMapGUI::$map_id

protected

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

Referenced by getMapId(), and setMapId().

$tpl

ilGlobalTemplateInterface ilMapGUI::$tpl

protected

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

$user_marker

array ilMapGUI::$user_marker

protected

Definition at line 38 of file class.ilMapGUI.php.

$width

string ilMapGUI::$width

protected

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

Referenced by getWidth(), and setWidth().

$zoom

int ilMapGUI::$zoom

protected

Definition at line 33 of file class.ilMapGUI.php.

Referenced by getZoom(), and setZoom().

---

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

• components/ILIAS/Maps/classes/class.ilMapGUI.php