API базы данных

Contents [show]

Обратите внимание, что следует соблюдать осторожность при работе с базой данных Maps Marker Pro напрямую через API, чтобы избежать потери данных. Все звонки являются немедленными и не могут быть отменены.

Также имейте в виду, что наша поддержка не охватывает подробные вопросы о пользовательских разработках на основе этого API.

Применение

Чтобы использовать 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

Примеры

Получить карту с идентификатором 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);

Получить маркер с идентификатором 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, $ кол = ложный)

Возвращает карту для данного идентификатора


параметры

$ ID
(int) ID карты
$ кол
(bool) (необязательно) Считать ли назначенные маркеры

Возвращаемые значения

(объект | нуль) Объект карты или ноль, если результат не найден


Список изменений:

Версия Описание
4.0 Введенный

get_maps ($ иды, $ кол = ложный)

Возвращает карты для заданных идентификаторов


параметры

$ иды
(массив | строка) Список или CSV идентификаторов карты
$ кол
(bool) (необязательно) Считать ли назначенные маркеры

Возвращаемые значения

(массив) Список объектов карты


Список изменений:

Версия Описание
4.0 Введенный

get_all_maps ($ кол = ложный, $ фильтры = Массив ())

Возвращает все карты
Опционально принимает список фильтров


параметры

$ кол
(bool) (необязательно) Считать ли назначенные маркеры
$ фильтры
(массив) (необязательно) Список фильтров

Возвращаемые значения

(массив) Список объектов карты


Список изменений:

Версия Описание
4.0 Введенный

get_map_shortcodes ($ 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 ($ Данных, $ иды)

Обновляет несколько карт


параметры

$ Данных
(объект) Данные карты для записи
$ иды
(массив | строка) Список или CSV идентификаторов карты

Возвращаемые значения

(int) Количество затронутых строк


Список изменений:

Версия Описание
4.0 Введенный

delete_map ($ ID)

Удаляет карту и ее отношения


параметры

$ ID
(int) ID карты, которая будет удалена

Возвращаемые значения

(int | bool) Количество затронутых строк или false, если карта не может быть удалена


Список изменений:

Версия Описание
4.0 Введенный

delete_maps ($ иды)

Удаляет несколько карт и их отношения


параметры

$ иды
(массив | строка) Список или CSV идентификаторов карты

Возвращаемые значения

(int | bool) Количество затронутых строк или false, если карты не могут быть удалены


Список изменений:

Версия Описание
4.0 Введенный

count_markers ($ фильтры = Массив ())

Возвращает общее количество маркеров
Опционально принимает список фильтров


параметры

$ фильтры
(массив) (необязательно) Список фильтров

Возвращаемые значения

(int) Общее количество маркеров


Список изменений:

Версия Описание
4.0 Введенный

count_map_markers ($ ID)

Возвращает общее количество маркеров для данного идентификатора карты.


параметры

$ ID
(int) ID карты

Возвращаемые значения

(int) Общее количество маркеров для данного идентификатора карты


Список изменений:

Версия Описание
4.0 Введенный

get_marker ($ ID)

Возвращает маркер для данного идентификатора


параметры

$ ID
(int) ID маркера

Возвращаемые значения

(object | null) Маркерный объект или null, если результат не найден


Список изменений:

Версия Описание
4.0 Введенный

get_markers ($ иды)

Возвращает маркеры для заданных идентификаторов


параметры

$ иды
(массив | строка) Список или CSV идентификаторов маркеров

Возвращаемые значения

(массив) Список объектов маркеров


Список изменений:

Версия Описание
4.0 Введенный

get_all_markers ($ фильтры = Массив ())

Возвращает все маркеры
Опционально принимает список фильтров


параметры

$ фильтры
(массив) (необязательно) Список фильтров

Возвращаемые значения

(массив) Список объектов маркеров


Список изменений:

Версия Описание
4.0 Введенный

get_map_markers ($ ID)

Возвращает маркеры для данного идентификатора карты


параметры

$ ID
(int) ID карты

Возвращаемые значения

(массив) Список объектов маркеров


Список изменений:

Версия Описание
4.0 Введенный

get_maps_markers ($ иды)

Возвращает маркеры для указанных идентификаторов карты


параметры

$ иды
(int) Идентификаторы карты

Возвращаемые значения

(массив) Список объектов маркеров


Список изменений:

Версия Описание
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 ($ Данных, $ иды)

Обновляет несколько маркеров


параметры

$ Данных
(объект) Данные маркера для записи
$ иды
(массив | строка) Список или 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
(массив | строка) Список или CSV идентификаторов маркеров

Возвращаемые значения

(int | bool) Количество затронутых строк или false, если маркеры не могут быть назначены


Список изменений:

Версия Описание
4.0 Введенный

assign_maps_marker ($ map_ids, $ marker_id)

Назначает маркер нескольким картам


параметры

$ map_ids
(массив | строка) Список или CSV идентификаторов карты
$ marker_id
(int) ID маркера

Возвращаемые значения

(int | bool) Количество затронутых строк или false, если маркер не может быть назначен


Список изменений:

Версия Описание
4.0 Введенный

assign_maps_markers ($ map_ids, $ marker_ids)

Назначает несколько маркеров на несколько карт


параметры

$ map_ids
(массив | строка) Список или CSV идентификаторов карты
$ marker_ids
(массив | строка) Список или CSV идентификаторов маркеров

Возвращаемые значения

(int | bool) Количество затронутых строк или false, если маркеры не могут быть назначены


Список изменений:

Версия Описание
4.0 Введенный

assign_assoc ($ ассоциативный)

Назначает маркеры из ассоциативного списка


параметры

$ ассоциативный
(массив) Ассоциативный список идентификатора маркера => идентификаторы карты

Возвращаемые значения

(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
(массив | строка) Список или CSV идентификаторов маркеров

Возвращаемые значения

(int | bool) Количество затронутых строк или false, если маркеры не могут быть назначены


Список изменений:

Версия Описание
4.0 Введенный

unassign_maps_marker ($ map_ids, $ marker_id)

Отменяет маркер с нескольких карт


параметры

$ map_ids
(массив | строка) Список или CSV идентификаторов карты
$ marker_id
(int) ID маркера

Возвращаемые значения

(int | bool) Количество затронутых строк или false, если маркер не может быть назначен


Список изменений:

Версия Описание
4.0 Введенный

unassign_all_markers ($ map_id)

Отменяет все маркеры с карты


параметры

$ map_id
(int) ID карты

Возвращаемые значения

(int | bool) Количество затронутых строк или false, если маркеры не могут быть назначены


Список изменений:

Версия Описание
4.0 Введенный

delete_marker ($ ID)

Удаляет маркер и его отношения


параметры

$ ID
(int) ID удаляемого маркера

Возвращаемые значения

(int | bool) Количество затронутых строк или false, если маркер не может быть удален


Список изменений:

Версия Описание
4.0 Введенный

delete_markers ($ иды)

Удаляет несколько маркеров и их отношения


параметры

$ иды
(массив | строка) Список или CSV идентификаторов маркеров

Возвращаемые значения

(int | bool) Количество затронутых строк или false, если маркеры не могут быть удалены


Список изменений:

Версия Описание
4.0 Введенный

get_layer ($ 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 = ложный)

Создает действительный маркерный объект


параметры

$ Данных
(массив) Список данных маркера
$ GeoJSON
(bool) (необязательно). Являются ли данные в формате GeoJSON

Возвращаемые значения

(массив) Маркерный объект


Список изменений:

Версия Описание
4.9 Введенный

sanitize_ids ($ иды, $ CSV = ложный)

Дезинфицирует массив или разделенный запятыми список идентификаторов


параметры

$ иды
(массив | строка) Список или CSV идентификаторов
$ CSV
(bool) (необязательно) Возвращать ли очищенные идентификаторы как CSV

Возвращаемые значения

(массив | строка) Список или CSV очищенных идентификаторов


Список изменений:

Версия Описание
4.0 Введенный

prepare_layers ()

Возвращает правила очистки таблицы слоев для операторов подготовки


параметры

Этот метод не имеет параметров


Возвращаемые значения

(массив) Список правил очистки (column => rule)


Список изменений:

Версия Описание
4.0 Введенный

prepare_maps ()

Возвращает правила санации таблицы карт для подготовительных операторов


параметры

Этот метод не имеет параметров


Возвращаемые значения

(массив) Список правил очистки (column => rule)


Список изменений:

Версия Описание
4.0 Введенный

prepare_markers ()

Возвращает правила очистки таблицы маркеров для подготовительных операторов


параметры

Этот метод не имеет параметров


Возвращаемые значения

(массив) Список правил очистки (column => rule)


Список изменений:

Версия Описание
4.0 Введенный

prepare_rels ()

Возвращает правила очистки таблицы отношений для операторов подготовки


параметры

Этот метод не имеет параметров


Возвращаемые значения

(массив) Список правил очистки (column => rule)


Список изменений:

Версия Описание
4.0 Введенный
3
2
12004
Оцените эту ссылку
en English
X