数据库API

Contents [show]

请注意,直接通过API操作Maps Marker Pro数据库时必须谨慎,以免数据丢失。 所有呼叫都是即时的,无法撤消。

另请注意,我们的支持不涵盖有关基于此API的自定义开发的详细问题。

用法

要使用DB API,我们首先必须实例化该类:

$db = new MMP\DB();

映射返回具有以下属性的对象:

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)

标记返回具有以下属性的对象:

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

例子

获取ID为1的地图,更改名称,宽度和高度并保存更改

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

获取ID为1的标记,更改名称,图标和弹出窗口并保存更改

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

方法参考

create_tables()

创建数据库表


参数

该方法没有参数


返回值

没有值返回


更新日志

版本 描述
4.0 介绍

delete_tables()

删除数据库表


参数

该方法没有参数


返回值

没有值返回


更新日志

版本 描述
4.0 介绍

reset_tables()

重置数据库表


参数

该方法没有参数


返回值

没有值返回


更新日志

版本 描述
4.0 介绍

count_maps($过滤器 = 阵列())

返回地图总数
(可选)接受过滤器列表


参数

$过滤器
(数组)(可选)过滤器列表

返回值

(int)地图总数


更新日志

版本 描述
4.0 介绍

get_map($ id, $ count = false)

返回给定ID的地图


参数

$ id
(int)地图ID
$ count
(布尔)(可选)是否对分配的标记计数

返回值

(object | null)地图对象;如果未找到结果,则为null


更新日志

版本 描述
4.0 介绍

get_maps($ ids, $ count = false)

返回给定ID的地图


参数

$ ids
(数组|字符串)地图ID的列表或CSV
$ count
(布尔)(可选)是否对分配的标记计数

返回值

(数组)地图对象列表


更新日志

版本 描述
4.0 介绍

get_all_maps($ count = false, $过滤器 = 阵列())

返回所有地图
(可选)接受过滤器列表


参数

$ count
(布尔)(可选)是否对分配的标记计数
$过滤器
(数组)(可选)过滤器列表

返回值

(数组)地图对象列表


更新日志

版本 描述
4.0 介绍

get_map_shortcodes($ id)

返回所有给定地图ID使用简码的帖子


参数

$ id
(int)地图ID

返回值

(数组)帖子列表


更新日志

版本 描述
4.0 介绍

add_map($数据, $ id = 0)

添加地图


参数

$数据
(对象)要写入的地图数据
$ id
(int)(可选)新地图的ID

返回值

(int | bool)地图ID;如果无法添加地图,则返回false


更新日志

版本 描述
4.0 介绍

add_maps($数据)

添加多个地图


参数

$数据
(数组)要写入的地图数据列表

返回值

(int | bool)受影响的行数;如果无法添加映射,则为false


更新日志

版本 描述
4.0 介绍

update_map($数据, $ id)

更新地图


参数

$数据
(对象)要写入的地图数据
$ id
(int)要更新的地图的ID

返回值

(int | bool)受影响的行数;如果无法更新地图,则返回false


更新日志

版本 描述
4.0 介绍

update_maps($数据, $ ids)

更新多个地图


参数

$数据
(对象)要写入的地图数据
$ ids
(数组|字符串)地图ID的列表或CSV

返回值

(int)受影响的行数


更新日志

版本 描述
4.0 介绍

delete_map($ id)

删除地图及其关系


参数

$ id
(int)要删除的地图的ID

返回值

(int | bool)受影响的行数;如果无法删除映射,则返回false


更新日志

版本 描述
4.0 介绍

delete_maps($ ids)

删除多个地图及其关系


参数

$ ids
(数组|字符串)地图ID的列表或CSV

返回值

(int | bool)受影响的行数;如果无法删除地图,则返回false


更新日志

版本 描述
4.0 介绍

count_markers($过滤器 = 阵列())

返回标记总数
(可选)接受过滤器列表


参数

$过滤器
(数组)(可选)过滤器列表

返回值

(int)标记总数


更新日志

版本 描述
4.0 介绍

count_map_markers($ id)

返回给定地图ID的标记总数


参数

$ id
(int)地图ID

返回值

(int)给定地图ID的标记总数


更新日志

版本 描述
4.0 介绍

get_marker($ id)

返回给定ID的标记


参数

$ id
(int)标记ID

返回值

(object | null)标记对象;如果未找到结果,则为null


更新日志

版本 描述
4.0 介绍

get_markers($ ids)

返回给定ID的标记


参数

$ ids
(数组|字符串)标记ID的列表或CSV

返回值

(数组)标记对象列表


更新日志

版本 描述
4.0 介绍

get_all_markers($过滤器 = 阵列())

返回所有标记
(可选)接受过滤器列表


参数

$过滤器
(数组)(可选)过滤器列表

返回值

(数组)标记对象列表


更新日志

版本 描述
4.0 介绍

get_map_markers($ id)

返回给定地图ID的标记


参数

$ id
(int)地图ID

返回值

(数组)标记对象列表


更新日志

版本 描述
4.0 介绍

get_maps_markers($ ids)

返回给定地图ID的标记


参数

$ ids
(int)地图ID

返回值

(数组)标记对象列表


更新日志

版本 描述
4.0 介绍

add_marker($数据, $ id = 0)

添加标记


参数

$数据
(对象)要写入的标记数据
$ id
(int)(可选)新标记的ID

返回值

(int | bool)标记ID;如果无法添加标记,则返回false


更新日志

版本 描述
4.0 介绍

add_markers($数据)

添加多个标记


参数

$数据
(数组)要写入的标记数据列表

返回值

(int | bool)受影响的行数;如果无法添加标记,则返回false


更新日志

版本 描述
4.0 介绍

update_marker($数据, $ id)

更新标记


参数

$数据
(对象)要写入的标记数据
$ id
(int)要更新的标记的ID

返回值

(int | bool)受影响的行数;如果无法更新标记,则返回false


更新日志

版本 描述
4.0 介绍

update_markers($数据, $ ids)

更新多个标记


参数

$数据
(对象)要写入的标记数据
$ ids
(数组|字符串)标记ID的列表或CSV

返回值

(int | bool)受影响的行数;如果无法更新标记,则返回false


更新日志

版本 描述
4.0 介绍

Assign_marker($ map_id, $ marker_id)

将标记分配给地图


参数

$ map_id
(int)地图ID
$ marker_id
(int)标记ID

返回值

(int | bool)受影响的行数;如果无法分配标记,则返回false


更新日志

版本 描述
4.0 介绍

Assign_markers($ map_id, $ marker_ids)

为地图分配多个标记


参数

$ map_id
(int)地图ID
$ marker_ids
(数组|字符串)标记ID的列表或CSV

返回值

(int | bool)受影响的行数;如果无法分配标记,则返回false


更新日志

版本 描述
4.0 介绍

Assign_maps_marker($ map_ids, $ marker_id)

将标记分配给多个地图


参数

$ map_ids
(数组|字符串)地图ID的列表或CSV
$ marker_id
(int)标记ID

返回值

(int | bool)受影响的行数;如果无法分配标记,则返回false


更新日志

版本 描述
4.0 介绍

Assign_maps_markers($ map_ids, $ marker_ids)

将多个标记分配给多个地图


参数

$ map_ids
(数组|字符串)地图ID的列表或CSV
$ marker_ids
(数组|字符串)标记ID的列表或CSV

返回值

(int | bool)受影响的行数;如果无法分配标记,则返回false


更新日志

版本 描述
4.0 介绍

Assign_assoc($ assoc)

从关联列表中分配标记


参数

$ assoc
(数组)标记ID =>地图ID的关联列表

返回值

(int | bool)受影响的行数;如果无法分配标记,则返回false


更新日志

版本 描述
4.9 介绍

unassign_marker($ map_id, $ marker_id)

从地图取消分配标记


参数

$ map_id
(int)地图ID
$ marker_id
(int)标记ID

返回值

(int | bool)受影响的行数;如果无法取消分配标记,则返回false


更新日志

版本 描述
4.0 介绍

unassign_markers($ map_id, $ marker_ids)

从地图取消分配多个标记


参数

$ map_id
(int)地图ID
$ marker_ids
(数组|字符串)标记ID的列表或CSV

返回值

(int | bool)受影响的行数;如果无法取消分配标记,则返回false


更新日志

版本 描述
4.0 介绍

unassign_maps_marker($ map_ids, $ marker_id)

从多个地图取消分配标记


参数

$ map_ids
(数组|字符串)地图ID的列表或CSV
$ marker_id
(int)标记ID

返回值

(int | bool)受影响的行数;如果无法取消分配标记,则返回false


更新日志

版本 描述
4.0 介绍

unassign_all_markers($ map_id)

从地图上取消分配所有标记


参数

$ map_id
(int)地图ID

返回值

(int | bool)受影响的行数;如果无法取消分配标记,则返回false


更新日志

版本 描述
4.0 介绍

unassign_all_maps($ marker_id)

从所有地图取消分配标记


参数

$ marker_id
(int)标记ID

返回值

(int | bool)受影响的行数;如果无法取消分配标记,则返回false


更新日志

版本 描述
4.14 介绍

delete_marker($ id)

删除标记及其关系


参数

$ id
(int)要删除的标记的ID

返回值

(int | bool)受影响的行数;如果无法删除标记,则返回false


更新日志

版本 描述
4.0 介绍

delete_markers($ ids)

删除多个标记及其关系


参数

$ ids
(数组|字符串)标记ID的列表或CSV

返回值

(int | bool)受影响的行数;如果无法删除标记,则返回false


更新日志

版本 描述
4.0 介绍

get_layer($ id)

返回给定ID的图层


参数

$ id
(int)图层ID

返回值

(object | null)图层对象;如果未找到结果,则为null


更新日志

版本 描述
4.0 介绍

get_all_layers()

返回所有图层


参数

该方法没有参数


返回值

(数组)层对象列表


更新日志

版本 描述
4.0 介绍

get_all_basemaps()

返回所有底图


参数

该方法没有参数


返回值

(数组)层对象列表


更新日志

版本 描述
4.0 介绍

get_all_overlays()

返回所有叠加


参数

该方法没有参数


返回值

(数组)层对象列表


更新日志

版本 描述
4.0 介绍

add_layer($数据, $ id = 0)

添加一层


参数

$数据
(对象)要写入的层数据
$ id
(int)(可选)新层的ID

返回值

(int | bool)图层ID;如果无法添加图层,则返回false


更新日志

版本 描述
4.0 介绍

update_layer($数据, $ id)

更新图层


参数

$数据
(对象)要写入的层数据
$ id
(int)要更新的图层的ID

返回值

(int | bool)受影响的行数;如果无法更新该层,则为false


更新日志

版本 描述
4.0 介绍

delete_layer($ id)

删除图层


参数

$ id
(int)图层ID

返回值

(int | bool)受影响的行数;如果无法删除该层,则返回false


更新日志

版本 描述
4.0 介绍

delete_orphaned_rels()

删除孤立的关系


参数

该方法没有参数


返回值

(int | bool)受影响的行数;如果无法删除孤立行,则返回false


更新日志

版本 描述
4.7 介绍

build_marker($数据, $ geojson = false)

建立有效的标记对象


参数

$数据
(数组)标记数据列表
$ geojson
(布尔)(可选)数据是否为GeoJSON格式

返回值

(数组)标记对象


更新日志

版本 描述
4.9 介绍

sanitize_ids($ ids, $ csv = false)

清理ID的数组或逗号分隔列表


参数

$ ids
(数组|字符串)ID列表或CSV
$ csv
(布尔)(可选)是否以CSV格式返回已清理的ID

返回值

(数组|字符串)已清理ID的列表或CSV


更新日志

版本 描述
4.0 介绍

prepare_layers()

返回prepare语句的layers表清理规则


参数

该方法没有参数


返回值

(数组)消毒规则列表(列=>规则)


更新日志

版本 描述
4.0 介绍

prepare_maps()

返回prepare语句的maps表清理规则


参数

该方法没有参数


返回值

(数组)消毒规则列表(列=>规则)


更新日志

版本 描述
4.0 介绍

prepare_markers()

返回prepare语句的标记表清理规则


参数

该方法没有参数


返回值

(数组)消毒规则列表(列=>规则)


更新日志

版本 描述
4.0 介绍

prepare_rels()

返回关系表清理规则以准备语句


参数

该方法没有参数


返回值

(数组)消毒规则列表(列=>规则)


更新日志

版本 描述
4.0 介绍
3
2
12073
评价此参考

您无权为此帖子评分。

en English
X