データベース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($ filters = アレイ())

マップの総数を返します
オプションでフィルターのリストを受け入れます


パラメーター

$ filters
(配列)(オプション)フィルターのリスト

戻り値

(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, $ filters = アレイ())

すべてのマップを返します
オプションでフィルターのリストを受け入れます


パラメーター

$ count
(ブール値)(オプション)割り当てられたマーカーをカウントするかどうか
$ filters
(配列)(オプション)フィルターのリスト

戻り値

(配列)マップオブジェクトのリスト


変更履歴

バージョン 説明
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
(整数)更新するマップの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($ filters = アレイ())

マーカーの総数を返します
オプションでフィルターのリストを受け入れます


パラメーター

$ filters
(配列)(オプション)フィルターのリスト

戻り値

(int)マーカーの総数


変更履歴

バージョン 説明
4.0 導入

count_map_markers($ id)

指定されたマップIDのマーカーの総数を返します


パラメーター

$ id
(int)マップID

戻り値

(整数)指定されたマップ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($ filters = アレイ())

すべてのマーカーを返します
オプションでフィルターのリストを受け入れます


パラメーター

$ filters
(配列)(オプション)フィルターのリスト

戻り値

(配列)マーカーオブジェクトのリスト


変更履歴

バージョン 説明
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
(整数)更新するマーカーの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 導入

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
(整数)(オプション)新しいレイヤーのID

戻り値

(int | bool)レイヤーID、またはレイヤーを追加できなかった場合はfalse


変更履歴

バージョン 説明
4.0 導入

update_layer($データ, $ id)

レイヤーを更新します


パラメーター

$データ
(オブジェクト)書き込むレイヤーデータ
$ id
(整数)更新するレイヤーの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
(ブール値)(オプション)サニタイズされたIDをCSVとして返すかどうか

戻り値

(配列|文字列)サニタイズされたIDのリストまたはCSV


変更履歴

バージョン 説明
4.0 導入

prepare_layers()

準備ステートメントのレイヤーテーブルのサニタイズルールを返します


パラメーター

このメソッドにはパラメーターがありません


戻り値

(配列)サニタイズルールのリスト(列=>ルール)


変更履歴

バージョン 説明
4.0 導入

prepare_maps()

prepareステートメントのマップテーブルのサニタイズルールを返します


パラメーター

このメソッドにはパラメーターがありません


戻り値

(配列)サニタイズルールのリスト(列=>ルール)


変更履歴

バージョン 説明
4.0 導入

prepare_markers()

prepareステートメントのマーカーテーブルのサニタイズルールを返します


パラメーター

このメソッドにはパラメーターがありません


戻り値

(配列)サニタイズルールのリスト(列=>ルール)


変更履歴

バージョン 説明
4.0 導入

prepare_rels()

準備ステートメントの関係テーブルのサニタイズルールを返します


パラメーター

このメソッドにはパラメーターがありません


戻り値

(配列)サニタイズルールのリスト(列=>ルール)


変更履歴

バージョン 説明
4.0 導入
3
2
12004
この参照を評価する
en English
X