Oppmerksomhet: MMPAPI er fjernet med v4.0, erstatning: Database API

MMPAPI dokumentasjon

tilbake til API-oversikt

MMPAPI-funksjoner

  1. Introduksjon
  2. generert klassebeskrivelse
  3. Markører
    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. Lag
    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. Tillatelser
    1. current_user_can_any
  6. parametere
    1. Tilgjengelige parametere for typemarkør
    2. Tilgjengelige parametere for typelag
    3. Spesielle parametere for markørlisteaksjon
    4. Spesielle parametere for laglistehandling
    5. Spesielle parametere for søkehandling


Introduksjon

Maps Marker Pro API-funksjoner gir utviklere en fremtidssikker måte å få tilgang til noen av de vanlige kjernefunksjonalitetene i Maps Marker Pro.

API-funksjonene blir automatisk inkludert når Maps Marker Pro lastes inn, og de vil være tilgjengelige når tilleggene lastes inn. API-klassen kalles MMPAPI og den kan finnes i /leaflet-maps-marker-pro/inc/class-mmpapi.php.


Generert klassebeskrivelse

Den automatisk genererte klassebeskrivelsen finner du på https://www.mapsmarker.com/wp-content/uploads/mmpapi/class/


Markører

add_marker

Legger til en ny markør ved å bruke det gitte Marker-objektet. Advarsel, lite kontroll blir gjort for å sikre at det er et gyldig Marker-objekt.

public static function add_marker( $marker_data ) {}

parametere

returer

Eksempel på bruk


$marker_data = array(
	'markername' => 'Headquarter',
	'geocode' => 'Main Street 1 Washington',
);
$marker_id = MMPAPI::add_marker( $marker_data );
tilbake til toppen


add_markers

Legg til markører basert på gitte dataobjekter.

public static function add_markers( $markers_data ) {}

parametere

returer

  • $ markører blandet

    En rekke markører-IDer eller WP_Error-objekt.

Eksempel på bruk


$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 );
tilbake til toppen


count_markers

Returnerer antall tilgjengelige markører.

public static function count_markers( ) {}

returer

  • $ markers_count int

    Markørene teller

Eksempel på bruk

$result = MMPAPI::count_markers( );
tilbake til toppen


delete_marker

Sletter markøren med gitt markør-ID.

public static function delete_marker( $marker_id ) {}

parametere

  • $ marker_id heltall

    IDen til markøren som skal slettes.

returer

Eksempel på bruk

$result = MMPAPI::delete_marker( $marker_id );
tilbake til toppen


delete_markers

Sletter markørene for en gitt markør-ID-er

public static function delete_markers( $marker_ids ) {}

parametere

  • $ marker_ids matrise

    IDene til markørene.

returer

  • $ resultat blandet

    Sann hvis markørene ble slettet, WP_Error objekt hvis ikke.

Eksempel på bruk


$marker_ids = array(6,7,8);
$result = MMPAPI::delete_markers( $marker_ids );
tilbake til toppen


get_marker

Returnerer markørobjektet for en gitt markør-ID.

public static function get_marker( $marker_id ) {}

parametere

  • $ marker_id heltall

    IDen til markøren.

returer

  • $ resultat blandet

    Markørobjektet eller usant.

Eksempel på bruk

$result = MMPAPI::get_marker( 5 );
tilbake til toppen


get_markers

Returnerer markørobjektene for gitte markør-ID-er.

public static function get_markers( $marker_ids ) {}

parametere

  • $ marker_ids matrise

    IDene til markørene.

returer

  • $ resultat blandet

    Markøren objekter eller usann.

Eksempel på bruk

$result = MMPAPI::get_markers( array( 1, 5, 10 ) );
tilbake til toppen


list_markers

Returnerer alle markørobjekter.

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

parametere

returer

  • $ resultat blandet

    Markøren objekter eller usann.

Eksempel på bruk


$args['orderkey'] = 'markername';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_markers( $args );
tilbake til toppen


search_markers

Søkemarkører gjør innvendinger mot et gitt argument.

public static function search_markers( $args ) {}

parametere

returer

  • $ resultat blandet

    Markørobjektene som samsvarer med parametrene eller Falske.

Eksempel på bruk


$args['searchkey'] = 'layer';
$args['searchvalue'] = 7;
$result = MMPAPI::search_markers( $args );
tilbake til toppen


update_marker

Oppdaterer en markør basert på gitt dataobjekt

public static function update_marker( $marker_data ) {}

parametere

returer

  • $ resultat boolean

    Sann hvis markøren har blitt oppdatert, falsk ellers.

Eksempel på bruk


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

$result = MMPAPI::update_marker( $marker_data );
tilbake til toppen


update_markers

Oppdater markører basert på gitt dataobjekt

public static function update_markers( $markers_data ) {}

parametere

returer

  • $ resultat blandet

    Array av IDer for oppdaterte markører eller et feilobjekt.

Eksempel på bruk


$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 );
tilbake til toppen


Lag

add_layer

Legger til et nytt lag ved å bruke det gitte lag-objektet. Advarsel, lite kontroll blir gjort for å sikre at det er et gyldig lag-objekt.

public static function add_layer( $layer_data ) {}

parametere

returer

Eksempel på bruk


$layer_data = array(
	'name' => 'Headquarter',
	'geocode' => 'Main Street 1 Washington',
);
$layer_id = MMPAPI::add_layer( $layer_data );
tilbake til toppen


add_layers

Legg til lag basert på gitte dataobjekter.

public static function add_layers( $layers_data ) {}

parametere

returer

  • $ lag blandet

    En rekke Lag-IDer eller WP_Error-objekt.

Eksempel på bruk


$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 );
tilbake til toppen


count_layers

Returnerer antall tilgjengelige lag.

public static function count_layers( ) {}

returer

  • $ layers_count int

    Lagene teller

Eksempel på bruk

$result = MMPAPI::count_layers( );
tilbake til toppen


delete_layer

Sletter laget med gitt lag-ID.

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

parametere

  • $ layer_id heltall

    ID-en for laget som skal slettes.

  • $ delete_markers boolean

    En boolesk parameter, hvis den har satt til SANN, vil metoden slette alle markørene som er tilknyttet laget. Standardverdien er FALSE.

returer

Eksempel på bruk

$result = MMPAPI::delete_layer( $layer_id );
tilbake til toppen


delete_layers

Sletter lagene for en gitt lag-ID-er

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

parametere

  • $ layers_ids matrise

    IDene til lagene.

  • $ delete_markers boolean

    En boolsk parameter, hvis den har satt til SANN, vil metoden slette alle markørene som er tilknyttet lagene. Standardverdien er FALSE.

returer

  • $ resultat blandet

    Sann hvis lagene ble slettet, WP_Error objekt hvis ikke.

Eksempel på bruk


$layers_ids = array(6,7,8);
$result = MMPAPI::delete_layers( $layers_ids );
tilbake til toppen


get_layer

Returnerer lagobjektet for en gitt lag-ID.

public static function get_layer( $layer_id ) {}

parametere

returer

  • $ resultat blandet

    Lagobjektet eller usant.

Eksempel på bruk

$result = MMPAPI::get_layer( 5 );
tilbake til toppen


get_layers

Returnerer lagobjektene for gitte lag-ID-er.

public static function get_layers( $layer_ids ) {}

parametere

  • $ layer_ids matrise

    IDene til lagene.

returer

  • $ resultat blandet

    Laget objekter eller usann.

Eksempel på bruk

$result = MMPAPI::get_layers( array( 1, 5, 10 ) );
tilbake til toppen


list_layers

Returnerer alle lagobjekter.

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

parametere

returer

  • $ resultat blandet

    Laget objekter eller usann.

Eksempel på bruk


$args['orderkey'] = 'name';
$args['orderdir'] = 'ASC';
$result = MMPAPI::list_layers( $args );
tilbake til toppen


search_layers

Søkelag objekt for et gitt argument.

public static function search_layers( $args ) {}

parametere

returer

  • $ resultat blandet

    Lagobjektene som samsvarer med parametrene eller Falske.

Eksempel på bruk


$args['searchkey'] = 'name';
$args['searchvalue'] = 'Washington';
$result = MMPAPI::search_layers( $args );
tilbake til toppen


update_layer

Oppdaterer et lag basert på et gitt dataobjekt

public static function update_layer( $layer_data ) {}

parametere

returer

  • $ resultat boolean

    Sann hvis laget har blitt oppdatert, falsk ellers.

Eksempel på bruk


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

$result = MMPAPI::update_layer( $layer_data );
tilbake til toppen


update_layers

Oppdater lag basert på gitt dataobjekt

public static function update_layers( $layers_data ) {}

parametere

returer

  • $ resultat blandet

    Array av IDer for oppdaterte lag eller et feilobjekt.

Eksempel på bruk


// 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 );
tilbake til toppen

Tillatelser

current_user_can_any

Sjekker tillatelsene for den nåværende brukeren. Returnerer true hvis den nåværende brukeren har noen av de spesifiserte funksjonene.

VIKTIG: Ring dette før du ringer til noen av de andre API-funksjonene da tillatelseskontroller ikke utføres på lavere nivåer.

public static function current_user_can_any( $capabilities ) {}

parametere

  • $ evner blandet

    Streng hvis du vil sjekke bare en evne, eller en rekke flere evner

returer

Eksempel på bruk


$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');
}
tilbake til toppen


parametere

Tilgjengelige parametere for typemarkør

Parameter Nødvendig? Data-type Standardverdi Merknader
idpåkrevdheltallangis automatisk når du legger til en ny markør
markernamevalgfrittstringNULL
geokodevalgfrittstringNULL verdien blir geokodet via Google Places API og overskriver parameter lat, lon og adresse
basis valgfritt forhåndsdefinerte baskart-ID-er - se notater standard grunnkart for ny markør (se innstillinger) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, ogbwapap_2
lag valgfritt heltall standardlag for ny markør (se innstillinger)
latvalgfrittflytestandardplassering for ny markør (se innstillinger) blir overskrevet hvis parametergeokode brukes!
lonvalgfrittflytestandardplassering for ny markør (se innstillinger) blir overskrevet hvis parametergeokode brukes!
iconvalgfrittstreng (f.eks. buss.png)NULL Hvis NULL, vil standardikonet brukes. Bare bruk filnavnet til ikonet som angitt i eksemplet. Alle ikoner som er tilgjengelige i ikonkatalogen (vanligvis / wp-content / uploads / leaflet-maps-marker-ikoner hvis du ikke endret det i Innstillinger / kartverdier / Standardverdier for markørikoner) er tilgjengelige for bruk.
POPUPTEXTvalgfrittstringNULL
zoomvalgfrittheltallstandard zoom for ny markør (se innstillinger)
openpopupvalgfrittbooleanstandardverdi for nye markører (se innstillinger)
mapwidthvalgfrittheltallstandard kartbredde for nye markører (se innstillinger)
mapwidthunitvalgfrittstringstandardverdi for nye markører (se innstillinger)
mapheightvalgfrittheltallstandard karthøyde for nye markører (se innstillinger)
panelvalgfrittbooleanstandardverdi for nye markører (se innstillinger)
laget avvalgfrittstringNULL
createdonvalgfrittdato (Ymd H: i: s)NULL
updatedbyvalgfrittstringNULL
updatedonvalgfrittdato (Ymd H: i: s)dato ('Ymd H: i: s)
kontroll boksvalgfrittbooleanstandardverdi for nye markører (se innstillinger)
overlays_customvalgfrittbooleanstandardverdi for nye markører (se innstillinger)
overlays_custom2valgfrittbooleanstandardverdi for nye markører (se innstillinger)
overlays_custom3valgfrittbooleanstandardverdi for nye markører (se innstillinger)
overlays_custom4valgfrittbooleanstandardverdi for nye markører (se innstillinger)
wmsvalgfrittbooleanstandardverdi for nye markører (se innstillinger)
wms2valgfrittbooleanstandardverdi for nye markører (se innstillinger)
wms3valgfrittbooleanstandardverdi for nye markører (se innstillinger)
wms4valgfrittbooleanstandardverdi for nye markører (se innstillinger)
wms5valgfrittbooleanstandardverdi for nye markører (se innstillinger)
wms6valgfrittbooleanstandardverdi for nye markører (se innstillinger)
wms7valgfrittbooleanstandardverdi for nye markører (se innstillinger)
wms8valgfrittbooleanstandardverdi for nye markører (se innstillinger)
wms9valgfrittbooleanstandardverdi for nye markører (se innstillinger)
wms10valgfrittbooleanstandardverdi for nye markører (se innstillinger)
kml_timestampvalgfrittdato (Ymd H: i: s)NULL
adressevalgfrittstringNULL blir overskrevet hvis parametergeokode brukes!
gpx_urlvalgfrittstringNULL siden v1.2p
gpx_panelvalgfrittboolean0 siden v1.2p

tilbake til toppen


Tilgjengelige parametere for typelag

Parameter Nødvendig? Data-type Standardverdi Merknader
idpåkrevdheltallangis automatisk når du legger til en ny markør
geokodevalgfrittstringNULL verdien blir geokodet via Google Places API og overskriver parameter lat, lon og adresse
navnvalgfrittstringNULL
basisvalgfrittforhåndsdefinerte verdierstandard grunnkart for nytt lag (se innstillinger) osm_mapnik, mapquest_osm, mapquest_aerial, googleLayer_roadmap, googleLayer_satellite, googleLayer_hybrid, googleLayer_terrain, bingaerial, bingaerialwithlabels, bingroad, ogdwien_basemap, ogbwapap_2
layerzoomvalgfrittheltallstandard zoom for nytt lag (se innstillinger)
mapwidthunitvalgfrittstringstandardverdi for nytt lag (se innstillinger)
mapwidthvalgfrittheltallstandard kartbredde for nytt lag (se innstillinger)
mapheightvalgfrittheltallstandard karthøyde for nytt lag (se innstillinger)
panelvalgfrittbooleanstandardverdi for nytt lag (se innstillinger)
layerviewlatvalgfrittflytestandard lat for nytt lag (se innstillinger) blir overskrevet hvis parametergeokode brukes!
layerviewlonvalgfrittflytestandard lon for nytt lag (se innstillinger) blir overskrevet hvis parametergeokode brukes!
laget avvalgfrittstringNULL
createdonvalgfrittdato (Ymd H: i: s)NULL
updatedbyvalgfrittstringNULL
updatedonvalgfrittdato (Ymd H: i: s)dato ('Ymd H: i: s)
kontroll boksvalgfrittbooleanstandardverdi for nytt lag (se innstillinger)
overlays_custompåkrevdbooleanstandardverdi for nytt lag (se innstillinger)
overlays_custom2påkrevdbooleanstandardverdi for nytt lag (se innstillinger)
overlays_custom3påkrevdbooleanstandardverdi for nytt lag (se innstillinger)
overlays_custom4påkrevdbooleanstandardverdi for nytt lag (se innstillinger)
wmspåkrevdbooleanstandardverdi for nytt lag (se innstillinger)
wms2påkrevdbooleanstandardverdi for nytt lag (se innstillinger)
wms3påkrevdbooleanstandardverdi for nytt lag (se innstillinger)
wms4påkrevdbooleanstandardverdi for nytt lag (se innstillinger)
wms5påkrevdbooleanstandardverdi for nytt lag (se innstillinger)
wms6påkrevdbooleanstandardverdi for nytt lag (se innstillinger)
wms7påkrevdbooleanstandardverdi for nytt lag (se innstillinger)
wms8påkrevdbooleanstandardverdi for nytt lag (se innstillinger)
wms9påkrevdbooleanstandardverdi for nytt lag (se innstillinger)
wms10påkrevdbooleanstandardverdi for nytt lag (se innstillinger)
listmarkersvalgfrittbooleanstandardverdi for nytt lag (se innstillinger) alternativet for å vise liste over markører under lagkart
multi_layer_mapvalgfrittboolean0
multi_layer_map_listvalgfrittstreng (komma-separerte lag-IDer eller alle)NULL for eksempel 1,2,3,4 eller alle
adressevalgfrittstringNULL blir overskrevet hvis parametergeokode brukes!
delete_markersvalgfrittsant / usantfalsk når de brukes på slettehandling, blir også tildelte markører slettet
grupperingvalgfrittbooleanstandardverdi for nytt lag (se innstillinger) bare tilgjengelig i proversjon
gpx_urlvalgfrittstringNULL siden v1.2p
gpx_panelvalgfrittboolean0 siden v1.2p


Spesielle parametere for markørlisteaksjon

ParameterNødvendig?Data-typeMerknader
orderkeyvalgfrittstringTillatte sorteringsverdier: id, opprettet, oppdatert, kml_timestamp, merkenavn, basekart, lat, lon, opprettetby, oppdatertby, adresse
orderdirvalgfrittstringTillatte sorteringsverdier: ASC, DESC
orderoffvalgfrittheltallOffset for markørlisten
orderlimitvalgfrittheltallBegrens for markørlisten
tilbake til toppen


Spesielle parametere for laglistehandling

ParameterNødvendig?Data-typeMerknader
orderkeyvalgfrittstringTillatte sorteringsverdier: id, oppdatert, opprettet, navn, basekart, lagerviewlat, layerviewlon, opprettetby, oppdatertby, adresse
orderdirvalgfrittstringTillatte sorteringsverdier: ASC, DESC
orderoffvalgfrittheltallOffset for laglisten
orderlimitvalgfrittheltallBegrens for laglisten
tilbake til toppen


Spesielle parametere for søkehandling

ParameterNødvendig?Data-typeMerknader
searchkeypåkrevdstringTillatte søketaster: ID, merkenavn, basekart, lag, lat, lon, ikon, popup-tekst, zoom, openpopup, kartbredde, kartbredde, karthøyde, panel, opprettet av, opprettet, oppdatert, oppdatert, kontrollboks, overlegg_tilpasset, overlegg_tilpass2, overlegg_tilpassning3, overlegg_custom4, wms , wms2, wms3, wms4, wms5, wms6, wms7, wms8, wms9, wms10, kml_timestamp, adresse, gpx_url, gpx_panel, navn, lagzoom, layerviewlat, layerviewlon, listemarkører, multi_layer_map, multi_layer_map_list, clipping,
searchvalueavhengerstreng eller heltallgenerelt påkrevd, men valgfritt når du bruker søketasten opprettet, oppdatert eller grenseboks
dato fraavhengerstreng (Ymd H: i: s)generelt valgfritt, men påkrevd når du bruker søkeord opprettet eller oppdatert
date_toavhengerstreng (Ymd H: i: s)generelt valgfritt, men påkrevd når du bruker søkeord opprettet eller oppdatert
lat_top_leftavhengerfloatval (6)generelt valgfritt, men påkrevd når du bruker søketasten
lon_top_leftavhengerfloatval (6)generelt valgfritt, men påkrevd når du bruker søketasten
lat_bottom_rightavhengerfloatval (6)generelt valgfritt, men påkrevd når du bruker søketasten
lon_bottom_rightavhengerfloatval (6)generelt valgfritt, men påkrevd når du bruker søketasten
tilbake til toppen