Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This Field Type represents a geographical location.
| Name | Internal name | Expected input |
|---|---|---|
MapLocation | ezgmaplocation | mixed |
Description
This Field Type makes possible to store and retrieve a geographical location.
As input it expects two float values, latitude, longitude, and a string value in third place, corresponding to the name or address of the location.
PHP API Field Type
Input expectations
| Type | Example |
|---|---|
array | array( 'latitude' => 59.928732, 'longitude' => 10.777888, 'address' => "eZ Systems Norge" ) |
Value object
Properties
The Value class of this Field Type contains the following properties:
| Property | Type | Description |
|---|---|---|
$latitude | float | This property will store the latitude value of the map location reference. |
$longitude | float | This property will store the longitude value of the map location reference. |
$address | string | This property will store the address of map location. |
Constructor
The MapLocation\Value constructor will initialize a new Value object with the values provided. Two floats and a string are expected.
| Code Block | ||||
|---|---|---|---|---|
| ||||
// Instantiates a MapLocation Value object $MapLocationValue = new MapLocation\Value( 59.928732, 10.777888, "eZ Systems Norge" ); |
Template rendering
The template called by the ez_render_field() Twig function while rendering a Map Location field accepts the following the parameters:
| Parameter | Type | Default | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
mapType | string | "ROADMAP" | One of the GMap type of map | ||||||
showMap | boolean | true | Whether to show a Google Map | ||||||
showInfo | booolean | true | Whether to show a latitude, longitude and the address outside of the map | ||||||
zoom | integer | 13 | The initial zoom level on the map | ||||||
draggable | boolean | true | Whether to enable draggable map | ||||||
width | string|false | "500px" | The width of the rendered map with its unit (for example "500px" or "50em"), set to false to not set any width style inline. | ||||||
height | string|false | "200px" | The height of the rendered map with its unit (for example "200px" or "20em"), set to false to not set any height style inline. | ||||||
| scrollWheel | boolean | true |
|
Example:
| Code Block |
|---|
{{ ez_render_field(content, 'location', {'parameters': {'width': '100%', 'height': '330px', 'showMap': true, 'showInfo': false}}) }} |
Configuration
| Status | ||||
|---|---|---|---|---|
|
| Config | Site Access/Group aware | Description |
|---|---|---|
| api_keys.google_maps | yes | Google maps requires use of a API key for severing maps to web pages, this setting allows you to specify your personal Google Maps API key used during template rendering. |
Example use:
| Code Block | ||
|---|---|---|
| ||
ezpublish:
system:
site_group:
api_keys: { google_maps: "MY_KEY" } |