Databas API

Innehåll

Observera att försiktighet måste vidtas när man manipulerar Maps Marker Pro-databasen direkt via API för att undvika dataförlust. Alla samtal är omedelbara och kan inte ångras.

Tänk också på att vårt support inte täcker detaljerade frågor om anpassad utveckling baserat på detta API.

Användning

För att använda DB API måste vi först anpassa klassen:

$db = new MMP\DB();

Kartor returnerar objekt med följande 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 returnerar objekt med följande 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

Exempel

Hämta kartan med ID 1, ändra namn, bredd och höjd och spara ändringarna

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

Skaffa markören med ID 1, ändra namn, ikon och popup och spara ändringarna

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

Metodreferens

create_tables ()

Skapar databastabellerna


parametrar

Den här metoden har inga parametrar


Returnera värden

Inget värde returneras


changelog

version Beskrivning
4.0 infört

delete_tables ()

Tar bort databastabellerna


parametrar

Den här metoden har inga parametrar


Returnera värden

Inget värde returneras


changelog

version Beskrivning
4.0 infört

reset_tables ()

Återställer databastabellerna


parametrar

Den här metoden har inga parametrar


Returnera värden

Inget värde returneras


changelog

version Beskrivning
4.0 infört

count_maps ($ filter = array ())

Returnerar det totala antalet kartor
Accepterar valfritt en lista med filter


parametrar

$ filter
(array) (valfritt) Lista över filter

Returnera värden

(int) Totalt antal kartor


changelog

version Beskrivning
4.0 infört

get_map ($ id, $ count = falsk)

Returnerar kartan för givet ID


parametrar

$ id
(int) Kart-ID
$ count
(bool) (valfritt) Huruvida de tilldelade markörerna ska räknas

Returnera värden

(objekt | null) Kartobjekt eller null om inget resultat hittas


changelog

version Beskrivning
4.0 infört

get_maps ($ ids, $ count = falsk)

Returnerar kartorna för de angivna ID: erna


parametrar

$ ids
(array | sträng) Lista eller CSV med kart-ID: er
$ count
(bool) (valfritt) Huruvida de tilldelade markörerna ska räknas

Returnera värden

(array) Lista med kartobjekt


changelog

version Beskrivning
4.0 infört

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

Returnerar alla kartor
Accepterar valfritt en lista med filter


parametrar

$ count
(bool) (valfritt) Huruvida de tilldelade markörerna ska räknas
$ filter
(array) (valfritt) Lista över filter

Returnera värden

(array) Lista med kartobjekt


changelog

version Beskrivning
4.0 infört

get_map_shortcodes ($ id)

Returnerar alla inlägg som använder en kortkod för det angivna kart-ID


parametrar

$ id
(int) Kart-ID

Returnera värden

(array) Lista över inlägg


changelog

version Beskrivning
4.0 infört

add_map ($ uppgifter, $ id = 0)

Lägger till en karta


parametrar

$ uppgifter
(objekt) Kartdata som ska skrivas
$ id
(int) (valfritt) ID för den nya kartan

Returnera värden

(int | bool) Kart-ID eller felaktigt om kartan inte kunde läggas till


changelog

version Beskrivning
4.0 infört

add_maps ($ uppgifter)

Lägger till flera kartor


parametrar

$ uppgifter
(array) Lista med kartdata som ska skrivas

Returnera värden

(int | bool) Antal påverkade rader eller falska om kartorna inte kunde läggas till


changelog

version Beskrivning
4.0 infört

update_map ($ uppgifter, $ id)

Uppdaterar en karta


parametrar

$ uppgifter
(objekt) Kartdata som ska skrivas
$ id
(int) ID för kartan som ska uppdateras

Returnera värden

(int | bool) Antal påverkade rader eller felaktiga om kartan inte kunde uppdateras


changelog

version Beskrivning
4.0 infört

update_maps ($ uppgifter, $ ids)

Uppdaterar flera kartor


parametrar

$ uppgifter
(objekt) Kartdata som ska skrivas
$ ids
(array | sträng) Lista eller CSV med kart-ID: er

Returnera värden

(int) Antal påverkade rader


changelog

version Beskrivning
4.0 infört

delete_map ($ id)

Tar bort en karta och dess relationer


parametrar

$ id
(int) ID för kartan som ska raderas

Returnera värden

(int | bool) Antal påverkade rader eller falska om kartan inte kunde raderas


changelog

version Beskrivning
4.0 infört

delete_maps ($ ids)

Tar bort flera kartor och deras relationer


parametrar

$ ids
(array | sträng) Lista eller CSV med kart-ID: er

Returnera värden

(int | bool) Antal påverkade rader eller falska om kartorna inte kunde raderas


changelog

version Beskrivning
4.0 infört

count_markers ($ filter = array ())

Returnerar det totala antalet markörer
Accepterar valfritt en lista med filter


parametrar

$ filter
(array) (valfritt) Lista över filter

Returnera värden

(int) Totalt antal markörer


changelog

version Beskrivning
4.0 infört

count_map_markers ($ id)

Returnerar det totala antalet markörer för det givna kart-ID


parametrar

$ id
(int) Kart-ID

Returnera värden

(int) Totalt antal markörer för det givna kart-ID


changelog

version Beskrivning
4.0 infört

get_marker ($ id)

Returnerar markören för givet ID


parametrar

$ id
(int) Marker-ID

Returnera värden

(objekt | null) Markörobjekt eller null om inget resultat hittas


changelog

version Beskrivning
4.0 infört

get_markers ($ ids)

Returnerar markörerna för de angivna ID: erna


parametrar

$ ids
(array | sträng) Lista eller CSV för markör-ID

Returnera värden

(array) Lista över markörobjekt


changelog

version Beskrivning
4.0 infört

get_all_markers ($ filter = array ())

Returnerar alla markörer
Accepterar valfritt en lista med filter


parametrar

$ filter
(array) (valfritt) Lista över filter

Returnera värden

(array) Lista över markörobjekt


changelog

version Beskrivning
4.0 infört

get_map_markers ($ id)

Returnerar markörerna för det angivna kart-ID


parametrar

$ id
(int) Kart-ID

Returnera värden

(array) Lista över markörobjekt


changelog

version Beskrivning
4.0 infört

get_maps_markers ($ ids)

Returnerar markörerna för de givna kart-ID: n


parametrar

$ ids
(int) Kart-ID

Returnera värden

(array) Lista över markörobjekt


changelog

version Beskrivning
4.0 infört

add_marker ($ uppgifter, $ id = 0)

Lägger till en markör


parametrar

$ uppgifter
(objekt) Markördata som ska skrivas
$ id
(int) (valfritt) ID för den nya markören

Returnera värden

(int | bool) Markör-ID eller falsk om markören inte kunde läggas till


changelog

version Beskrivning
4.0 infört

add_markers ($ uppgifter)

Lägger till flera markörer


parametrar

$ uppgifter
(array) Lista över markördata som ska skrivas

Returnera värden

(int | bool) Antal påverkade rader eller falska om markörerna inte kunde läggas till


changelog

version Beskrivning
4.0 infört

update_marker ($ uppgifter, $ id)

Uppdaterar en markör


parametrar

$ uppgifter
(objekt) Markördata som ska skrivas
$ id
(int) ID för markören som ska uppdateras

Returnera värden

(int | bool) Antal påverkade rader eller falska om markören inte kunde uppdateras


changelog

version Beskrivning
4.0 infört

update_markers ($ uppgifter, $ ids)

Uppdaterar flera markörer


parametrar

$ uppgifter
(objekt) Markördata som ska skrivas
$ ids
(array | sträng) Lista eller CSV för markör-ID

Returnera värden

(int | bool) Antal påverkade rader eller falska om markörerna inte kunde uppdateras


changelog

version Beskrivning
4.0 infört

assign_marker ($ MAP_ID, $ marker_id)

Tilldelar en markör på en karta


parametrar

$ MAP_ID
(int) Kart-ID
$ marker_id
(int) Marker-ID

Returnera värden

(int | bool) Antal påverkade rader eller falska om markören inte kunde tilldelas


changelog

version Beskrivning
4.0 infört

assign_markers ($ MAP_ID, $ marker_ids)

Tilldelar flera markörer till en karta


parametrar

$ MAP_ID
(int) Kart-ID
$ marker_ids
(array | sträng) Lista eller CSV för markör-ID

Returnera värden

(int | bool) Antal påverkade rader eller falska om markörerna inte kunde tilldelas


changelog

version Beskrivning
4.0 infört

assign_maps_marker ($ map_ids, $ marker_id)

Tilldelar en markör till flera kartor


parametrar

$ map_ids
(array | sträng) Lista eller CSV med kart-ID: er
$ marker_id
(int) Marker-ID

Returnera värden

(int | bool) Antal påverkade rader eller falska om markören inte kunde tilldelas


changelog

version Beskrivning
4.0 infört

assign_maps_markers ($ map_ids, $ marker_ids)

Tilldelar flera markörer till flera kartor


parametrar

$ map_ids
(array | sträng) Lista eller CSV med kart-ID: er
$ marker_ids
(array | sträng) Lista eller CSV för markör-ID

Returnera värden

(int | bool) Antal påverkade rader eller falska om markörerna inte kunde tilldelas


changelog

version Beskrivning
4.0 infört

assign_assoc ($ assoc)

Tilldelar markörer från en associerande lista


parametrar

$ assoc
(array) Associativ lista över markör-ID => kart-ID

Returnera värden

(int | bool) Antal påverkade rader eller falska om markörerna inte kunde tilldelas


changelog

version Beskrivning
4.9 infört

unassign_marker ($ MAP_ID, $ marker_id)

Tilldelar inte en markör från en karta


parametrar

$ MAP_ID
(int) Kart-ID
$ marker_id
(int) Marker-ID

Returnera värden

(int | bool) Antal påverkade rader eller falska om markören inte kunde tilldelas


changelog

version Beskrivning
4.0 infört

unassign_markers ($ MAP_ID, $ marker_ids)

Tilldelar inte flera markörer från en karta


parametrar

$ MAP_ID
(int) Kart-ID
$ marker_ids
(array | sträng) Lista eller CSV för markör-ID

Returnera värden

(int | bool) Antal påverkade rader eller falska om markörerna inte kunde tilldelas


changelog

version Beskrivning
4.0 infört

unassign_maps_marker ($ map_ids, $ marker_id)

Tilldelar inte en markör från flera kartor


parametrar

$ map_ids
(array | sträng) Lista eller CSV med kart-ID: er
$ marker_id
(int) Marker-ID

Returnera värden

(int | bool) Antal påverkade rader eller falska om markören inte kunde tilldelas


changelog

version Beskrivning
4.0 infört

unassign_all_markers ($ MAP_ID)

Tilldelar inte alla markörer från en karta


parametrar

$ MAP_ID
(int) Kart-ID

Returnera värden

(int | bool) Antal påverkade rader eller falska om markörerna inte kunde tilldelas


changelog

version Beskrivning
4.0 infört

delete_marker ($ id)

Tar bort en markör och dess relationer


parametrar

$ id
(int) ID för markören som ska raderas

Returnera värden

(int | bool) Antal påverkade rader eller falska om markören inte kunde raderas


changelog

version Beskrivning
4.0 infört

delete_markers ($ ids)

Tar bort flera markörer och deras relationer


parametrar

$ ids
(array | sträng) Lista eller CSV för markör-ID

Returnera värden

(int | bool) Antal påverkade rader eller falska om markörerna inte kunde raderas


changelog

version Beskrivning
4.0 infört

get_layer ($ id)

Returnerar lagret för det givna ID


parametrar

$ id
(int) Skikt-ID

Returnera värden

(objekt | null) Lagerobjekt eller null om inget resultat hittas


changelog

version Beskrivning
4.0 infört

get_all_layers ()

Returnerar alla lager


parametrar

Den här metoden har inga parametrar


Returnera värden

(array) Lista med lagerobjekt


changelog

version Beskrivning
4.0 infört

get_all_basemaps ()

Returnerar alla baskartor


parametrar

Den här metoden har inga parametrar


Returnera värden

(array) Lista med lagerobjekt


changelog

version Beskrivning
4.0 infört

get_all_overlays ()

Returnerar alla överlägg


parametrar

Den här metoden har inga parametrar


Returnera värden

(array) Lista med lagerobjekt


changelog

version Beskrivning
4.0 infört

add_layer ($ uppgifter, $ id = 0)

Lägger till ett lager


parametrar

$ uppgifter
(objekt) Lagerdata som ska skrivas
$ id
(int) (valfritt) ID för det nya lagret

Returnera värden

(int | bool) Lager-ID eller felaktigt om lagret inte kunde läggas till


changelog

version Beskrivning
4.0 infört

update_layer ($ uppgifter, $ id)

Uppdaterar ett lager


parametrar

$ uppgifter
(objekt) Lagerdata som ska skrivas
$ id
(int) ID för det lager som ska uppdateras

Returnera värden

(int | bool) Antal påverkade rader eller falskt om lagret inte kunde uppdateras


changelog

version Beskrivning
4.0 infört

delete_layer ($ id)

Tar bort ett lager


parametrar

$ id
(int) Skikt-ID

Returnera värden

(int | bool) Antal påverkade rader eller falska om lagret inte kunde raderas


changelog

version Beskrivning
4.0 infört

delete_orphaned_rels ()

Tar bort föräldralösa relationer


parametrar

Den här metoden har inga parametrar


Returnera värden

(int | bool) Antal påverkade rader eller falska om de föräldralösa barnen inte kunde raderas


changelog

version Beskrivning
4.7 infört

build_marker ($ uppgifter, $ GeoJSON = falsk)

Skapar ett giltigt markörobjekt


parametrar

$ uppgifter
(array) Lista över markördata
$ GeoJSON
(bool) (valfritt) Huruvida uppgifterna är i GeoJSON-format

Returnera värden

(array) Markörobjekt


changelog

version Beskrivning
4.9 infört

sanitize_ids ($ ids, $ csv = falsk)

Rensar en matris eller kommaseparerad lista med ID: er


parametrar

$ ids
(array | sträng) Lista eller CSV-ID
$ csv
(bool) (valfritt) Huruvida de sanerade ID: erna ska returneras som CSV

Returnera värden

(array | string) Lista eller CSV med sanerade ID: er


changelog

version Beskrivning
4.0 infört

prepare_layers ()

Returnerar lagarna för lagring av sanering för att förbereda uttalanden


parametrar

Den här metoden har inga parametrar


Returnera värden

(array) Lista över saneringsregler (kolumn => regel)


changelog

version Beskrivning
4.0 infört

prepare_maps ()

Returnerar kartorna för sanering av kartor för utarbetande av uttalanden


parametrar

Den här metoden har inga parametrar


Returnera värden

(array) Lista över saneringsregler (kolumn => regel)


changelog

version Beskrivning
4.0 infört

prepare_markers ()

Returnerar markörens tabell sanitetsregler för att utarbeta uttalanden


parametrar

Den här metoden har inga parametrar


Returnera värden

(array) Lista över saneringsregler (kolumn => regel)


changelog

version Beskrivning
4.0 infört

prepare_rels ()

Returnerar förhållandestabellen sanitetsregler för att förbereda uttalanden


parametrar

Den här metoden har inga parametrar


Returnera värden

(array) Lista över saneringsregler (kolumn => regel)


changelog

version Beskrivning
4.0 infört
3
2
12049
Betygsätt denna referens

Du får inte betygsätta det här inlägget.

en English
X