API de base de données

Contents [show]

Veuillez noter que la prudence doit être utilisée lors de la manipulation de la base de données Maps Marker Pro directement via l'API pour éviter la perte de données. Tous les appels sont immédiats et ne peuvent pas être annulés.

Veuillez également noter que notre support ne couvre pas les questions détaillées sur le développement personnalisé basé sur cette API.

Utilisation

Pour utiliser l'API DB, nous devons d'abord instancier la classe:

$db = new MMP\DB();

Les cartes renvoient des objets avec les propriétés suivantes:

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)

Les marqueurs renvoient des objets avec les propriétés suivantes:

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

Exemples

Obtenez la carte avec l'ID 1, changez le nom, la largeur et la hauteur et enregistrez les modifications

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

Obtenez le marqueur avec ID 1, changez le nom, l'icône et la fenêtre contextuelle et enregistrez les modifications

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

Référence de méthode

create_tables ()

Crée les tables de base de données


Paramètres

Cette méthode n'a pas de paramètres


Renvoyer des valeurs

Aucune valeur n'est retournée


Changelog

version Description
4.0 Introduit

delete_tables ()

Supprime les tables de base de données


Paramètres

Cette méthode n'a pas de paramètres


Renvoyer des valeurs

Aucune valeur n'est retournée


Changelog

version Description
4.0 Introduit

reset_tables ()

Réinitialise les tables de la base de données


Paramètres

Cette méthode n'a pas de paramètres


Renvoyer des valeurs

Aucune valeur n'est retournée


Changelog

version Description
4.0 Introduit

count_maps ($ filtres = array ())

Renvoie le nombre total de cartes
Accepte éventuellement une liste de filtres


Paramètres

$ filtres
(tableau) (facultatif) Liste des filtres

Renvoyer des valeurs

(int) Nombre total de cartes


Changelog

version Description
4.0 Introduit

get_map ($ Id, $ count = faux)

Renvoie la carte pour l'ID donné


Paramètres

$ Id
(int) ID de la carte
$ count
(bool) (facultatif) Indique si les marqueurs attribués doivent être comptés

Renvoyer des valeurs

(objet | null) Mapper l'objet ou null si aucun résultat n'est trouvé


Changelog

version Description
4.0 Introduit

get_maps ($ ids, $ count = faux)

Renvoie les cartes pour les ID donnés


Paramètres

$ ids
(tableau | chaîne) Liste ou CSV des ID de carte
$ count
(bool) (facultatif) Indique si les marqueurs attribués doivent être comptés

Renvoyer des valeurs

(tableau) Liste des objets de carte


Changelog

version Description
4.0 Introduit

get_all_maps ($ count = faux, $ filtres = array ())

Renvoie toutes les cartes
Accepte éventuellement une liste de filtres


Paramètres

$ count
(bool) (facultatif) Indique si les marqueurs attribués doivent être comptés
$ filtres
(tableau) (facultatif) Liste des filtres

Renvoyer des valeurs

(tableau) Liste des objets de carte


Changelog

version Description
4.0 Introduit

get_map_shortcodes ($ Id)

Renvoie toutes les publications qui utilisent un shortcode pour l'ID de carte donné


Paramètres

$ Id
(int) ID de la carte

Renvoyer des valeurs

(tableau) Liste des articles


Changelog

version Description
4.0 Introduit

add_map ($ Data, $ Id = 0)

Ajoute une carte


Paramètres

$ Data
(objet) Données cartographiques à écrire
$ Id
(int) (facultatif) ID pour la nouvelle carte

Renvoyer des valeurs

(int | bool) ID de carte ou faux si la carte n'a pas pu être ajoutée


Changelog

version Description
4.0 Introduit

add_maps ($ Data)

Ajoute plusieurs cartes


Paramètres

$ Data
(tableau) Liste des données cartographiques à écrire

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si les cartes n'ont pas pu être ajoutées


Changelog

version Description
4.0 Introduit

update_map ($ Data, $ Id)

Met à jour une carte


Paramètres

$ Data
(objet) Données cartographiques à écrire
$ Id
(int) ID de la carte à mettre à jour

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si la carte n'a pas pu être mise à jour


Changelog

version Description
4.0 Introduit

update_maps ($ Data, $ ids)

Met à jour plusieurs cartes


Paramètres

$ Data
(objet) Données cartographiques à écrire
$ ids
(tableau | chaîne) Liste ou CSV des ID de carte

Renvoyer des valeurs

(int) Nombre de lignes affectées


Changelog

version Description
4.0 Introduit

delete_map ($ Id)

Supprime une carte et ses relations


Paramètres

$ Id
(int) ID de la carte à supprimer

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si la carte n'a pas pu être supprimée


Changelog

version Description
4.0 Introduit

delete_maps ($ ids)

Supprime plusieurs cartes et leurs relations


Paramètres

$ ids
(tableau | chaîne) Liste ou CSV des ID de carte

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si les mappes n'ont pas pu être supprimées


Changelog

version Description
4.0 Introduit

count_markers ($ filtres = array ())

Renvoie le nombre total de marqueurs
Accepte éventuellement une liste de filtres


Paramètres

$ filtres
(tableau) (facultatif) Liste des filtres

Renvoyer des valeurs

(int) Nombre total de marqueurs


Changelog

version Description
4.0 Introduit

count_map_markers ($ Id)

Renvoie le nombre total de marqueurs pour l'ID de carte donné


Paramètres

$ Id
(int) ID de la carte

Renvoyer des valeurs

(int) Nombre total de marqueurs pour l'ID de carte donné


Changelog

version Description
4.0 Introduit

get_marker ($ Id)

Renvoie le marqueur pour l'ID donné


Paramètres

$ Id
(int) ID de marqueur

Renvoyer des valeurs

(objet | null) Objet marqueur ou null si aucun résultat n'est trouvé


Changelog

version Description
4.0 Introduit

get_markers ($ ids)

Renvoie les marqueurs pour les ID donnés


Paramètres

$ ids
(tableau | chaîne) Liste ou CSV des ID de marqueur

Renvoyer des valeurs

(tableau) Liste des objets marqueurs


Changelog

version Description
4.0 Introduit

get_all_markers ($ filtres = array ())

Renvoie tous les marqueurs
Accepte éventuellement une liste de filtres


Paramètres

$ filtres
(tableau) (facultatif) Liste des filtres

Renvoyer des valeurs

(tableau) Liste des objets marqueurs


Changelog

version Description
4.0 Introduit

get_map_markers ($ Id)

Renvoie les marqueurs pour l'ID de carte donné


Paramètres

$ Id
(int) ID de la carte

Renvoyer des valeurs

(tableau) Liste des objets marqueurs


Changelog

version Description
4.0 Introduit

get_maps_markers ($ ids)

Renvoie les marqueurs pour les ID de carte donnés


Paramètres

$ ids
(int) ID de carte

Renvoyer des valeurs

(tableau) Liste des objets marqueurs


Changelog

version Description
4.0 Introduit

add_marker ($ Data, $ Id = 0)

Ajoute un marqueur


Paramètres

$ Data
(objet) Données de marqueur à écrire
$ Id
(int) (facultatif) ID pour le nouveau marqueur

Renvoyer des valeurs

(int | bool) ID de marqueur ou faux si le marqueur n'a pas pu être ajouté


Changelog

version Description
4.0 Introduit

add_markers ($ Data)

Ajoute plusieurs marqueurs


Paramètres

$ Data
(tableau) Liste des données de marqueur à écrire

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si les marqueurs n'ont pas pu être ajoutés


Changelog

version Description
4.0 Introduit

update_marker ($ Data, $ Id)

Met à jour un marqueur


Paramètres

$ Data
(objet) Données de marqueur à écrire
$ Id
(int) ID du marqueur à mettre à jour

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si le marqueur n'a pas pu être mis à jour


Changelog

version Description
4.0 Introduit

update_markers ($ Data, $ ids)

Met à jour plusieurs marqueurs


Paramètres

$ Data
(objet) Données de marqueur à écrire
$ ids
(tableau | chaîne) Liste ou CSV des ID de marqueur

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si les marqueurs n'ont pas pu être mis à jour


Changelog

version Description
4.0 Introduit

assign_marker ($ map_id, $ marker_id)

Attribue un marqueur à une carte


Paramètres

$ map_id
(int) ID de la carte
$ marker_id
(int) ID de marqueur

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si le marqueur n'a pas pu être attribué


Changelog

version Description
4.0 Introduit

assign_markers ($ map_id, $ marker_ids)

Attribue plusieurs marqueurs à une carte


Paramètres

$ map_id
(int) ID de la carte
$ marker_ids
(tableau | chaîne) Liste ou CSV des ID de marqueur

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si les marqueurs n'ont pas pu être attribués


Changelog

version Description
4.0 Introduit

assign_maps_marker ($ map_ids, $ marker_id)

Attribue un marqueur à plusieurs cartes


Paramètres

$ map_ids
(tableau | chaîne) Liste ou CSV des ID de carte
$ marker_id
(int) ID de marqueur

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si le marqueur n'a pas pu être attribué


Changelog

version Description
4.0 Introduit

assign_maps_markers ($ map_ids, $ marker_ids)

Attribue plusieurs marqueurs à plusieurs cartes


Paramètres

$ map_ids
(tableau | chaîne) Liste ou CSV des ID de carte
$ marker_ids
(tableau | chaîne) Liste ou CSV des ID de marqueur

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si les marqueurs n'ont pas pu être attribués


Changelog

version Description
4.0 Introduit

assign_assoc ($ assoc)

Attribue des marqueurs à partir d'une liste associative


Paramètres

$ assoc
(tableau) Liste associative d'ID de marqueur => ID de carte

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si les marqueurs n'ont pas pu être attribués


Changelog

version Description
4.9 Introduit

unassign_marker ($ map_id, $ marker_id)

Désaffecte un marqueur d'une carte


Paramètres

$ map_id
(int) ID de la carte
$ marker_id
(int) ID de marqueur

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si le marqueur n'a pas pu être désaffecté


Changelog

version Description
4.0 Introduit

unassign_markers ($ map_id, $ marker_ids)

Désaffecte plusieurs marqueurs d'une carte


Paramètres

$ map_id
(int) ID de la carte
$ marker_ids
(tableau | chaîne) Liste ou CSV des ID de marqueur

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si les marqueurs n'ont pas pu être désaffectés


Changelog

version Description
4.0 Introduit

unassign_maps_marker ($ map_ids, $ marker_id)

Désaffecte un marqueur de plusieurs cartes


Paramètres

$ map_ids
(tableau | chaîne) Liste ou CSV des ID de carte
$ marker_id
(int) ID de marqueur

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si le marqueur n'a pas pu être désaffecté


Changelog

version Description
4.0 Introduit

unassign_all_markers ($ map_id)

Désaffecte tous les marqueurs d'une carte


Paramètres

$ map_id
(int) ID de la carte

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si les marqueurs n'ont pas pu être désaffectés


Changelog

version Description
4.0 Introduit

delete_marker ($ Id)

Supprime un marqueur et ses relations


Paramètres

$ Id
(int) ID du marqueur à supprimer

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si le marqueur n'a pas pu être supprimé


Changelog

version Description
4.0 Introduit

delete_markers ($ ids)

Supprime plusieurs marqueurs et leurs relations


Paramètres

$ ids
(tableau | chaîne) Liste ou CSV des ID de marqueur

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si les marqueurs n'ont pas pu être supprimés


Changelog

version Description
4.0 Introduit

get_layer ($ Id)

Renvoie la couche pour l'ID donné


Paramètres

$ Id
(int) ID de couche

Renvoyer des valeurs

(objet | null) Objet de calque ou null si aucun résultat n'est trouvé


Changelog

version Description
4.0 Introduit

get_all_layers ()

Renvoie tous les calques


Paramètres

Cette méthode n'a pas de paramètres


Renvoyer des valeurs

(tableau) Liste des objets de calque


Changelog

version Description
4.0 Introduit

get_all_basemaps ()

Renvoie tous les fonds de carte


Paramètres

Cette méthode n'a pas de paramètres


Renvoyer des valeurs

(tableau) Liste des objets de calque


Changelog

version Description
4.0 Introduit

get_all_overlays ()

Renvoie toutes les superpositions


Paramètres

Cette méthode n'a pas de paramètres


Renvoyer des valeurs

(tableau) Liste des objets de calque


Changelog

version Description
4.0 Introduit

add_layer ($ Data, $ Id = 0)

Ajoute un calque


Paramètres

$ Data
(objet) Données de couche à écrire
$ Id
(int) (facultatif) ID pour la nouvelle couche

Renvoyer des valeurs

(int | bool) ID de couche ou faux si la couche n'a pas pu être ajoutée


Changelog

version Description
4.0 Introduit

update_layer ($ Data, $ Id)

Met à jour une couche


Paramètres

$ Data
(objet) Données de couche à écrire
$ Id
(int) ID de la couche à mettre à jour

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si la couche n'a pas pu être mise à jour


Changelog

version Description
4.0 Introduit

delete_layer ($ Id)

Supprime un calque


Paramètres

$ Id
(int) ID de couche

Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si le calque n'a pas pu être supprimé


Changelog

version Description
4.0 Introduit

delete_orphaned_rels ()

Supprime les relations orphelines


Paramètres

Cette méthode n'a pas de paramètres


Renvoyer des valeurs

(int | bool) Nombre de lignes affectées ou false si les orphelins n'ont pas pu être supprimés


Changelog

version Description
4.7 Introduit

build_marker ($ Data, $ geojson = faux)

Construit un objet marqueur valide


Paramètres

$ Data
(tableau) Liste des données de marqueur
$ geojson
(bool) (facultatif) si les données sont au format GeoJSON

Renvoyer des valeurs

(tableau) Objet marqueur


Changelog

version Description
4.9 Introduit

sanitize_ids ($ ids, $ csv = faux)

Assainit un tableau ou une liste d'ID séparés par des virgules


Paramètres

$ ids
(tableau | chaîne) Liste ou CSV des ID
$ csv
(bool) (facultatif) Indique si les ID nettoyés doivent être renvoyés au format CSV

Renvoyer des valeurs

(tableau | chaîne) Liste ou CSV des ID filtrés


Changelog

version Description
4.0 Introduit

prepare_layers ()

Renvoie les règles de nettoyage de la table des couches pour les instructions de préparation


Paramètres

Cette méthode n'a pas de paramètres


Renvoyer des valeurs

(tableau) Liste des règles de désinfection (colonne => règle)


Changelog

version Description
4.0 Introduit

prepare_maps ()

Renvoie les règles de nettoyage de la table des cartes pour les instructions de préparation


Paramètres

Cette méthode n'a pas de paramètres


Renvoyer des valeurs

(tableau) Liste des règles de désinfection (colonne => règle)


Changelog

version Description
4.0 Introduit

prepare_markers ()

Renvoie les règles de nettoyage de la table des marqueurs pour les instructions de préparation


Paramètres

Cette méthode n'a pas de paramètres


Renvoyer des valeurs

(tableau) Liste des règles de désinfection (colonne => règle)


Changelog

version Description
4.0 Introduit

prepare_rels ()

Renvoie les règles de nettoyage de la table des relations pour les instructions de préparation


Paramètres

Cette méthode n'a pas de paramètres


Renvoyer des valeurs

(tableau) Liste des règles de désinfection (colonne => règle)


Changelog

version Description
4.0 Introduit
3
2
12049
Évaluez cette référence

Vous n'êtes pas autorisé à évaluer ce message.

en English
X