Database API

Indhold

Bemærk, at der skal udvises forsigtighed, når man manipulerer Maps Marker Pro-databasen direkte via API for at undgå datatab. Alle opkald er øjeblikkelig og kan ikke fortrydes.

Vær også opmærksom på, at vores support ikke dækker detaljerede spørgsmål om brugerdefineret udvikling baseret på denne API.

Brug

For at bruge DB API skal vi først indstille klassen:

$db = new MMP\DB();

Kort returnerer objekter med følgende egenskaber:

id: ID
name: Name
settings: An object containing the map settings (JSON encoded)
filters: An object containing the map filters (JSON encoded)
created_by_id: The ID of the user who created the map
created_on: The date and time when the map was created
updated_by_id: The ID of the user who last updated the map
updated_on: The date and time when the map was last updated
markers: The number of markers that are assigned to this map (if requested)

Markører returnerer objekter med følgende egenskaber:

id: ID
name: Name
address: Address
lat: Latitude
lng: Longitude
zoom: Zoom
icon: Icon filename
popup: Popup contents
link: URL to be opened instead of showing a popup
created_by_id: The ID of the user who created the marker
created_on: The date and time when the marker was created
updated_by_id: The ID of the user who last updated the marker
updated_on: The date and time when the marker was last updated
maps: Array of map IDs that the marker is assigned to

Eksempler

Hent kortet med ID 1, ændre navn, bredde og højde og gem ændringerne

$map = $db->get_map(1);
$map->name = 'Car dealerships';
$settings = json_decode($map->settings);
$settings->width = 640;
$settings->height = 480;
$map->settings = json_encode($settings);
$db->update_map($map, 1);

Hent markøren med ID 1, skift navn, ikon og popup og gem ændringerne

$marker = $db->get_marker(1);
$marker->name = 'Dealership 1';
$marker->icon = 'car.png';
$marker->popup = '<a href="https://example.com">Dealership 1 website</a>';
$db->update_marker($marker, 1);

Metode Reference

create_tables ()

Opretter databasetabellerne


parametre

Denne metode har ingen parametre


Returner værdier

Ingen værdi returneres


Changelog

udgave Beskrivelse
4.0 indført

delete_tables ()

Sletter databasetabellerne


parametre

Denne metode har ingen parametre


Returner værdier

Ingen værdi returneres


Changelog

udgave Beskrivelse
4.0 indført

reset_tables ()

Nulstiller databasetabellerne


parametre

Denne metode har ingen parametre


Returner værdier

Ingen værdi returneres


Changelog

udgave Beskrivelse
4.0 indført

count_maps ($ filtre = array ())

Returnerer det samlede antal kort
Accepterer valgfrit en liste over filtre


parametre

$ filtre
(array) (valgfrit) Liste over filtre

Returner værdier

(int) Samlet antal kort


Changelog

udgave Beskrivelse
4.0 indført

get_map ($ id, $ count = falsk)

Returnerer kortet for det givne ID


parametre

$ id
(int) Kort-ID
$ count
(bool) (valgfrit) Hvorvidt de tildelte markører skal tælles

Returner værdier

(objekt | null) Kortobjekt eller null, hvis der ikke findes noget resultat


Changelog

udgave Beskrivelse
4.0 indført

get_maps ($ id'er, $ count = falsk)

Returnerer kortene for de givne ID'er


parametre

$ id'er
(array | streng) Liste eller CSV af kort-id'er
$ count
(bool) (valgfrit) Hvorvidt de tildelte markører skal tælles

Returner værdier

(array) Liste over kortobjekter


Changelog

udgave Beskrivelse
4.0 indført

get_all_maps ($ count = falsk, $ filtre = array ())

Returnerer alle kort
Accepterer valgfrit en liste over filtre


parametre

$ count
(bool) (valgfrit) Hvorvidt de tildelte markører skal tælles
$ filtre
(array) (valgfrit) Liste over filtre

Returner værdier

(array) Liste over kortobjekter


Changelog

udgave Beskrivelse
4.0 indført

get_map_shortcodes ($ id)

Returnerer alle poster, der bruger en kortkode til det givne kort-ID


parametre

$ id
(int) Kort-ID

Returner værdier

(array) Liste over indlæg


Changelog

udgave Beskrivelse
4.0 indført

add_map ($ data, $ id = 0)

Tilføjer et kort


parametre

$ data
(objekt) Kortdata, der skal skrives
$ id
(int) (valgfrit) ID til det nye kort

Returner værdier

(int | bool) Kort-ID eller forkert, hvis kortet ikke kunne tilføjes


Changelog

udgave Beskrivelse
4.0 indført

add_maps ($ data)

Tilføjer flere kort


parametre

$ data
(array) Liste over kortdata, der skal skrives

Returner værdier

(int | bool) Antal berørte rækker eller forkert, hvis kortene ikke kunne tilføjes


Changelog

udgave Beskrivelse
4.0 indført

update_map ($ data, $ id)

Opdaterer et kort


parametre

$ data
(objekt) Kortdata, der skal skrives
$ id
(int) ID for kortet, der skal opdateres

Returner værdier

(int | bool) Antal berørte rækker eller forkert, hvis kortet ikke kunne opdateres


Changelog

udgave Beskrivelse
4.0 indført

update_maps ($ data, $ id'er)

Opdaterer flere kort


parametre

$ data
(objekt) Kortdata, der skal skrives
$ id'er
(array | streng) Liste eller CSV af kort-id'er

Returner værdier

(int) Antal berørte rækker


Changelog

udgave Beskrivelse
4.0 indført

delete_map ($ id)

Sletter et kort og dets forhold


parametre

$ id
(int) ID på kortet, der skal slettes

Returner værdier

(int | bool) Antal berørte rækker eller forkert, hvis kortet ikke kunne slettes


Changelog

udgave Beskrivelse
4.0 indført

delete_maps ($ id'er)

Sletter flere kort og deres forhold


parametre

$ id'er
(array | streng) Liste eller CSV af kort-id'er

Returner værdier

(int | bool) Antal berørte rækker eller forkert, hvis kortene ikke kunne slettes


Changelog

udgave Beskrivelse
4.0 indført

count_markers ($ filtre = array ())

Returnerer det samlede antal markører
Accepterer valgfrit en liste over filtre


parametre

$ filtre
(array) (valgfrit) Liste over filtre

Returner værdier

(int) Samlet antal markører


Changelog

udgave Beskrivelse
4.0 indført

count_map_markers ($ id)

Returnerer det samlede antal markører for det givne kort-ID


parametre

$ id
(int) Kort-ID

Returner værdier

(int) Samlet antal markører for det givne kort-ID


Changelog

udgave Beskrivelse
4.0 indført

get_marker ($ id)

Returnerer markøren for det givne ID


parametre

$ id
(int) Markør-ID

Returner værdier

(objekt | null) Markørobjekt eller null, hvis der ikke findes noget resultat


Changelog

udgave Beskrivelse
4.0 indført

get_markers ($ id'er)

Returnerer markørerne for de givne ID'er


parametre

$ id'er
(array | streng) Liste eller CSV for markør-id'er

Returner værdier

(array) Liste over markørobjekter


Changelog

udgave Beskrivelse
4.0 indført

get_all_markers ($ filtre = array ())

Returnerer alle markører
Accepterer valgfrit en liste over filtre


parametre

$ filtre
(array) (valgfrit) Liste over filtre

Returner værdier

(array) Liste over markørobjekter


Changelog

udgave Beskrivelse
4.0 indført

get_map_markers ($ id)

Returnerer markørerne for det givne kort-id


parametre

$ id
(int) Kort-ID

Returner værdier

(array) Liste over markørobjekter


Changelog

udgave Beskrivelse
4.0 indført

get_maps_markers ($ id'er)

Returnerer markørerne for de givne kort-id'er


parametre

$ id'er
(int) Kort-id'er

Returner værdier

(array) Liste over markørobjekter


Changelog

udgave Beskrivelse
4.0 indført

add_marker ($ data, $ id = 0)

Tilføjer en markør


parametre

$ data
(objekt) Markørdata, der skal skrives
$ id
(int) (valgfrit) ID for den nye markør

Returner værdier

(int | bool) Markør-ID eller falsk, hvis markøren ikke kunne tilføjes


Changelog

udgave Beskrivelse
4.0 indført

add_markers ($ data)

Tilføjer flere markører


parametre

$ data
(array) Liste over markørdata, der skal skrives

Returner værdier

(int | bool) Antal berørte rækker eller forkert, hvis markørerne ikke kunne tilføjes


Changelog

udgave Beskrivelse
4.0 indført

update_marker ($ data, $ id)

Opdaterer en markør


parametre

$ data
(objekt) Markørdata, der skal skrives
$ id
(int) ID for markøren, der skal opdateres

Returner værdier

(int | bool) Antal berørte rækker eller forkert, hvis markøren ikke kunne opdateres


Changelog

udgave Beskrivelse
4.0 indført

update_markers ($ data, $ id'er)

Opdaterer flere markører


parametre

$ data
(objekt) Markørdata, der skal skrives
$ id'er
(array | streng) Liste eller CSV for markør-id'er

Returner værdier

(int | bool) Antal berørte rækker eller forkert, hvis markørerne ikke kunne opdateres


Changelog

udgave Beskrivelse
4.0 indført

assign_marker ($ MAP_ID, $ marker_id)

Tildeler en markør til et kort


parametre

$ MAP_ID
(int) Kort-ID
$ marker_id
(int) Markør-ID

Returner værdier

(int | bool) Antal berørte rækker eller falsk, hvis markøren ikke kunne tildeles


Changelog

udgave Beskrivelse
4.0 indført

assign_markers ($ MAP_ID, $ marker_ids)

Tildeler flere markører til et kort


parametre

$ MAP_ID
(int) Kort-ID
$ marker_ids
(array | streng) Liste eller CSV for markør-id'er

Returner værdier

(int | bool) Antal berørte rækker eller forkert, hvis markørerne ikke kunne tildeles


Changelog

udgave Beskrivelse
4.0 indført

assign_maps_marker ($ map_ids, $ marker_id)

Tildeler en markør til flere kort


parametre

$ map_ids
(array | streng) Liste eller CSV af kort-id'er
$ marker_id
(int) Markør-ID

Returner værdier

(int | bool) Antal berørte rækker eller falsk, hvis markøren ikke kunne tildeles


Changelog

udgave Beskrivelse
4.0 indført

assign_maps_markers ($ map_ids, $ marker_ids)

Tildeler flere markører til flere kort


parametre

$ map_ids
(array | streng) Liste eller CSV af kort-id'er
$ marker_ids
(array | streng) Liste eller CSV for markør-id'er

Returner værdier

(int | bool) Antal berørte rækker eller forkert, hvis markørerne ikke kunne tildeles


Changelog

udgave Beskrivelse
4.0 indført

assign_assoc ($ Assoc)

Tildeler markører fra en tilknyttet liste


parametre

$ Assoc
(array) Associativ liste over markør-ID => kort-id'er

Returner værdier

(int | bool) Antal berørte rækker eller forkert, hvis markørerne ikke kunne tildeles


Changelog

udgave Beskrivelse
4.9 indført

unassign_marker ($ MAP_ID, $ marker_id)

Fravælger en markør fra et kort


parametre

$ MAP_ID
(int) Kort-ID
$ marker_id
(int) Markør-ID

Returner værdier

(int | bool) Antal berørte rækker eller falsk, hvis markøren ikke kunne tildeles


Changelog

udgave Beskrivelse
4.0 indført

unassign_markers ($ MAP_ID, $ marker_ids)

Fravælger flere markører fra et kort


parametre

$ MAP_ID
(int) Kort-ID
$ marker_ids
(array | streng) Liste eller CSV for markør-id'er

Returner værdier

(int | bool) Antal berørte rækker eller forkert, hvis markørerne ikke kunne tildeles


Changelog

udgave Beskrivelse
4.0 indført

unassign_maps_marker ($ map_ids, $ marker_id)

Fravælger en markør fra flere kort


parametre

$ map_ids
(array | streng) Liste eller CSV af kort-id'er
$ marker_id
(int) Markør-ID

Returner værdier

(int | bool) Antal berørte rækker eller falsk, hvis markøren ikke kunne tildeles


Changelog

udgave Beskrivelse
4.0 indført

unassign_all_markers ($ MAP_ID)

Fravælger alle markører fra et kort


parametre

$ MAP_ID
(int) Kort-ID

Returner værdier

(int | bool) Antal berørte rækker eller forkert, hvis markørerne ikke kunne tildeles


Changelog

udgave Beskrivelse
4.0 indført

delete_marker ($ id)

Sletter en markør og dens forhold


parametre

$ id
(int) ID for markøren, der skal slettes

Returner værdier

(int | bool) Antal berørte rækker eller falsk, hvis markøren ikke kunne slettes


Changelog

udgave Beskrivelse
4.0 indført

delete_markers ($ id'er)

Sletter flere markører og deres forhold


parametre

$ id'er
(array | streng) Liste eller CSV for markør-id'er

Returner værdier

(int | bool) Antal berørte rækker eller forkert, hvis markørerne ikke kunne slettes


Changelog

udgave Beskrivelse
4.0 indført

get_layer ($ id)

Returnerer laget for det givne ID


parametre

$ id
(int) Lag-id

Returner værdier

(objekt | null) Lagobjekt eller null, hvis der ikke findes noget resultat


Changelog

udgave Beskrivelse
4.0 indført

get_all_layers ()

Returnerer alle lag


parametre

Denne metode har ingen parametre


Returner værdier

(array) Liste over lagobjekter


Changelog

udgave Beskrivelse
4.0 indført

get_all_basemaps ()

Returnerer alle basemaps


parametre

Denne metode har ingen parametre


Returner værdier

(array) Liste over lagobjekter


Changelog

udgave Beskrivelse
4.0 indført

get_all_overlays ()

Returnerer alle overlays


parametre

Denne metode har ingen parametre


Returner værdier

(array) Liste over lagobjekter


Changelog

udgave Beskrivelse
4.0 indført

add_layer ($ data, $ id = 0)

Tilføjer et lag


parametre

$ data
(objekt) Lagdata, der skal skrives
$ id
(int) (valgfrit) ID for det nye lag

Returner værdier

(int | bool) Lag-id eller falsk, hvis laget ikke kunne tilføjes


Changelog

udgave Beskrivelse
4.0 indført

update_layer ($ data, $ id)

Opdaterer et lag


parametre

$ data
(objekt) Lagdata, der skal skrives
$ id
(int) ID for det lag, der skal opdateres

Returner værdier

(int | bool) Antal berørte rækker eller forkert, hvis laget ikke kunne opdateres


Changelog

udgave Beskrivelse
4.0 indført

delete_layer ($ id)

Sletter et lag


parametre

$ id
(int) Lag-id

Returner værdier

(int | bool) Antal berørte rækker eller forkert, hvis laget ikke kunne slettes


Changelog

udgave Beskrivelse
4.0 indført

delete_orphaned_rels ()

Sletter forældreløse forhold


parametre

Denne metode har ingen parametre


Returner værdier

(int | bool) Antal berørte rækker eller forkert, hvis forældreløse børn ikke kunne slettes


Changelog

udgave Beskrivelse
4.7 indført

build_marker ($ data, $ GeoJSON = falsk)

Bygger et gyldigt markørobjekt


parametre

$ data
(array) Liste over markørdata
$ GeoJSON
(bool) (valgfrit) Om dataene er i GeoJSON-format

Returner værdier

(array) Markørobjekt


Changelog

udgave Beskrivelse
4.9 indført

sanitize_ids ($ id'er, $ csv = falsk)

Saniserer en matrix eller kommasepareret liste over ID'er


parametre

$ id'er
(array | streng) Liste eller CSV af ID'er
$ csv
(bool) (valgfrit) Om man skal returnere de desinficerede id'er som CSV

Returner værdier

(array | streng) Liste eller CSV over desinficerede ID'er


Changelog

udgave Beskrivelse
4.0 indført

prepare_layers ()

Returnerer lagene tabel sanering regler for at udarbejde udsagn


parametre

Denne metode har ingen parametre


Returner værdier

(array) Liste over saneringsregler (kolonne => regel)


Changelog

udgave Beskrivelse
4.0 indført

prepare_maps ()

Returnerer sanitetsreglerne for korttabellerne til udarbejdelse af udsagn


parametre

Denne metode har ingen parametre


Returner værdier

(array) Liste over saneringsregler (kolonne => regel)


Changelog

udgave Beskrivelse
4.0 indført

prepare_markers ()

Returnerer markørens tabel Sanitetsregler for udarbejdelse af udsagn


parametre

Denne metode har ingen parametre


Returner værdier

(array) Liste over saneringsregler (kolonne => regel)


Changelog

udgave Beskrivelse
4.0 indført

prepare_rels ()

Returnerer sanitetsreglerne for forholdstabellen til udarbejdelse af udsagn


parametre

Denne metode har ingen parametre


Returner værdier

(array) Liste over saneringsregler (kolonne => regel)


Changelog

udgave Beskrivelse
4.0 indført
3
2
12005
Bedøm denne reference
en English
X