Attenzione: MMPAPI è stato rimosso con v4.0, sostituzione: API del database

Documentazione MMPAPI

torna alla panoramica delle API

Funzioni MMPAPI

  1. Introduzione
  2. descrizione della classe generata
  3. Marcatori
    1. add_marker
    2. add_markers
    3. count_markers
    4. delete_marker
    5. delete_markers
    6. get_marker
    7. get_markers
    8. list_markers
    9. search_markers
    10. update_marker
    11. update_markers
  4. Livelli
    1. add_layer
    2. add_layers
    3. count_layers
    4. delete_layer
    5. delete_layers
    6. get_layer
    7. get_layers
    8. list_layers
    9. search_layers
    10. update_layer
    11. update_layers
  5. Permessi
    1. current_user_can_any
  6. parametri
    1. Parametri disponibili per l'indicatore di tipo
    2. Parametri disponibili per tipo layer
    3. Parametri speciali per l'azione dell'elenco marcatori
    4. Parametri speciali per l'azione dell'elenco di livelli
    5. Parametri speciali per l'azione di ricerca


Introduzione

Le funzioni API di Maps Marker Pro offrono agli sviluppatori un modo a prova di futuro per accedere ad alcune delle funzionalità principali comuni in Maps Marker Pro.

Le funzioni API vengono automaticamente incluse quando viene caricato Maps Marker Pro e saranno disponibili al momento del caricamento dei componenti aggiuntivi. La classe API si chiama MMPAPI e può essere trovata in /leaflet-maps-marker-pro/inc/class-mmpapi.php.


Descrizione della classe generata

La descrizione della classe generata automaticamente è disponibile all'indirizzo https://www.mapsmarker.com/wp-content/uploads/mmpapi/class/


Marcatori

add_marker

Aggiunge un nuovo marker utilizzando l'oggetto Marker specificato. Attenzione, viene fatto un piccolo controllo per assicurarsi che sia un oggetto Marker valido.

public static function add_marker( $marker_data ) {}

parametri

Resi

Esempio di utilizzo


$marker_data = array(
	'markername' => 'Headquarter',
	'geocode' => 'Main Street 1 Washington',
);
$marker_id = MMPAPI::add_marker( $marker_data );
torna in cima


add_markers

Aggiungi marcatori in base a determinati oggetti dati.

public static function add_markers( $markers_data ) {}

parametri

Resi

  • $ marcatori misto

    Un array di ID marker o oggetto WP_Error.

Esempio di utilizzo


$markers_data = array(
	array(
		'markername' => 'Headquarter',
		'geocode' => 'Main Street 1 Washington',
	),
	array(
		'markername' => 'Headquarter',
		'geocode' => 'Main Street 1 Washington',
	));
$markers = MMPAPI::add_markers( $markers_data );
torna in cima


count_markers

Restituisce il numero di marcatori disponibili.

public static function count_markers( ) {}

Resi

  • $ markers_count int

    I marcatori contano

Esempio di utilizzo

$result = MMPAPI::count_markers( );
torna in cima


delete_marker

Elimina il marker con l'ID marker specificato.

public static function delete_marker( $marker_id ) {}

parametri

Resi

Esempio di utilizzo

$result = MMPAPI::delete_marker( $marker_id );
torna in cima


delete_markers

Elimina i marker per un determinato ID marker

public static function delete_markers( $marker_ids ) {}

parametri

Resi

  • $ risultato misto

    Vero se i marker sono stati eliminati correttamente, WP_Error in caso contrario.

Esempio di utilizzo


$marker_ids = array(6,7,8);
$result = MMPAPI::delete_markers( $marker_ids );
torna in cima


get_marker

Restituisce l'oggetto marker per un determinato ID marker.

public static function get_marker( $marker_id ) {}

parametri

Resi

  • $ risultato misto

    L'oggetto marcatore o Falso.

Esempio di utilizzo

$result = MMPAPI::get_marker( 5 );
torna in cima


get_markers

Restituisce gli oggetti marker per determinati ID marker.

public static function get_markers( $marker_ids ) {}

parametri

Resi

  • $ risultato misto

    Gli oggetti marker o False.

Esempio di utilizzo

$result = MMPAPI::get_markers( array( 1, 5, 10 ) );
torna in cima


list_markers

Restituisce tutti gli oggetti marker.

public static function list_markers( $args = NULL ){}

parametri

Resi

  • $ risultato misto

    Gli oggetti marker o False.

Esempio di utilizzo


$args['orderkey'] = 'markername';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_markers( $args );
torna in cima


search_markers

Gli indicatori di ricerca indicano un determinato argomento.

public static function search_markers( $args ) {}

parametri

Resi

  • $ risultato misto

    Gli oggetti marker che corrispondono ai parametri o False.

Esempio di utilizzo


$args['searchkey'] = 'layer';
$args['searchvalue'] = 7;
$result = MMPAPI::search_markers( $args );
torna in cima


update_marker

Aggiorna un marcatore in base a un dato oggetto dati

public static function update_marker( $marker_data ) {}

parametri

Resi

  • $ risultato booleano

    Vero se il marcatore è stato aggiornato, falso altrimenti.

Esempio di utilizzo


$marker_data = array(
					 'id' => 2,
					 'popuptext' => 'new popuptext' 
					 );

$result = MMPAPI::update_marker( $marker_data );
torna in cima


update_markers

Aggiorna marcatori in base a un dato oggetto dati

public static function update_markers( $markers_data ) {}

parametri

Resi

  • $ risultato misto

    Matrice di ID di marker aggiornati o di un oggetto errore.

Esempio di utilizzo


$markers_data = array(
					array(
					 	'id' => 2,
					 	'popuptext' => 'new popuptext for marker#2' 
					 ),
					 array(
					 	'id' => 3,
					 	'popuptext' => 'new popuptext for marker#3' 
					 )
				);

$result = MMPAPI::update_markers( $markers_data );
torna in cima


Livelli

add_layer

Aggiunge un nuovo livello usando l'oggetto Layer specificato. Attenzione, viene fatto un piccolo controllo per assicurarsi che sia un oggetto Layer valido.

public static function add_layer( $layer_data ) {}

parametri

Resi

Esempio di utilizzo


$layer_data = array(
	'name' => 'Headquarter',
	'geocode' => 'Main Street 1 Washington',
);
$layer_id = MMPAPI::add_layer( $layer_data );
torna in cima


add_layers

Aggiungi livelli in base a determinati oggetti dati.

public static function add_layers( $layers_data ) {}

parametri

Resi

  • $ strati misto

    Un array di ID layer o oggetto WP_Error.

Esempio di utilizzo


$layers_data = array(
	array(
		'name' => 'Headquarter',
		'geocode' => 'Main Street 1 Washington',
	),
	array(
		'name' => 'Headquarter 2',
		'geocode' => 'Main Street 2 Washington',
	));
$layers = MMPAPI::add_layers( $layers_data );
torna in cima


count_layers

Restituisce il numero di livelli disponibili.

public static function count_layers( ) {}

Resi

  • $ layers_count int

    I livelli contano

Esempio di utilizzo

$result = MMPAPI::count_layers( );
torna in cima


delete_layer

Elimina il layer con l'ID layer specificato.

public static function delete_layer( $layer_id, $delete_markers = false ) {}

parametri

  • $ layer_id numero intero

    L'ID del livello da eliminare.

  • $ delete_markers booleano

    Un parametro booleano, se impostato su TRUE, il metodo eliminerà tutti i marker associati al layer. Il valore predefinito è FALSE.

Resi

Esempio di utilizzo

$result = MMPAPI::delete_layer( $layer_id );
torna in cima


delete_layers

Elimina i livelli per un determinato ID livelli

public static function delete_layers( $layers_ids, $delete_markers = false ) {}

parametri

  • $ layers_ids schieramento

    Gli ID dei livelli.

  • $ delete_markers booleano

    Un parametro booleano, se impostato su TRUE, il metodo eliminerà tutti i marker associati ai layer. Il valore predefinito è FALSE.

Resi

  • $ risultato misto

    Vero se i livelli sono stati eliminati correttamente, WP_Error in caso contrario.

Esempio di utilizzo


$layers_ids = array(6,7,8);
$result = MMPAPI::delete_layers( $layers_ids );
torna in cima


get_layer

Restituisce l'oggetto layer per un determinato ID layer.

public static function get_layer( $layer_id ) {}

parametri

Resi

  • $ risultato misto

    L'oggetto layer o False.

Esempio di utilizzo

$result = MMPAPI::get_layer( 5 );
torna in cima


get_layers

Restituisce gli oggetti layer per determinati ID layer.

public static function get_layers( $layer_ids ) {}

parametri

Resi

  • $ risultato misto

    Gli oggetti layer o False.

Esempio di utilizzo

$result = MMPAPI::get_layers( array( 1, 5, 10 ) );
torna in cima


list_layers

Restituisce tutti gli oggetti layer.

public static function list_layers( $args = NULL ) {}

parametri

Resi

  • $ risultato misto

    Gli oggetti layer o False.

Esempio di utilizzo


$args['orderkey'] = 'name';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_layers( $args );
torna in cima


search_layers

Cerca oggetti layer per un determinato argomento.

public static function search_layers( $args ) {}

parametri

Resi

  • $ risultato misto

    Gli oggetti layer che corrispondono ai parametri o False.

Esempio di utilizzo


$args['searchkey'] = 'name';
$args['searchvalue'] = 'Washington';
$result = MMPAPI::search_layers( $args );
torna in cima


update_layer

Aggiorna un livello in base a un dato oggetto dati

public static function update_layer( $layer_data ) {}

parametri

Resi

  • $ risultato booleano

    Vero se il livello è stato aggiornato, falso altrimenti.

Esempio di utilizzo


$layer_data = array(
					 'id' => 2,
					 'popuptext' => 'new popuptext' 
					 );

$result = MMPAPI::update_layer( $layer_data );
torna in cima


update_layers

Aggiorna i livelli in base a un dato oggetto dati

public static function update_layers( $layers_data ) {}

parametri

Resi

  • $ risultato misto

    Matrice di ID di layer aggiornati o di un oggetto errore.

Esempio di utilizzo


// Update layers with IDs 2,3 hide list of markers below map 
$layers_data = array(
					array(
					 	'id' => 2,
					 	'listmarkers' => 0
					 ),
					 array(
					 	'id' => 3,
					 	'listmarkers' => 0
					 )
				);

$result = MMPAPI::update_layers( $layers_data );
torna in cima

Permessi

current_user_can_any

Verifica le autorizzazioni per l'utente corrente. Restituisce vero se l'utente corrente ha una delle capacità specificate.

IMPORTANTE: chiamarlo prima di chiamare qualsiasi altra funzione API poiché i controlli delle autorizzazioni non vengono eseguiti ai livelli inferiori.

public static function current_user_can_any( $capabilities ) {}

parametri

  • $ funzionalità misto

    Stringa se si desidera controllare solo una funzionalità o una matrice di più funzionalità

Resi

Esempio di utilizzo


$marker_data = array(
	'markername' => 'Headquarter',
	'geocode' => 'Main Street 1 Washington',
);
if(MMPAPI::current_user_can_any( 'edit_posts' )){
	$marker_id = MMPAPI::add_marker( $marker_data );
}else{
	wp_die('You do not have permessions');
}
torna in cima


parametri

Parametri disponibili per l'indicatore di tipo

Parametro Necessario? Tipo di dati Valore di default Note
idrichiestonumero interoimpostato automaticamente quando si aggiunge un nuovo marcatore
markerNameopzionalestringaNULL
geocodeopzionalestringaNULL il valore viene geocodificato tramite l'API di Google Places e sovrascrive i parametri lat, lon e address
basemap opzionale ID mappa di base predefiniti: vedere le note mappa di base predefinita per il nuovo marker (vedi impostazioni) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, ogdwi2_box map_box map_boxbox_sat
strato opzionale numero intero layer predefinito per il nuovo marker (vedi impostazioni)
latopzionalegalleggianteposizione predefinita per il nuovo marker (vedi impostazioni) viene sovrascritto se viene utilizzato il parametro geocode!
lonopzionalegalleggianteposizione predefinita per il nuovo marker (vedi impostazioni) viene sovrascritto se viene utilizzato il parametro geocode!
iconaopzionalestringa (ad es. bus.png)NULL se NULL, verrà utilizzata l'icona predefinita. Usa semplicemente il nome file dell'icona come indicato nell'esempio. Tutte le icone disponibili nella directory delle icone (di solito / wp-content / uploads / leaflet-maps-marker-icone se non l'hai modificata in Impostazioni / impostazioni predefinite della mappa / Valori predefiniti per le icone dei marker) sono disponibili per l'uso.
popuptextopzionalestringaNULL
zoomopzionalenumero interozoom predefinito per il nuovo marker (vedi impostazioni)
openpopupopzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
mapwidthopzionalenumero interolarghezza di mappa predefinita per i nuovi marcatori (vedi impostazioni)
mapwidthunitopzionalestringavalore predefinito per i nuovi marcatori (vedi impostazioni)
mapheightopzionalenumero interomapheight predefinito per i nuovi marker (vedi impostazioni)
pannelloopzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
creato daopzionalestringaNULL
creatoopzionaledata (Ymd H: i: s)NULL
Aggiornato daopzionalestringaNULL
updatedonopzionaledata (Ymd H: i: s)data ('Ymd H: i: s)
scatola di controlloopzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
overlays_customopzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
overlays_custom2opzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
overlays_custom3opzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
overlays_custom4opzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
wmsopzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
wms2opzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
wms3opzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
wms4opzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
wms5opzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
wms6opzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
wms7opzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
wms8opzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
wms9opzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
wms10opzionalebooleanovalore predefinito per i nuovi marcatori (vedi impostazioni)
kml_timestampopzionaledata (Ymd H: i: s)NULL
indirizzoopzionalestringaNULL viene sovrascritto se viene utilizzato il parametro geocode!
gpx_urlopzionalestringaNULL dalla v1.2p
gpx_panelopzionalebooleano0 dalla v1.2p

torna in cima


Parametri disponibili per tipo layer

Parametro Necessario? Tipo di dati Valore di default Note
idrichiestonumero interoimpostato automaticamente quando si aggiunge un nuovo marcatore
geocodeopzionalestringaNULL il valore viene geocodificato tramite l'API di Google Places e sovrascrive i parametri lat, lon e address
NomeopzionalestringaNULL
basemapopzionalevalori predefinitimappa di base predefinita per il nuovo livello (vedi impostazioni) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, ogdwi2_box map_box map_boxbox_sat
layerzoomopzionalenumero interozoom predefinito per il nuovo livello (vedi impostazioni)
mapwidthunitopzionalestringavalore predefinito per il nuovo livello (vedi impostazioni)
mapwidthopzionalenumero interolarghezza di mappa predefinita per il nuovo livello (vedi impostazioni)
mapheightopzionalenumero interomapheight predefinito per il nuovo livello (vedi impostazioni)
pannelloopzionalebooleanovalore predefinito per il nuovo livello (vedi impostazioni)
layerviewlatopzionalegalleggiantelat predefinito per il nuovo livello (vedi impostazioni) viene sovrascritto se viene utilizzato il parametro geocode!
layerviewlonopzionalegalleggianteLon predefinito per il nuovo livello (vedi impostazioni) viene sovrascritto se viene utilizzato il parametro geocode!
creato daopzionalestringaNULL
creatoopzionaledata (Ymd H: i: s)NULL
Aggiornato daopzionalestringaNULL
updatedonopzionaledata (Ymd H: i: s)data ('Ymd H: i: s)
scatola di controlloopzionalebooleanovalore predefinito per il nuovo livello (vedi impostazioni)
overlays_customrichiestobooleanovalore predefinito per il nuovo livello (vedi impostazioni)
overlays_custom2richiestobooleanovalore predefinito per il nuovo livello (vedi impostazioni)
overlays_custom3richiestobooleanovalore predefinito per il nuovo livello (vedi impostazioni)
overlays_custom4richiestobooleanovalore predefinito per il nuovo livello (vedi impostazioni)
wmsrichiestobooleanovalore predefinito per il nuovo livello (vedi impostazioni)
wms2richiestobooleanovalore predefinito per il nuovo livello (vedi impostazioni)
wms3richiestobooleanovalore predefinito per il nuovo livello (vedi impostazioni)
wms4richiestobooleanovalore predefinito per il nuovo livello (vedi impostazioni)
wms5richiestobooleanovalore predefinito per il nuovo livello (vedi impostazioni)
wms6richiestobooleanovalore predefinito per il nuovo livello (vedi impostazioni)
wms7richiestobooleanovalore predefinito per il nuovo livello (vedi impostazioni)
wms8richiestobooleanovalore predefinito per il nuovo livello (vedi impostazioni)
wms9richiestobooleanovalore predefinito per il nuovo livello (vedi impostazioni)
wms10richiestobooleanovalore predefinito per il nuovo livello (vedi impostazioni)
listmarkersopzionalebooleanovalore predefinito per il nuovo livello (vedi impostazioni) opzione per mostrare l'elenco dei marcatori sotto le mappe dei livelli
multi_layer_mapopzionalebooleano0
multi_layer_map_listopzionalestringa (ID layer separati da virgola o tutti)NULL ad es. 1,2,3,4 o tutti
indirizzoopzionalestringaNULL viene sovrascritto se viene utilizzato il parametro geocode!
delete_markersopzionalevero falsofalso quando viene utilizzato per l'azione di eliminazione, vengono eliminati anche i marker assegnati
il clusteringopzionalebooleanovalore predefinito per il nuovo livello (vedi impostazioni) disponibile solo nella versione pro
gpx_urlopzionalestringaNULL dalla v1.2p
gpx_panelopzionalebooleano0 dalla v1.2p


Parametri speciali per l'azione dell'elenco marcatori

ParametroNecessario?Tipo di datiNote
orderkeyopzionalestringaValori di ordinamento consentiti: id, creato, aggiornato, kml_timestamp, nome utente, mappa di base, lat, lon, creato da, aggiornato da, indirizzo
orderdiropzionalestringaValori di direzione di ordinamento consentiti: ASC, DESC
orderoffopzionalenumero interoOffset per l'elenco dei marker
orderlimitopzionalenumero interoLimite per l'elenco dei marker
torna in cima


Parametri speciali per l'azione dell'elenco di livelli

ParametroNecessario?Tipo di datiNote
orderkeyopzionalestringaValori di ordinamento consentiti: id, aggiornato, creato, nome, mappa di base, layerviewlat, layerviewlon, creato da, aggiornato da, indirizzo
orderdiropzionalestringaValori di direzione di ordinamento consentiti: ASC, DESC
orderoffopzionalenumero interoOffset per l'elenco dei layer
orderlimitopzionalenumero interoLimite per l'elenco dei livelli
torna in cima


Parametri speciali per l'azione di ricerca

ParametroNecessario?Tipo di datiNote
SearchKeyrichiestostringaTasti di ricerca consentiti: id, markname, basemap, layer, lat, lon, icon, popuptext, zoom, openpopup, mapwidth, mapwidthunit, mapheight, panel, creato da, creato su, aggiornato da, aggiornato su, controlbox, overlays_custom, overlays_custom2, overlays_custom3, overlays_custom4, wlays , wms2, wms3, wms4, wms5, wms6, wms7, wms8, wms9, wms10, kml_timestamp, address, gpx_url, gpx_panel, name, layerzoom, layerviewlat, layerviewlon, listmarkers, multi_layer_map, cluster
searchValuedipendestringa o numero interogeneralmente richiesto ma facoltativo quando si utilizza la chiave di ricerca creata, aggiornata o boundingbox
data dadipendestringa (Ymd H: i: s)generalmente facoltativo ma richiesto quando si utilizza la chiave di ricerca creata o aggiornata
date_todipendestringa (Ymd H: i: s)generalmente facoltativo ma richiesto quando si utilizza la chiave di ricerca creata o aggiornata
lat_top_leftdipendefloatval (6)generalmente facoltativo ma richiesto quando si utilizza la boundingbox del tasto di ricerca
lon_top_leftdipendefloatval (6)generalmente facoltativo ma richiesto quando si utilizza la boundingbox del tasto di ricerca
lat_bottom_rightdipendefloatval (6)generalmente facoltativo ma richiesto quando si utilizza la boundingbox del tasto di ricerca
lon_bottom_rightdipendefloatval (6)generalmente facoltativo ma richiesto quando si utilizza la boundingbox del tasto di ricerca
torna in cima