ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
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 ( )

Reimplemented in ilGoogleMapGUI, and ilOpenLayersMapGUI.

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

43 {
44 global $DIC;
45 $this->lng = $DIC['lng'];
46 $this->tpl = $DIC['tpl'];
47
48 $this->lng->loadLanguageModule("maps");
49
50 $this->map_id = "";
51 $this->width = "500px";
52 $this->height = "300px";
53 $this->latitude = "";
54 $this->longitude = "";
55 $this->zoom = null;
56 $this->enable_type_control = false;
57 $this->enable_update_listener = false;
58 $this->enable_navigation_control = false;
59 $this->user_marker = [];
60 $this->large_map_control = false;
61 $this->central_marker = false;
62 }
global $DIC
Definition: shib_login.php:26

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

+ 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.

185 : ilMapGUI
186 {
187 $this->user_marker[] = $user_id;
188 return $this;
189 }
User interface class for maps.

References $user_id.

◆ getEnableCentralMarker()

ilMapGUI::getEnableCentralMarker ( )

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

180 : bool
181 {
183 }
bool $central_marker

References $central_marker.

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

+ Here is the caller graph for this function:

◆ getEnableLargeMapControl()

ilMapGUI::getEnableLargeMapControl ( )

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

169 : bool
170 {
172 }
bool $large_map_control

References $large_map_control.

Referenced by ilGoogleMapGUI\getHtml().

+ Here is the caller graph for this function:

◆ getEnableNavigationControl()

ilMapGUI::getEnableNavigationControl ( )

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

147 : bool
148 {
150 }
bool $enable_navigation_control

References $enable_navigation_control.

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

+ Here is the caller graph for this function:

◆ getEnableTypeControl()

ilMapGUI::getEnableTypeControl ( )

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

136 : bool
137 {
139 }
bool $enable_type_control

References $enable_type_control.

Referenced by ilGoogleMapGUI\getHtml().

+ Here is the caller graph for this function:

◆ getEnableUpdateListener()

ilMapGUI::getEnableUpdateListener ( )

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

158 : bool
159 {
161 }
bool $enable_update_listener

References $enable_update_listener.

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

+ Here is the caller graph for this function:

◆ getHeight()

ilMapGUI::getHeight ( )

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

92 : string
93 {
94 return $this->height;
95 }
string $height

References $height.

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

+ Here is the caller graph for this function:

◆ getHtml()

ilMapGUI::getHtml ( )
abstract

Reimplemented in ilGoogleMapGUI, and ilOpenLayersMapGUI.

◆ getLatitude()

ilMapGUI::getLatitude ( )

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

103 : string
104 {
105 return $this->latitude;
106 }
string $latitude

References $latitude.

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

+ Here is the caller graph for this function:

◆ getLongitude()

ilMapGUI::getLongitude ( )

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

114 : string
115 {
116 return $this->longitude;
117 }
string $longitude

References $longitude.

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

+ Here is the caller graph for this function:

◆ getMapId()

ilMapGUI::getMapId ( )

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

70 : string
71 {
72 return $this->map_id;
73 }
string $map_id

References $map_id.

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

+ Here is the caller graph for this function:

◆ getUserListHtml()

ilMapGUI::getUserListHtml ( )
abstract

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

Reimplemented in ilGoogleMapGUI, and ilOpenLayersMapGUI.

◆ getWidth()

ilMapGUI::getWidth ( )

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

81 : string
82 {
83 return $this->width;
84 }
string $width

References $width.

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

+ Here is the caller graph for this function:

◆ getZoom()

ilMapGUI::getZoom ( )

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

125 : ?int
126 {
127 return $this->zoom;
128 }

References $zoom.

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

+ Here is the caller graph for this function:

◆ setEnableCentralMarker()

ilMapGUI::setEnableCentralMarker ( bool  $central_marker)

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

174 : ilMapGUI
175 {
176 $this->central_marker = $central_marker;
177 return $this;
178 }

References $central_marker.

◆ setEnableLargeMapControl()

ilMapGUI::setEnableLargeMapControl ( bool  $large_map_control)

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

163 : ilMapGUI
164 {
165 $this->large_map_control = $large_map_control;
166 return $this;
167 }

References $large_map_control.

◆ setEnableNavigationControl()

ilMapGUI::setEnableNavigationControl ( bool  $enable_navigation_control)

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

141 : ilMapGUI
142 {
143 $this->enable_navigation_control = $enable_navigation_control;
144 return $this;
145 }

References $enable_navigation_control.

◆ setEnableTypeControl()

ilMapGUI::setEnableTypeControl ( bool  $enable_type_control)

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

130 : ilMapGUI
131 {
132 $this->enable_type_control = $enable_type_control;
133 return $this;
134 }

References $enable_type_control.

◆ setEnableUpdateListener()

ilMapGUI::setEnableUpdateListener ( bool  $enable_update_listener)

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

152 : ilMapGUI
153 {
154 $this->enable_update_listener = $enable_update_listener;
155 return $this;
156 }

References $enable_update_listener.

◆ setHeight()

ilMapGUI::setHeight ( string  $height)

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

86 : ilMapGUI
87 {
88 $this->height = $height;
89 return $this;
90 }

References $height.

◆ setLatitude()

ilMapGUI::setLatitude ( string  $latitude)

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

97 : ilMapGUI
98 {
99 $this->latitude = $latitude;
100 return $this;
101 }

References $latitude.

◆ setLongitude()

ilMapGUI::setLongitude ( string  $longitude)

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

108 : ilMapGUI
109 {
110 $this->longitude = $longitude;
111 return $this;
112 }

References $longitude.

◆ setMapId()

ilMapGUI::setMapId ( string  $map_id)

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

64 : ilMapGUI
65 {
66 $this->map_id = $map_id;
67 return $this;
68 }

References $map_id.

◆ setWidth()

ilMapGUI::setWidth ( string  $width)

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

75 : ilMapGUI
76 {
77 $this->width = $width;
78 return $this;
79 }

References $width.

◆ setZoom()

ilMapGUI::setZoom ( ?int  $zoom)

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

119 : ilMapGUI
120 {
121 $this->zoom = $zoom;
122 return $this;
123 }

References $zoom.

Field Documentation

◆ $central_marker

bool ilMapGUI::$central_marker
protected

◆ $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

◆ $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: