API de base de datos

Contenido

Tenga en cuenta que se debe tener precaución al manipular la base de datos de Maps Marker Pro directamente a través de la API para evitar la pérdida de datos. Todas las llamadas son inmediatas y no se pueden deshacer.

Tenga en cuenta también que nuestro soporte no cubre preguntas detalladas sobre el desarrollo personalizado basado en esta API.

Uso

Para usar la API DB, primero tenemos que instanciar la clase:

$db = new MMP\DB();

Los mapas devuelven objetos con las siguientes propiedades:

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)

Los marcadores devuelven objetos con las siguientes propiedades:

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

Ejemplos

Obtenga el mapa con ID 1, cambie el nombre, el ancho y la altura y guarde los cambios

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

Obtenga el marcador con ID 1, cambie el nombre, el icono y la ventana emergente y guarde los cambios

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

Método de referencia

create_tables ()

Crea las tablas de la base de datos.


parámetros

Este método no tiene parámetros


Valores de retorno

No se devuelve ningún valor.


Historial de cambios

Versión Descripción
4.0 Introducido

delete_tables ()

Elimina las tablas de la base de datos.


parámetros

Este método no tiene parámetros


Valores de retorno

No se devuelve ningún valor.


Historial de cambios

Versión Descripción
4.0 Introducido

reset_tables ()

Restablece las tablas de la base de datos.


parámetros

Este método no tiene parámetros


Valores de retorno

No se devuelve ningún valor.


Historial de cambios

Versión Descripción
4.0 Introducido

count_maps ($ filtros = formación())

Devuelve el número total de mapas.
Opcionalmente acepta una lista de filtros


parámetros

$ filtros
(matriz) (opcional) Lista de filtros

Valores de retorno

(int) Número total de mapas


Historial de cambios

Versión Descripción
4.0 Introducido

get_map ($ Id, $ cuenta = false)

Devuelve el mapa para la ID dada


parámetros

$ Id
(int) ID del mapa
$ cuenta
(bool) (opcional) Si se deben contar los marcadores asignados

Valores de retorno

(objeto | nulo) Objeto de mapa o nulo si no se encuentra ningún resultado


Historial de cambios

Versión Descripción
4.0 Introducido

get_maps ($ ids, $ cuenta = false)

Devuelve los mapas para las ID dadas


parámetros

$ ids
(array | string) Lista o CSV de ID de mapas
$ cuenta
(bool) (opcional) Si se deben contar los marcadores asignados

Valores de retorno

(matriz) Lista de objetos del mapa


Historial de cambios

Versión Descripción
4.0 Introducido

get_all_maps ($ cuenta = false, $ filtros = formación())

Devuelve todos los mapas.
Opcionalmente acepta una lista de filtros


parámetros

$ cuenta
(bool) (opcional) Si se deben contar los marcadores asignados
$ filtros
(matriz) (opcional) Lista de filtros

Valores de retorno

(matriz) Lista de objetos del mapa


Historial de cambios

Versión Descripción
4.0 Introducido

get_map_shortcodes ($ Id)

Devuelve todas las publicaciones que usan un código corto para la ID de mapa dada


parámetros

$ Id
(int) ID del mapa

Valores de retorno

(matriz) Lista de publicaciones


Historial de cambios

Versión Descripción
4.0 Introducido

add_map ($ Datos, $ Id = 0)

Agrega un mapa


parámetros

$ Datos
(objeto) Datos del mapa que se escribirán
$ Id
(int) (opcional) ID para el nuevo mapa

Valores de retorno

(int | bool) ID de mapa o falso si no se pudo agregar el mapa


Historial de cambios

Versión Descripción
4.0 Introducido

add_maps ($ Datos)

Agrega múltiples mapas


parámetros

$ Datos
(matriz) Lista de datos del mapa que se escribirán

Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudieron agregar los mapas


Historial de cambios

Versión Descripción
4.0 Introducido

update_map ($ Datos, $ Id)

Actualiza un mapa


parámetros

$ Datos
(objeto) Datos del mapa que se escribirán
$ Id
(int) ID del mapa a actualizar

Valores de retorno

(int | bool) Número de filas afectadas o falso si el mapa no se pudo actualizar


Historial de cambios

Versión Descripción
4.0 Introducido

update_maps ($ Datos, $ ids)

Actualiza múltiples mapas


parámetros

$ Datos
(objeto) Datos del mapa que se escribirán
$ ids
(array | string) Lista o CSV de ID de mapas

Valores de retorno

(int) Número de filas afectadas


Historial de cambios

Versión Descripción
4.0 Introducido

delete_map ($ Id)

Elimina un mapa y sus relaciones.


parámetros

$ Id
(int) ID del mapa que se va a eliminar

Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudo eliminar el mapa


Historial de cambios

Versión Descripción
4.0 Introducido

delete_maps ($ ids)

Elimina múltiples mapas y sus relaciones.


parámetros

$ ids
(array | string) Lista o CSV de ID de mapas

Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudieron eliminar los mapas


Historial de cambios

Versión Descripción
4.0 Introducido

count_markers ($ filtros = formación())

Devuelve el número total de marcadores.
Opcionalmente acepta una lista de filtros


parámetros

$ filtros
(matriz) (opcional) Lista de filtros

Valores de retorno

(int) Número total de marcadores


Historial de cambios

Versión Descripción
4.0 Introducido

count_map_markers ($ Id)

Devuelve el número total de marcadores para la ID de mapa dada


parámetros

$ Id
(int) ID del mapa

Valores de retorno

(int) Número total de marcadores para la ID de mapa dada


Historial de cambios

Versión Descripción
4.0 Introducido

get_marker ($ Id)

Devuelve el marcador para la ID dada


parámetros

$ Id
(int) ID de marcador

Valores de retorno

(objeto | nulo) Objeto marcador o nulo si no se encuentra ningún resultado


Historial de cambios

Versión Descripción
4.0 Introducido

get_markers ($ ids)

Devuelve los marcadores para las ID dadas


parámetros

$ ids
(matriz | cadena) Lista o CSV de ID de marcador

Valores de retorno

(matriz) Lista de objetos marcadores


Historial de cambios

Versión Descripción
4.0 Introducido

get_all_markers ($ filtros = formación())

Devuelve todos los marcadores
Opcionalmente acepta una lista de filtros


parámetros

$ filtros
(matriz) (opcional) Lista de filtros

Valores de retorno

(matriz) Lista de objetos marcadores


Historial de cambios

Versión Descripción
4.0 Introducido

get_map_markers ($ Id)

Devuelve los marcadores para el ID de mapa dado


parámetros

$ Id
(int) ID del mapa

Valores de retorno

(matriz) Lista de objetos marcadores


Historial de cambios

Versión Descripción
4.0 Introducido

get_maps_markers ($ ids)

Devuelve los marcadores para los ID de mapa dados


parámetros

$ ids
(int) ID de mapas

Valores de retorno

(matriz) Lista de objetos marcadores


Historial de cambios

Versión Descripción
4.0 Introducido

add_marker ($ Datos, $ Id = 0)

Agrega un marcador


parámetros

$ Datos
(objeto) Datos del marcador que se escribirán
$ Id
(int) (opcional) ID para el nuevo marcador

Valores de retorno

(int | bool) ID de marcador o falso si no se pudo agregar el marcador


Historial de cambios

Versión Descripción
4.0 Introducido

add_markers ($ Datos)

Agrega múltiples marcadores


parámetros

$ Datos
(matriz) Lista de datos de marcador que se escribirán

Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudieron agregar los marcadores


Historial de cambios

Versión Descripción
4.0 Introducido

update_marker ($ Datos, $ Id)

Actualiza un marcador


parámetros

$ Datos
(objeto) Datos del marcador que se escribirán
$ Id
(int) ID del marcador que se actualizará

Valores de retorno

(int | bool) Número de filas afectadas o falso si el marcador no se pudo actualizar


Historial de cambios

Versión Descripción
4.0 Introducido

update_markers ($ Datos, $ ids)

Actualiza múltiples marcadores


parámetros

$ Datos
(objeto) Datos del marcador que se escribirán
$ ids
(matriz | cadena) Lista o CSV de ID de marcador

Valores de retorno

(int | bool) Número de filas afectadas o falso si los marcadores no se pueden actualizar


Historial de cambios

Versión Descripción
4.0 Introducido

asignar_marker ($ map_id, $ marker_id)

Asigna un marcador a un mapa


parámetros

$ map_id
(int) ID del mapa
$ marker_id
(int) ID de marcador

Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudo asignar el marcador


Historial de cambios

Versión Descripción
4.0 Introducido

asignar_marcadores ($ map_id, $ marker_ids)

Asigna múltiples marcadores a un mapa


parámetros

$ map_id
(int) ID del mapa
$ marker_ids
(matriz | cadena) Lista o CSV de ID de marcador

Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudieron asignar los marcadores


Historial de cambios

Versión Descripción
4.0 Introducido

asignar_mapas_marker ($ map_ids, $ marker_id)

Asigna un marcador a múltiples mapas


parámetros

$ map_ids
(array | string) Lista o CSV de ID de mapas
$ marker_id
(int) ID de marcador

Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudo asignar el marcador


Historial de cambios

Versión Descripción
4.0 Introducido

asignar_mapas_marcadores ($ map_ids, $ marker_ids)

Asigna múltiples marcadores a múltiples mapas


parámetros

$ map_ids
(array | string) Lista o CSV de ID de mapas
$ marker_ids
(matriz | cadena) Lista o CSV de ID de marcador

Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudieron asignar los marcadores


Historial de cambios

Versión Descripción
4.0 Introducido

asignar_asocia ($ assoc)

Asigna marcadores de una lista asociativa


parámetros

$ assoc
(matriz) Lista asociativa de ID de marcador => ID de mapa

Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudieron asignar los marcadores


Historial de cambios

Versión Descripción
4.9 Introducido

unassign_marker ($ map_id, $ marker_id)

Desasigna un marcador de un mapa


parámetros

$ map_id
(int) ID del mapa
$ marker_id
(int) ID de marcador

Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudo asignar el marcador


Historial de cambios

Versión Descripción
4.0 Introducido

unassign_markers ($ map_id, $ marker_ids)

Desasigna múltiples marcadores de un mapa


parámetros

$ map_id
(int) ID del mapa
$ marker_ids
(matriz | cadena) Lista o CSV de ID de marcador

Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudieron asignar los marcadores


Historial de cambios

Versión Descripción
4.0 Introducido

unassign_maps_marker ($ map_ids, $ marker_id)

Anula la asignación de un marcador de varios mapas


parámetros

$ map_ids
(array | string) Lista o CSV de ID de mapas
$ marker_id
(int) ID de marcador

Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudo asignar el marcador


Historial de cambios

Versión Descripción
4.0 Introducido

unassign_all_markers ($ map_id)

Anular la asignación de todos los marcadores de un mapa


parámetros

$ map_id
(int) ID del mapa

Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudieron asignar los marcadores


Historial de cambios

Versión Descripción
4.0 Introducido

delete_marker ($ Id)

Elimina un marcador y sus relaciones.


parámetros

$ Id
(int) ID del marcador que se eliminará

Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudo eliminar el marcador


Historial de cambios

Versión Descripción
4.0 Introducido

delete_markers ($ ids)

Elimina múltiples marcadores y sus relaciones.


parámetros

$ ids
(matriz | cadena) Lista o CSV de ID de marcador

Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudieron eliminar los marcadores


Historial de cambios

Versión Descripción
4.0 Introducido

get_layer ($ Id)

Devuelve la capa para la ID dada


parámetros

$ Id
(int) ID de capa

Valores de retorno

(objeto | nulo) Objeto de capa o nulo si no se encuentra ningún resultado


Historial de cambios

Versión Descripción
4.0 Introducido

get_all_layers ()

Devuelve todas las capas.


parámetros

Este método no tiene parámetros


Valores de retorno

(matriz) Lista de objetos de capa


Historial de cambios

Versión Descripción
4.0 Introducido

get_all_basemaps ()

Devuelve todos los mapas base


parámetros

Este método no tiene parámetros


Valores de retorno

(matriz) Lista de objetos de capa


Historial de cambios

Versión Descripción
4.0 Introducido

get_all_overlays ()

Devuelve todas las superposiciones


parámetros

Este método no tiene parámetros


Valores de retorno

(matriz) Lista de objetos de capa


Historial de cambios

Versión Descripción
4.0 Introducido

add_layer ($ Datos, $ Id = 0)

Agrega una capa


parámetros

$ Datos
(objeto) Datos de capa a escribir
$ Id
(int) (opcional) ID para la nueva capa

Valores de retorno

(int | bool) ID de capa o falso si no se pudo agregar la capa


Historial de cambios

Versión Descripción
4.0 Introducido

update_layer ($ Datos, $ Id)

Actualiza una capa.


parámetros

$ Datos
(objeto) Datos de capa a escribir
$ Id
(int) ID de la capa que se actualizará

Valores de retorno

(int | bool) Número de filas afectadas o falso si la capa no se pudo actualizar


Historial de cambios

Versión Descripción
4.0 Introducido

delete_layer ($ Id)

Elimina una capa


parámetros

$ Id
(int) ID de capa

Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudo eliminar la capa


Historial de cambios

Versión Descripción
4.0 Introducido

delete_orphaned_rels ()

Elimina las relaciones huérfanas.


parámetros

Este método no tiene parámetros


Valores de retorno

(int | bool) Número de filas afectadas o falso si no se pudieron eliminar los huérfanos


Historial de cambios

Versión Descripción
4.7 Introducido

build_marker ($ Datos, $ geojson = false)

Crea un objeto marcador válido


parámetros

$ Datos
(matriz) Lista de datos del marcador
$ geojson
(bool) (opcional) Si los datos están en formato GeoJSON

Valores de retorno

(matriz) Objeto marcador


Historial de cambios

Versión Descripción
4.9 Introducido

sanitize_ids ($ ids, $ csv = false)

Desinfecta una matriz o una lista de ID separadas por comas


parámetros

$ ids
(array | string) Lista o CSV de ID
$ csv
(bool) (opcional) Si se deben devolver las identificaciones desinfectadas como CSV

Valores de retorno

(array | string) Lista o CSV de ID desinfectados


Historial de cambios

Versión Descripción
4.0 Introducido

prepare_layers ()

Devuelve las reglas de desinfección de la tabla de capas para preparar declaraciones


parámetros

Este método no tiene parámetros


Valores de retorno

(matriz) Lista de reglas de desinfección (columna => regla)


Historial de cambios

Versión Descripción
4.0 Introducido

prepare_maps ()

Devuelve las reglas de desinfección de la tabla de mapas para preparar declaraciones


parámetros

Este método no tiene parámetros


Valores de retorno

(matriz) Lista de reglas de desinfección (columna => regla)


Historial de cambios

Versión Descripción
4.0 Introducido

prepare_markers ()

Devuelve las reglas de desinfección de la tabla de marcadores para preparar declaraciones


parámetros

Este método no tiene parámetros


Valores de retorno

(matriz) Lista de reglas de desinfección (columna => regla)


Historial de cambios

Versión Descripción
4.0 Introducido

prepare_rels ()

Devuelve las reglas de desinfección de la tabla de relaciones para preparar declaraciones


parámetros

Este método no tiene parámetros


Valores de retorno

(matriz) Lista de reglas de desinfección (columna => regla)


Historial de cambios

Versión Descripción
4.0 Introducido
3
2
12047
Califica esta referencia

No puedes calificar esta publicación.

en English
X