API del database

Contenuti

Si noti che è necessario prestare attenzione quando si manipola il database di Maps Marker Pro direttamente tramite l'API per evitare la perdita di dati. Tutte le chiamate sono immediate e non possono essere annullate.

Inoltre, tieni presente che il nostro supporto non copre domande dettagliate sullo sviluppo personalizzato basato su questa API.

Impiego

Per utilizzare l'API DB, dobbiamo prima creare un'istanza della classe:

$db = new MMP\DB();

Le mappe restituiscono oggetti con le seguenti proprietà:

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)

I marcatori restituiscono oggetti con le seguenti proprietà:

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

Esempi

Ottieni la mappa con ID 1, modifica il nome, la larghezza e l'altezza e salva le modifiche

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

Ottieni l'indicatore con ID 1, modifica il nome, l'icona e il popup e salva le modifiche

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

Metodo di riferimento

create_tables ()

Crea le tabelle del database


parametri

questo metodo non ha parametri


Valori di ritorno

Nessun valore viene restituito


changelog

Versione Descrizione
4.0 Introdotto

delete_tables ()

Elimina le tabelle del database


parametri

questo metodo non ha parametri


Valori di ritorno

Nessun valore viene restituito


changelog

Versione Descrizione
4.0 Introdotto

reset_tables ()

Reimposta le tabelle del database


parametri

questo metodo non ha parametri


Valori di ritorno

Nessun valore viene restituito


changelog

Versione Descrizione
4.0 Introdotto

count_maps ($ filtri = array ())

Restituisce il numero totale di mappe
Opzionalmente accetta un elenco di filtri


parametri

$ filtri
(array) (opzionale) Elenco di filtri

Valori di ritorno

(int) Numero totale di mappe


changelog

Versione Descrizione
4.0 Introdotto

get_map ($ Id, $ count = falso)

Restituisce la mappa per l'ID specificato


parametri

$ Id
(int) ID mappa
$ count
(bool) (opzionale) Indica se contare i marker assegnati

Valori di ritorno

(oggetto | null) Mappa oggetto o null se non viene trovato alcun risultato


changelog

Versione Descrizione
4.0 Introdotto

get_maps ($ ids, $ count = falso)

Restituisce le mappe per gli ID dati


parametri

$ ids
(array | stringa) Elenco o CSV degli ID mappa
$ count
(bool) (opzionale) Indica se contare i marker assegnati

Valori di ritorno

(array) Elenco di oggetti mappa


changelog

Versione Descrizione
4.0 Introdotto

get_all_maps ($ count = falso, $ filtri = array ())

Restituisce tutte le mappe
Opzionalmente accetta un elenco di filtri


parametri

$ count
(bool) (opzionale) Indica se contare i marker assegnati
$ filtri
(array) (opzionale) Elenco di filtri

Valori di ritorno

(array) Elenco di oggetti mappa


changelog

Versione Descrizione
4.0 Introdotto

get_map_shortcodes ($ Id)

Restituisce tutti i post che utilizzano un shortcode per l'ID mappa specificato


parametri

$ Id
(int) ID mappa

Valori di ritorno

(array) Elenco di post


changelog

Versione Descrizione
4.0 Introdotto

add_map ($ Data, $ Id = 0)

Aggiunge una mappa


parametri

$ Data
(oggetto) Dati mappa da scrivere
$ Id
(int) (opzionale) ID per la nuova mappa

Valori di ritorno

(int | bool) ID mappa o false se non è possibile aggiungere la mappa


changelog

Versione Descrizione
4.0 Introdotto

add_maps ($ Data)

Aggiunge più mappe


parametri

$ Data
(array) Elenco dei dati della mappa da scrivere

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è stato possibile aggiungere le mappe


changelog

Versione Descrizione
4.0 Introdotto

update_map ($ Data, $ Id)

Aggiorna una mappa


parametri

$ Data
(oggetto) Dati mappa da scrivere
$ Id
(int) ID della mappa da aggiornare

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è possibile aggiornare la mappa


changelog

Versione Descrizione
4.0 Introdotto

update_maps ($ Data, $ ids)

Aggiorna più mappe


parametri

$ Data
(oggetto) Dati mappa da scrivere
$ ids
(array | stringa) Elenco o CSV degli ID mappa

Valori di ritorno

(int) Numero di righe interessate


changelog

Versione Descrizione
4.0 Introdotto

delete_map ($ Id)

Elimina una mappa e le sue relazioni


parametri

$ Id
(int) ID della mappa da eliminare

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è possibile eliminare la mappa


changelog

Versione Descrizione
4.0 Introdotto

delete_maps ($ ids)

Elimina più mappe e le loro relazioni


parametri

$ ids
(array | stringa) Elenco o CSV degli ID mappa

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è possibile eliminare le mappe


changelog

Versione Descrizione
4.0 Introdotto

count_markers ($ filtri = array ())

Restituisce il numero totale di marcatori
Opzionalmente accetta un elenco di filtri


parametri

$ filtri
(array) (opzionale) Elenco di filtri

Valori di ritorno

(int) Numero totale di marcatori


changelog

Versione Descrizione
4.0 Introdotto

count_map_markers ($ Id)

Restituisce il numero totale di marcatori per l'ID mappa specificato


parametri

$ Id
(int) ID mappa

Valori di ritorno

(int) Numero totale di marcatori per l'ID mappa specificato


changelog

Versione Descrizione
4.0 Introdotto

get_marker ($ Id)

Restituisce il marcatore per l'ID specificato


parametri

$ Id
(int) ID marcatore

Valori di ritorno

(oggetto | null) Indicatore oggetto o null se non viene trovato alcun risultato


changelog

Versione Descrizione
4.0 Introdotto

get_markers ($ ids)

Restituisce i marcatori per gli ID dati


parametri

$ ids
(array | stringa) Elenco o CSV degli ID marker

Valori di ritorno

(array) Elenco di oggetti marker


changelog

Versione Descrizione
4.0 Introdotto

get_all_markers ($ filtri = array ())

Restituisce tutti i marcatori
Opzionalmente accetta un elenco di filtri


parametri

$ filtri
(array) (opzionale) Elenco di filtri

Valori di ritorno

(array) Elenco di oggetti marker


changelog

Versione Descrizione
4.0 Introdotto

get_map_markers ($ Id)

Restituisce i marcatori per l'ID mappa specificato


parametri

$ Id
(int) ID mappa

Valori di ritorno

(array) Elenco di oggetti marker


changelog

Versione Descrizione
4.0 Introdotto

get_maps_markers ($ ids)

Restituisce i marcatori per gli ID mappa specificati


parametri

$ ids
(int) ID mappa

Valori di ritorno

(array) Elenco di oggetti marker


changelog

Versione Descrizione
4.0 Introdotto

add_marker ($ Data, $ Id = 0)

Aggiunge un marcatore


parametri

$ Data
(oggetto) Dati marker da scrivere
$ Id
(int) (opzionale) ID per il nuovo marcatore

Valori di ritorno

(int | bool) ID marker o false se non è stato possibile aggiungere il marker


changelog

Versione Descrizione
4.0 Introdotto

add_markers ($ Data)

Aggiunge più marcatori


parametri

$ Data
(array) Elenco dei dati dei marker da scrivere

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è stato possibile aggiungere gli indicatori


changelog

Versione Descrizione
4.0 Introdotto

update_marker ($ Data, $ Id)

Aggiorna un marcatore


parametri

$ Data
(oggetto) Dati marker da scrivere
$ Id
(int) ID del marker da aggiornare

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è stato possibile aggiornare il marker


changelog

Versione Descrizione
4.0 Introdotto

update_markers ($ Data, $ ids)

Aggiorna più marker


parametri

$ Data
(oggetto) Dati marker da scrivere
$ ids
(array | stringa) Elenco o CSV degli ID marker

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è stato possibile aggiornare i marker


changelog

Versione Descrizione
4.0 Introdotto

assign_marker ($ MAP_ID, $ marker_id)

Assegna un indicatore a una mappa


parametri

$ MAP_ID
(int) ID mappa
$ marker_id
(int) ID marcatore

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è stato possibile assegnare il marker


changelog

Versione Descrizione
4.0 Introdotto

assign_markers ($ MAP_ID, $ marker_ids)

Assegna più marcatori a una mappa


parametri

$ MAP_ID
(int) ID mappa
$ marker_ids
(array | stringa) Elenco o CSV degli ID marker

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è stato possibile assegnare i marker


changelog

Versione Descrizione
4.0 Introdotto

assign_maps_marker ($ map_ids, $ marker_id)

Assegna un marcatore a più mappe


parametri

$ map_ids
(array | stringa) Elenco o CSV degli ID mappa
$ marker_id
(int) ID marcatore

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è stato possibile assegnare il marker


changelog

Versione Descrizione
4.0 Introdotto

assign_maps_markers ($ map_ids, $ marker_ids)

Assegna più marker a più mappe


parametri

$ map_ids
(array | stringa) Elenco o CSV degli ID mappa
$ marker_ids
(array | stringa) Elenco o CSV degli ID marker

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è stato possibile assegnare i marker


changelog

Versione Descrizione
4.0 Introdotto

assign_assoc ($ assoc)

Assegna marcatori da un elenco associativo


parametri

$ assoc
(array) Elenco associativo di ID marker => ID mappa

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è stato possibile assegnare i marker


changelog

Versione Descrizione
4.9 Introdotto

unassign_marker ($ MAP_ID, $ marker_id)

Annulla l'assegnazione di un marcatore da una mappa


parametri

$ MAP_ID
(int) ID mappa
$ marker_id
(int) ID marcatore

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è possibile annullare l'assegnazione del marker


changelog

Versione Descrizione
4.0 Introdotto

unassign_markers ($ MAP_ID, $ marker_ids)

Annulla l'assegnazione di più marker da una mappa


parametri

$ MAP_ID
(int) ID mappa
$ marker_ids
(array | stringa) Elenco o CSV degli ID marker

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è possibile annullare l'assegnazione dei marker


changelog

Versione Descrizione
4.0 Introdotto

unassign_maps_marker ($ map_ids, $ marker_id)

Annulla l'assegnazione di un marcatore da più mappe


parametri

$ map_ids
(array | stringa) Elenco o CSV degli ID mappa
$ marker_id
(int) ID marcatore

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è possibile annullare l'assegnazione del marker


changelog

Versione Descrizione
4.0 Introdotto

unassign_all_markers ($ MAP_ID)

Annulla l'assegnazione di tutti gli indicatori da una mappa


parametri

$ MAP_ID
(int) ID mappa

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è possibile annullare l'assegnazione dei marker


changelog

Versione Descrizione
4.0 Introdotto

delete_marker ($ Id)

Elimina un marcatore e le sue relazioni


parametri

$ Id
(int) ID del marcatore da eliminare

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è stato possibile eliminare il marker


changelog

Versione Descrizione
4.0 Introdotto

delete_markers ($ ids)

Elimina più marcatori e le loro relazioni


parametri

$ ids
(array | stringa) Elenco o CSV degli ID marker

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è stato possibile eliminare i marker


changelog

Versione Descrizione
4.0 Introdotto

get_layer ($ Id)

Restituisce il layer per l'ID specificato


parametri

$ Id
(int) ID livello

Valori di ritorno

(oggetto | null) Oggetto layer o null se non viene trovato alcun risultato


changelog

Versione Descrizione
4.0 Introdotto

get_all_layers ()

Restituisce tutti i livelli


parametri

questo metodo non ha parametri


Valori di ritorno

(array) Elenco di oggetti layer


changelog

Versione Descrizione
4.0 Introdotto

get_all_basemaps ()

Restituisce tutte le mappe di base


parametri

questo metodo non ha parametri


Valori di ritorno

(array) Elenco di oggetti layer


changelog

Versione Descrizione
4.0 Introdotto

get_all_overlays ()

Restituisce tutti gli overlay


parametri

questo metodo non ha parametri


Valori di ritorno

(array) Elenco di oggetti layer


changelog

Versione Descrizione
4.0 Introdotto

add_layer ($ Data, $ Id = 0)

Aggiunge un livello


parametri

$ Data
(oggetto) Dati livello da scrivere
$ Id
(int) (opzionale) ID per il nuovo livello

Valori di ritorno

(int | bool) ID layer o false se non è stato possibile aggiungere il layer


changelog

Versione Descrizione
4.0 Introdotto

update_layer ($ Data, $ Id)

Aggiorna un livello


parametri

$ Data
(oggetto) Dati livello da scrivere
$ Id
(int) ID del layer da aggiornare

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è possibile aggiornare il layer


changelog

Versione Descrizione
4.0 Introdotto

delete_layer ($ Id)

Elimina un livello


parametri

$ Id
(int) ID livello

Valori di ritorno

(int | bool) Numero di righe interessate o false se non è stato possibile eliminare il layer


changelog

Versione Descrizione
4.0 Introdotto

delete_orphaned_rels ()

Elimina le relazioni orfane


parametri

questo metodo non ha parametri


Valori di ritorno

(int | bool) Numero di righe interessate o false se non è stato possibile eliminare gli orfani


changelog

Versione Descrizione
4.7 Introdotto

build_marker ($ Data, $ GeoJSON = falso)

Costruisce un oggetto marker valido


parametri

$ Data
(array) Elenco dei dati dei marker
$ GeoJSON
(bool) (opzionale) Indica se i dati sono in formato GeoJSON

Valori di ritorno

(array) Oggetto marker


changelog

Versione Descrizione
4.9 Introdotto

sanitize_ids ($ ids, $ csv = falso)

Disinfetta un array o un elenco di ID separati da virgole


parametri

$ ids
(array | stringa) Elenco o CSV di ID
$ csv
(bool) (opzionale) Indica se restituire gli ID disinfettati come CSV

Valori di ritorno

(array | stringa) Elenco o CSV di ID disinfettati


changelog

Versione Descrizione
4.0 Introdotto

prepare_layers ()

Restituisce le regole di sanificazione della tabella dei livelli per le istruzioni di preparazione


parametri

questo metodo non ha parametri


Valori di ritorno

(array) Elenco delle regole di sanificazione (colonna => regola)


changelog

Versione Descrizione
4.0 Introdotto

prepare_maps ()

Restituisce le regole di sanificazione della tabella delle mappe per le istruzioni di preparazione


parametri

questo metodo non ha parametri


Valori di ritorno

(array) Elenco delle regole di sanificazione (colonna => regola)


changelog

Versione Descrizione
4.0 Introdotto

prepare_markers ()

Restituisce le regole di sanificazione della tabella dei marker per le istruzioni di preparazione


parametri

questo metodo non ha parametri


Valori di ritorno

(array) Elenco delle regole di sanificazione (colonna => regola)


changelog

Versione Descrizione
4.0 Introdotto

prepare_rels ()

Restituisce le regole di sanificazione della tabella delle relazioni per le istruzioni di preparazione


parametri

questo metodo non ha parametri


Valori di ritorno

(array) Elenco delle regole di sanificazione (colonna => regola)


changelog

Versione Descrizione
4.0 Introdotto
3
2
12004
Valuta questo riferimento
en English
X