Database API

innhold

Vær oppmerksom på at det må utvises forsiktighet når du manipulerer Maps Marker Pro-databasen direkte via API for å unngå tap av data. Alle samtaler er øyeblikkelig og kan ikke angre.

Vær også oppmerksom på at støtten vår ikke dekker detaljerte spørsmål om tilpasset utvikling basert på denne API-en.

bruk

For å bruke DB API, må vi først innstille klassen:

$db = new MMP\DB();

Kart returnerer objekter med følgende egenskaper:

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 egenskaper:

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

Få kartet med ID 1, endre navn, bredde og høyde og lagre endringene

$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);

Få markøren med ID 1, endre navn, ikon og popup og lagre endringene

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

create_tables ()

Oppretter databasetabellene


parametere

Denne metoden har ingen parametere


Returnere verdier

Ingen verdi returneres


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

delete_tables ()

Sletter databasetabellene


parametere

Denne metoden har ingen parametere


Returnere verdier

Ingen verdi returneres


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

reset_tables ()

Tilbakestiller databasetabellene


parametere

Denne metoden har ingen parametere


Returnere verdier

Ingen verdi returneres


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

count_maps ($ filtre = array ())

Returnerer det totale antallet kart
Godtar valgfritt en liste over filtre


parametere

$ filtre
(matrise) (valgfritt) Liste over filtre

Returnere verdier

(int) Totalt antall kart


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

get_map ($ id, $ count = falsk)

Returnerer kartet for gitt ID


parametere

$ id
(int) Kart-ID
$ count
(bool) (valgfritt) Hvorvidt du skal telle de tildelte markørene

Returnere verdier

(objekt | null) Kartobjekt eller null hvis ingen resultat blir funnet


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

get_maps ($ ids, $ count = falsk)

Returnerer kartene for de gitte ID-ene


parametere

$ ids
(matrise | streng) Liste eller CSV av kart-IDer
$ count
(bool) (valgfritt) Hvorvidt du skal telle de tildelte markørene

Returnere verdier

(matrise) Liste over kartobjekter


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

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

Returnerer alle kartene
Godtar valgfritt en liste over filtre


parametere

$ count
(bool) (valgfritt) Hvorvidt du skal telle de tildelte markørene
$ filtre
(matrise) (valgfritt) Liste over filtre

Returnere verdier

(matrise) Liste over kartobjekter


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

get_map_shortcodes ($ id)

Returnerer alle innlegg som bruker en kortkode for den gitte kart-IDen


parametere

$ id
(int) Kart-ID

Returnere verdier

(matrise) Liste over innlegg


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

add_map ($ data, $ id = 0)

Legger til et kart


parametere

$ data
(objekt) Kartdata som skal skrives
$ id
(int) (valgfritt) ID for det nye kartet

Returnere verdier

(int | bool) Kart-ID eller usant hvis kartet ikke kunne legges til


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

add_maps ($ data)

Legger til flere kart


parametere

$ data
(matrise) Liste over kartdata som skal skrives

Returnere verdier

(int | bool) Antall berørte rader eller falske hvis kartene ikke kunne legges til


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

update_map ($ data, $ id)

Oppdaterer et kart


parametere

$ data
(objekt) Kartdata som skal skrives
$ id
(int) ID for kartet som skal oppdateres

Returnere verdier

(int | bool) Antall berørte rader eller usant hvis kartet ikke kunne oppdateres


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

update_maps ($ data, $ ids)

Oppdaterer flere kart


parametere

$ data
(objekt) Kartdata som skal skrives
$ ids
(matrise | streng) Liste eller CSV av kart-IDer

Returnere verdier

(int) Antall berørte rader


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

delete_map ($ id)

Sletter et kart og dets forhold


parametere

$ id
(int) ID for kartet som skal slettes

Returnere verdier

(int | bool) Antall berørte rader eller usant hvis kartet ikke kunne slettes


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

delete_maps ($ ids)

Sletter flere kart og deres forhold


parametere

$ ids
(matrise | streng) Liste eller CSV av kart-IDer

Returnere verdier

(int | bool) Antall berørte rader eller falske hvis kartene ikke kunne slettes


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

count_markers ($ filtre = array ())

Returnerer det totale antallet markører
Godtar valgfritt en liste over filtre


parametere

$ filtre
(matrise) (valgfritt) Liste over filtre

Returnere verdier

(int) Totalt antall markører


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

count_map_markers ($ id)

Returnerer det totale antallet markører for den gitte kart-IDen


parametere

$ id
(int) Kart-ID

Returnere verdier

(int) Totalt antall markører for gitt kart-ID


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

get_marker ($ id)

Returnerer markøren for gitt ID


parametere

$ id
(int) Markør-ID

Returnere verdier

(objekt | null) Markørobjekt eller null hvis intet resultat blir funnet


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

get_markers ($ ids)

Returnerer markørene for de gitte ID-ene


parametere

$ ids
(matrise | streng) Liste eller CSV for markør-ID-er

Returnere verdier

(matrise) Liste over markørobjekter


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

get_all_markers ($ filtre = array ())

Returnerer alle markører
Godtar valgfritt en liste over filtre


parametere

$ filtre
(matrise) (valgfritt) Liste over filtre

Returnere verdier

(matrise) Liste over markørobjekter


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

get_map_markers ($ id)

Returnerer markørene for den gitte kart-IDen


parametere

$ id
(int) Kart-ID

Returnere verdier

(matrise) Liste over markørobjekter


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

get_maps_markers ($ ids)

Returnerer markørene for de gitte kart-ID-ene


parametere

$ ids
(int) Kart-ID-er

Returnere verdier

(matrise) Liste over markørobjekter


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

add_marker ($ data, $ id = 0)

Legger til en markør


parametere

$ data
(objekt) Markørdata som skal skrives
$ id
(int) (valgfritt) ID for den nye markøren

Returnere verdier

(int | bool) Markør-ID eller falsk hvis markøren ikke kunne legges til


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

add_markers ($ data)

Legger til flere markører


parametere

$ data
(matrise) Liste over markørdata som skal skrives

Returnere verdier

(int | bool) Antall berørte rader eller falske hvis markørene ikke kunne legges til


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

update_marker ($ data, $ id)

Oppdaterer en markør


parametere

$ data
(objekt) Markørdata som skal skrives
$ id
(int) ID for markøren som skal oppdateres

Returnere verdier

(int | bool) Antall berørte rader eller usann hvis markøren ikke kunne oppdateres


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

update_markers ($ data, $ ids)

Oppdaterer flere markører


parametere

$ data
(objekt) Markørdata som skal skrives
$ ids
(matrise | streng) Liste eller CSV for markør-ID-er

Returnere verdier

(int | bool) Antall berørte rader eller falske hvis markørene ikke kunne oppdateres


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

assign_marker ($ map_id, $ marker_id)

Tilordner en markør til et kart


parametere

$ map_id
(int) Kart-ID
$ marker_id
(int) Markør-ID

Returnere verdier

(int | bool) Antall berørte rader eller usann hvis markøren ikke kunne tilordnes


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

assign_markers ($ map_id, $ marker_ids)

Tilordner flere markører til et kart


parametere

$ map_id
(int) Kart-ID
$ marker_ids
(matrise | streng) Liste eller CSV for markør-ID-er

Returnere verdier

(int | bool) Antall berørte rader eller falske hvis markørene ikke kunne tilordnes


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

assign_maps_marker ($ map_ids, $ marker_id)

Tilordner en markør til flere kart


parametere

$ map_ids
(matrise | streng) Liste eller CSV av kart-IDer
$ marker_id
(int) Markør-ID

Returnere verdier

(int | bool) Antall berørte rader eller usann hvis markøren ikke kunne tilordnes


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

assign_maps_markers ($ map_ids, $ marker_ids)

Tilordner flere markører til flere kart


parametere

$ map_ids
(matrise | streng) Liste eller CSV av kart-IDer
$ marker_ids
(matrise | streng) Liste eller CSV for markør-ID-er

Returnere verdier

(int | bool) Antall berørte rader eller falske hvis markørene ikke kunne tilordnes


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

assign_assoc ($ tilkn)

Tildeler markører fra en tilknyttet liste


parametere

$ tilkn
(matrise) Assosiativ liste over markør-ID => kart-IDer

Returnere verdier

(int | bool) Antall berørte rader eller falske hvis markørene ikke kunne tilordnes


endrings~~POS=TRUNC

Versjon Beskrivelse
4.9 introdusert

unassign_marker ($ map_id, $ marker_id)

Tildeler en markør fra et kart


parametere

$ map_id
(int) Kart-ID
$ marker_id
(int) Markør-ID

Returnere verdier

(int | bool) Antall berørte rader eller usann hvis markøren ikke kunne tilordnes


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

unassign_markers ($ map_id, $ marker_ids)

Tilordner flere markører fra et kart


parametere

$ map_id
(int) Kart-ID
$ marker_ids
(matrise | streng) Liste eller CSV for markør-ID-er

Returnere verdier

(int | bool) Antall berørte rader eller falske hvis markørene ikke kunne tilordnes


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

unassign_maps_marker ($ map_ids, $ marker_id)

Tildeler en markør fra flere kart


parametere

$ map_ids
(matrise | streng) Liste eller CSV av kart-IDer
$ marker_id
(int) Markør-ID

Returnere verdier

(int | bool) Antall berørte rader eller usann hvis markøren ikke kunne tilordnes


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

unassign_all_markers ($ map_id)

Tilordner ikke alle markører fra et kart


parametere

$ map_id
(int) Kart-ID

Returnere verdier

(int | bool) Antall berørte rader eller falske hvis markørene ikke kunne tilordnes


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

delete_marker ($ id)

Sletter en markør og dens forhold


parametere

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

Returnere verdier

(int | bool) Antall berørte rader eller usann hvis markøren ikke kunne slettes


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

delete_markers ($ ids)

Sletter flere markører og deres forhold


parametere

$ ids
(matrise | streng) Liste eller CSV for markør-ID-er

Returnere verdier

(int | bool) Antall berørte rader eller falske hvis markørene ikke kunne slettes


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

get_layer ($ id)

Returnerer laget for gitt ID


parametere

$ id
(int) Lag-ID

Returnere verdier

(objekt | null) Lagobjekt eller null hvis ingen resultat blir funnet


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

get_all_layers ()

Returnerer alle lag


parametere

Denne metoden har ingen parametere


Returnere verdier

(matrise) Liste over lagobjekter


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

get_all_basemaps ()

Returnerer alle basekart


parametere

Denne metoden har ingen parametere


Returnere verdier

(matrise) Liste over lagobjekter


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

get_all_overlays ()

Returnerer alle overlegg


parametere

Denne metoden har ingen parametere


Returnere verdier

(matrise) Liste over lagobjekter


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

add_layer ($ data, $ id = 0)

Legger til et lag


parametere

$ data
(objekt) Lagdata som skal skrives
$ id
(int) (valgfri) ID for det nye laget

Returnere verdier

(int | bool) Lag-ID eller falsk hvis laget ikke kunne legges til


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

update_layer ($ data, $ id)

Oppdaterer et lag


parametere

$ data
(objekt) Lagdata som skal skrives
$ id
(int) ID på laget som skal oppdateres

Returnere verdier

(int | bool) Antall berørte rader eller usant hvis laget ikke kunne oppdateres


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

delete_layer ($ id)

Sletter et lag


parametere

$ id
(int) Lag-ID

Returnere verdier

(int | bool) Antall berørte rader eller usant hvis laget ikke kunne slettes


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

delete_orphaned_rels ()

Sletter foreldreløse forhold


parametere

Denne metoden har ingen parametere


Returnere verdier

(int | bool) Antall berørte rader eller usanne hvis foreldreløse ikke kunne slettes


endrings~~POS=TRUNC

Versjon Beskrivelse
4.7 introdusert

build_marker ($ data, $ GeoJSON = falsk)

Bygger et gyldig markørobjekt


parametere

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

Returnere verdier

(matrise) Markørobjekt


endrings~~POS=TRUNC

Versjon Beskrivelse
4.9 introdusert

sanitize_ids ($ ids, $ csv = falsk)

Sanitiserer en matrise eller komma-separert liste over ID-er


parametere

$ ids
(matrise | streng) Liste eller CSV av IDer
$ csv
(bool) (valgfritt) Om du vil returnere de desinfiserte ID-ene som CSV

Returnere verdier

(matrise | streng) Liste eller CSV med desinfiserte ID-er


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

prepare_layers ()

Returnerer lagene om desinfiseringsregler for lagene


parametere

Denne metoden har ingen parametere


Returnere verdier

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


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

prepare_maps ()

Returnerer sanitetsregler for karttabellen for å utarbeide uttalelser


parametere

Denne metoden har ingen parametere


Returnere verdier

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


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

prepare_markers ()

Returnerer markørens tabell sanitetsregler for å utarbeide uttalelser


parametere

Denne metoden har ingen parametere


Returnere verdier

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


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert

prepare_rels ()

Returnerer sanitetsregler for forholdstabellen for å utarbeide uttalelser


parametere

Denne metoden har ingen parametere


Returnere verdier

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


endrings~~POS=TRUNC

Versjon Beskrivelse
4.0 introdusert
3
2
11932
Ranger denne referansen
en English
X