Datenbank-API

ReferenzVeröffentlicht am 26. Oktober 20163. Juli 2020In APIs

Contents [show]

1 Anwendungsbereich
2 Beispiele
3 Methodenreferenz

Bitte beachten Sie, dass bei der direkten Bearbeitung der Maps Marker Pro-Datenbank über die API Vorsicht geboten ist, um Datenverlust zu vermeiden. Alle Anrufe sind sofort und können nicht rückgängig gemacht werden.

Bitte beachten Sie auch, dass unser Support keine detaillierten Fragen zur benutzerdefinierten Entwicklung auf der Grundlage dieser API abdeckt.

Anwendungsbereich

Um die DB-API zu verwenden, müssen wir zuerst die Klasse instanziieren:

$db = new MMP\DB();

Maps geben Objekte mit den folgenden Eigenschaften zurück:

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)

Marker geben Objekte mit den folgenden Eigenschaften zurück:

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

Beispiele

Holen Sie sich die Karte mit der ID 1, ändern Sie den Namen, die Breite und die Höhe und speichern Sie die Änderungen

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

Holen Sie sich die Markierung mit ID 1, ändern Sie den Namen, das Symbol und das Popup und speichern Sie die Änderungen

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

Methodenreferenz

create_tables ()

Erstellt die Datenbanktabellen

Parameter

Diese Methode hat keine Parameter

Rückgabewerte

Es wird kein Wert zurückgegeben

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

delete_tables ()

Löscht die Datenbanktabellen

Parameter

Diese Methode hat keine Parameter

Rückgabewerte

Es wird kein Wert zurückgegeben

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

reset_tables ()

Setzt die Datenbanktabellen zurück

Parameter

Diese Methode hat keine Parameter

Rückgabewerte

Es wird kein Wert zurückgegeben

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

count_maps ($ Filter = array ())

Gibt die Gesamtzahl der Karten zurück
Akzeptiert optional eine Liste von Filtern

Parameter

$ Filter: (Array) (optional) Liste der Filter

Rückgabewerte

(int) Gesamtzahl der Karten

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

get_map ($ Id, $ count = falsch)

Gibt die Karte für die angegebene ID zurück

Parameter

$ Id: (int) Karten-ID
$ count: (bool) (optional) Gibt an, ob die zugewiesenen Marker gezählt werden sollen

Rückgabewerte

(Objekt | null) Objekt zuordnen oder null, wenn kein Ergebnis gefunden wird

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

get_maps ($ ids, $ count = falsch)

Gibt die Karten für die angegebenen IDs zurück

Parameter

$ ids: (Array | String) Liste oder CSV der Karten-IDs
$ count: (bool) (optional) Gibt an, ob die zugewiesenen Marker gezählt werden sollen

Rückgabewerte

(Array) Liste der Kartenobjekte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

get_all_maps ($ count = falsch, $ Filter = array ())

Gibt alle Karten zurück
Akzeptiert optional eine Liste von Filtern

Parameter

$ count: (bool) (optional) Gibt an, ob die zugewiesenen Marker gezählt werden sollen
$ Filter: (Array) (optional) Liste der Filter

Rückgabewerte

(Array) Liste der Kartenobjekte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

get_map_shortcodes ($ Id)

Gibt alle Beiträge zurück, die einen Shortcode für die angegebene Karten-ID verwenden

Parameter

$ Id: (int) Karten-ID

Rückgabewerte

(Array) Liste der Beiträge

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

add_map ($ Data, $ Id = 0)

Fügt eine Karte hinzu

Parameter

$ Data: (Objekt) Zu schreibende Kartendaten
$ Id: (int) (optional) ID für die neue Karte

Rückgabewerte

(int | bool) Map ID oder false, wenn die Map nicht hinzugefügt werden konnte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

add_maps ($ Data)

Fügt mehrere Karten hinzu

Parameter

$ Data: (Array) Liste der zu schreibenden Kartendaten

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Karten nicht hinzugefügt werden konnten

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

update_map ($ Data, $ Id)

Aktualisiert eine Karte

Parameter

$ Data: (Objekt) Zu schreibende Kartendaten
$ Id: (int) ID der zu aktualisierenden Karte

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Karte nicht aktualisiert werden konnte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

update_maps ($ Data, $ ids)

Aktualisiert mehrere Karten

Parameter

$ Data: (Objekt) Zu schreibende Kartendaten
$ ids: (Array | String) Liste oder CSV der Karten-IDs

Rückgabewerte

(int) Anzahl der betroffenen Zeilen

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

delete_map ($ Id)

Löscht eine Karte und ihre Beziehungen

Parameter

$ Id: (int) ID der zu löschenden Karte

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Karte nicht gelöscht werden konnte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

delete_maps ($ ids)

Löscht mehrere Karten und ihre Beziehungen

Parameter

$ ids: (Array | String) Liste oder CSV der Karten-IDs

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Karten nicht gelöscht werden konnten

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

count_markers ($ Filter = array ())

Gibt die Gesamtzahl der Marker zurück
Akzeptiert optional eine Liste von Filtern

Parameter

$ Filter: (Array) (optional) Liste der Filter

Rückgabewerte

(int) Gesamtzahl der Marker

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

count_map_markers ($ Id)

Gibt die Gesamtzahl der Markierungen für die angegebene Karten-ID zurück

Parameter

$ Id: (int) Karten-ID

Rückgabewerte

(int) Gesamtzahl der Markierungen für die angegebene Karten-ID

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

get_marker ($ Id)

Gibt den Marker für die angegebene ID zurück

Parameter

$ Id: (int) Marker ID

Rückgabewerte

(Objekt | null) Markierungsobjekt oder null, wenn kein Ergebnis gefunden wird

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

get_markers ($ ids)

Gibt die Markierungen für die angegebenen IDs zurück

Parameter

$ ids: (Array | String) Liste oder CSV der Marker-IDs

Rückgabewerte

(Array) Liste der Markerobjekte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

get_all_markers ($ Filter = array ())

Gibt alle Marker zurück
Akzeptiert optional eine Liste von Filtern

Parameter

$ Filter: (Array) (optional) Liste der Filter

Rückgabewerte

(Array) Liste der Markerobjekte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

get_map_markers ($ Id)

Gibt die Markierungen für die angegebene Karten-ID zurück

Parameter

$ Id: (int) Karten-ID

Rückgabewerte

(Array) Liste der Markerobjekte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

get_maps_markers ($ ids)

Gibt die Markierungen für die angegebenen Karten-IDs zurück

Parameter

$ ids: (int) Karten-IDs

Rückgabewerte

(Array) Liste der Markerobjekte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

add_marker ($ Data, $ Id = 0)

Fügt einen Marker hinzu

Parameter

$ Data: (Objekt) Zu schreibende Markierungsdaten
$ Id: (int) (optional) ID für den neuen Marker

Rückgabewerte

(int | bool) Marker-ID oder false, wenn der Marker nicht hinzugefügt werden konnte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

add_markers ($ Data)

Fügt mehrere Marker hinzu

Parameter

$ Data: (Array) Liste der zu schreibenden Markierungsdaten

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Markierungen nicht hinzugefügt werden konnten

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

update_marker ($ Data, $ Id)

Aktualisiert einen Marker

Parameter

$ Data: (Objekt) Zu schreibende Markierungsdaten
$ Id: (int) ID des zu aktualisierenden Markers

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Markierung nicht aktualisiert werden konnte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

update_markers ($ Data, $ ids)

Aktualisiert mehrere Marker

Parameter

$ Data: (Objekt) Zu schreibende Markierungsdaten
$ ids: (Array | String) Liste oder CSV der Marker-IDs

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Markierungen nicht aktualisiert werden konnten

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

assign_marker ($ map_id, $ marker_id)

Weist einer Karte eine Markierung zu

Parameter

$ map_id: (int) Karten-ID
$ marker_id: (int) Marker ID

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn der Marker nicht zugewiesen werden konnte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

assign_markers ($ map_id, $ marker_ids)

Weist einer Karte mehrere Markierungen zu

Parameter

$ map_id: (int) Karten-ID
$ marker_ids: (Array | String) Liste oder CSV der Marker-IDs

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Markierungen nicht zugewiesen werden konnten

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

assign_maps_marker ($ map_ids, $ marker_id)

Weist mehreren Karten eine Markierung zu

Parameter

$ map_ids: (Array | String) Liste oder CSV der Karten-IDs
$ marker_id: (int) Marker ID

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn der Marker nicht zugewiesen werden konnte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

assign_maps_markers ($ map_ids, $ marker_ids)

Weist mehreren Karten mehrere Markierungen zu

Parameter

$ map_ids: (Array | String) Liste oder CSV der Karten-IDs
$ marker_ids: (Array | String) Liste oder CSV der Marker-IDs

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Markierungen nicht zugewiesen werden konnten

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

assign_assoc ($ assoc)

Weist Markierungen aus einer assoziativen Liste zu

Parameter

$ assoc: (Array) Assoziative Liste der Marker-ID => Karten-IDs

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Markierungen nicht zugewiesen werden konnten

Änderungsprotokoll

Version	Beschreibung
4.9	Eingeführt

unassign_marker ($ map_id, $ marker_id)

Hebt die Zuordnung einer Markierung von einer Karte auf

Parameter

$ map_id: (int) Karten-ID
$ marker_id: (int) Marker ID

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Markierung nicht aufgehoben werden konnte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

unassign_markers ($ map_id, $ marker_ids)

Hebt die Zuordnung mehrerer Markierungen von einer Karte auf

Parameter

$ map_id: (int) Karten-ID
$ marker_ids: (Array | String) Liste oder CSV der Marker-IDs

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Markierungen nicht aufgehoben werden konnten

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

unassign_maps_marker ($ map_ids, $ marker_id)

Hebt die Zuordnung eines Markers von mehreren Karten auf

Parameter

$ map_ids: (Array | String) Liste oder CSV der Karten-IDs
$ marker_id: (int) Marker ID

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Markierung nicht aufgehoben werden konnte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

unassign_all_markers ($ map_id)

Hebt die Zuordnung aller Markierungen von einer Karte auf

Parameter

$ map_id: (int) Karten-ID

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Markierungen nicht aufgehoben werden konnten

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

delete_marker ($ Id)

Löscht einen Marker und seine Beziehungen

Parameter

$ Id: (int) ID des zu löschenden Markers

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn der Marker nicht gelöscht werden konnte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

delete_markers ($ ids)

Löscht mehrere Marker und ihre Beziehungen

Parameter

$ ids: (Array | String) Liste oder CSV der Marker-IDs

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Markierungen nicht gelöscht werden konnten

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

get_layer ($ Id)

Gibt die Ebene für die angegebene ID zurück

Parameter

$ Id: (int) Schicht-ID

Rückgabewerte

(Objekt | null) Ebenenobjekt oder null, wenn kein Ergebnis gefunden wird

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

get_all_layers ()

Gibt alle Ebenen zurück

Parameter

Diese Methode hat keine Parameter

Rückgabewerte

(Array) Liste der Ebenenobjekte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

get_all_basemaps ()

Gibt alle Grundkarten zurück

Parameter

Diese Methode hat keine Parameter

Rückgabewerte

(Array) Liste der Ebenenobjekte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

get_all_overlays ()

Gibt alle Überlagerungen zurück

Parameter

Diese Methode hat keine Parameter

Rückgabewerte

(Array) Liste der Ebenenobjekte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

add_layer ($ Data, $ Id = 0)

Fügt eine Ebene hinzu

Parameter

$ Data: (Objekt) Zu schreibende Schichtdaten
$ Id: (int) (optional) ID für die neue Ebene

Rückgabewerte

(int | bool) Layer-ID oder false, wenn der Layer nicht hinzugefügt werden konnte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

update_layer ($ Data, $ Id)

Aktualisiert eine Ebene

Parameter

$ Data: (Objekt) Zu schreibende Schichtdaten
$ Id: (int) ID der zu aktualisierenden Schicht

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Ebene nicht aktualisiert werden konnte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

delete_layer ($ Id)

Löscht eine Ebene

Parameter

$ Id: (int) Schicht-ID

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Ebene nicht gelöscht werden konnte

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

delete_orphaned_rels ()

Löscht verwaiste Beziehungen

Parameter

Diese Methode hat keine Parameter

Rückgabewerte

(int | bool) Anzahl der betroffenen Zeilen oder false, wenn die Waisen nicht gelöscht werden konnten

Änderungsprotokoll

Version	Beschreibung
4.7	Eingeführt

build_marker ($ Data, $ geojson = falsch)

Erstellt ein gültiges Markierungsobjekt

Parameter

$ Data: (Array) Liste der Markierungsdaten
$ geojson: (bool) (optional) Gibt an, ob die Daten im GeoJSON-Format vorliegen

Rückgabewerte

(Array) Markierungsobjekt

Änderungsprotokoll

Version	Beschreibung
4.9	Eingeführt

sanitize_ids ($ ids, $ csv = falsch)

Bereinigt ein Array oder eine durch Kommas getrennte Liste von IDs

Parameter

$ ids: (Array | String) Liste oder CSV von IDs
$ csv: (bool) (optional) Gibt an, ob die bereinigten IDs als CSV zurückgegeben werden sollen

Rückgabewerte

(Array | String) Liste oder CSV bereinigter IDs

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

prepare_layers ()

Gibt die Bereinigungsregeln für Layertabellen für Vorbereitungsanweisungen zurück

Parameter

Diese Methode hat keine Parameter

Rückgabewerte

(Array) Liste der Desinfektionsregeln (Spalte => Regel)

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

prepare_maps ()

Gibt die Bereinigungsregeln für die Kartentabelle für Vorbereitungsanweisungen zurück

Parameter

Diese Methode hat keine Parameter

Rückgabewerte

(Array) Liste der Desinfektionsregeln (Spalte => Regel)

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

prepare_markers ()

Gibt die Bereinigungsregeln für die Markertabelle für Vorbereitungsanweisungen zurück

Parameter

Diese Methode hat keine Parameter

Rückgabewerte

(Array) Liste der Desinfektionsregeln (Spalte => Regel)

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

prepare_rels ()

Gibt die Bereinigungsregeln für Beziehungstabellen für Vorbereitungsanweisungen zurück

Parameter

Diese Methode hat keine Parameter

Rückgabewerte

(Array) Liste der Desinfektionsregeln (Spalte => Regel)

Änderungsprotokoll

Version	Beschreibung
4.0	Eingeführt

11932