目次
- サンプル・プログラムの実行例
- サンプル・プログラム
- サンプル・プログラムの流れ
- 準備：pahooGeoCode クラス
- 準備：住所検索サービスの選択
- 「Google Geocoding API」による緯度・経度変換
- 解説：GoogleMaps API Geocoding
- 「YOLP コンテンツジオコーダ API」による緯度・経度変換
- 解説：YOLP コンテンツジオコーダ API
- 「HeartRails Geo API」による緯度・経度変換
- 解説：HeartRails Geo API
- 「OSM Nominatim Search API」による緯度・経度変換
- 解説：OSM Nominatim Search API
- 解説：検索と結果取得
- 参考サイト
サンプル・プログラムの実行例
サンプル・プログラム
| address2geo.php | サンプル・プログラム本体。 |
| pahooGeoCode.php | 住所・緯度・経度に関わるクラス pahooGeoCode。 使い方は「PHPで住所・ランドマークから最寄り駅を求める」「PHPで住所・ランドマークから緯度・経度を求める」などを参照。include_path が通ったディレクトリに配置すること。 |
サンプル・プログラムの流れ
準備：pahooGeoCode クラス
0037: class pahooGeoCode {
0038: var $items; //検索結果格納用
0039: var $error; //エラーフラグ
0040: var $hits; //検索ヒット件数
0041: var $webapi; //直前に呼び出したWebAPI URL
0042:
0043: //Google Cloud Platform APIキー
0044: //https://cloud.google.com/maps-platform/
0045: //※Google Maps APIを利用しないのなら登録不要
0046: var $GOOGLE_API_KEY_1 = '**************************'; //HTTPリファラ用
0047: var $GOOGLE_API_KEY_2 = '**************************'; //IP制限用
0048:
0049: //Yahoo! JAPAN Webサービス アプリケーションID
0050: //https://e.developer.yahoo.co.jp/register
0051: //※Yahoo! JAPAN Webサービスを利用しないのなら登録不要
0052: var $YAHOO_APPLICATION_ID = '*****************************';
クラスについては「PHP でクラスを使ってテキストの読みやすさを調べる」を参照されたい。
地図や住所検索として Google を利用するのであれば、Google Cloud Platform API キー が必要で、その入手方法は「Google Cloud Platform - WebAPI の登録方法」を、Yahoo!JAPAN を利用するのであれば、Yahoo! JAPAN Web サービス アプリケーション IDが必要で、その入手方法は「Yahoo!JAPAN デベロッパーネットワーク - WebAPI の登録方法」を、それぞれ参照されたい。
準備：住所検索サービスの選択
0037: //住所検索サービスの選択
0038: // 0：Google
0039: // 11：HeartRails Geo API
0040: // 12：OSM Nominatim Search API
0041: define('GEOSERVICE', 12);
| 値 | サービス名 | 制 約 |
|---|---|---|
| 0 | 有料（決められた無料枠あり）。全世界の住所、ランドマークの検索可能。 | |
| 1 | Yahoo!JAPAN | 無料（？）。住所、ランドマーク、海外のどれを検索するか指定。ランドマークや海外地名検索はGoogleに劣る。 |
| 11 | HeartRails Geo API | 無料。住所、または住所の一部のみ検索可能。 |
| 12 | OSM Nominatim Search API | 無料。全世界の住所、ランドマークの検索可能。精度はGoogleに劣る。 |
「Google Geocoding API」による緯度・経度変換
得られる緯度・経度は世界測地系（wgs84）であることに留意されたい。
| ＵＲＬ |
|---|
| https://maps.googleapis.com/maps/api/geocode/xml |
| フィールド名 | 要否 | 内 容 |
|---|---|---|
| key | 必須 | APIキー |
| address | 必須 | 住所やランドマーク（UTF-8） |
| language | 任意 | 使用言語。ja など |
| sensor | 任意 | true または false |
解説：GoogleMaps API Geocoding
0179: /**
0180: * GoogleMaps API Geocoding(V3) のURLを取得する
0181: * @param string $query 検索キーワード（UTF-8）
0182: * @return string URL URL
0183: */
0184: function getURL_GeoCodeAPI_V3($query) {
0185: $key = $this->GOOGLE_API_KEY_2;
0186: return "https://maps.googleapis.com/maps/api/geocode/xml?key={$key}&language=ja®ion=JP&address=" . urlencode($query);
0187: }
0189: /**
0190: * Google Geocoding API(V3) を用いて住所・駅名の緯度・経度を求める
0191: * @param string $query 検索キーワード
0192: * @param array $items 情報を格納する配列
0193: * @return int ヒットした施設数／(-1)：API呼び出し失敗
0194: */
0195: function getPointsV3_all($query, &$items) {
0196: $url = $this->getURL_GeoCodeAPI_V3($query); //リクエストURL
0197: $this->webapi = $url;
0198: $n = 1;
0199:
0200: //PEAR::XML_Unserializer
0201: if (class_exists('XML_Unserializer')) {
0202: $xml = new XML_Unserializer();
0203: $xml_data = file_get_contents($url);
0204: $xml->unserialize($xml_data);
0205: $arr = $xml->getUnserializedData();
0206: //レスポンス・チェック
0207: if (preg_match('/ok/i', $arr['status']) == 0) return (-1);
0208: //位置情報
0209: if (isset($arr['result']['geometry'])) {
0210: $items[$n]['latitude'] = $arr['result']['geometry']['location']['lat'];
0211: $items[$n]['longitude'] = $arr['result']['geometry']['location']['lng'];
0212: $items[$n]['address'] = $this->trimAddress($arr['result']['formatted_address']);
0213: $n++;
0214: } else {
0215: foreach ($arr['result'] as $val) {
0216: $items[$n]['latitude'] = $val['geometry']['location']['lat'];
0217: $items[$n]['longitude'] = $val['geometry']['location']['lng'];
0218: $items[$n]['address'] = $this->trimAddress($val['formatted_address']);
0219: $n++;
0220: }
0221: }
0222: $xml = NULL;
0223:
0224: //PHP4用; DOM XML利用
0225: } else if ($this->isphp5over() == FALSE) {
0226: if (($dom = $this->read_xml($url)) == NULL) return FALSE;
0227: $gr = $dom->get_elements_by_tagname('GeocodeResponse');
0228: //レスポンス・チェック
0229: $res = $gr[0]->get_elements_by_tagname('status');
0230: if (preg_match("/ok/i", $res[0]->get_content()) == 0) return 0;
0231: //位置情報
0232: $res = $gr[0]->get_elements_by_tagname('result');
0233: foreach ($res as $val) {
0234: $geo = $val->get_elements_by_tagname('geometry');
0235: $loc = $geo[0]->get_elements_by_tagname('location');
0236: $lat = $loc[0]->get_elements_by_tagname('lat');
0237: $items[$n]['latitude'] = (double)$lat[0]->get_content();
0238: $lng = $loc[0]->get_elements_by_tagname('lng');
0239: $items[$n]['longitude'] = (double)$lng[0]->get_content();
0240: $addr = $val->get_elements_by_tagname('formatted_address');
0241: $items[$n]['address'] = $this->trimAddress((string)$addr[0]->get_content());
0242: $n++;
0243: }
0244: //PHP5用; SimpleXML利用
0245: } else {
0246: $this->unknown_certificate();
0247: $res = simplexml_load_file($url);
0248: //レスポンス・チェック
0249: if (preg_match("/ok/i", $res->status) == 0) return 0;
0250: foreach ($res->result as $element) {
0251: $items[$n]['latitude'] = (double)$element->geometry->location->lat;
0252: $items[$n]['longitude'] = (double)$element->geometry->location->lng;
0253: $items[$n]['address'] = $this->trimAddress((string)$element->formatted_address);
0254: $n++;
0255: }
0256: }
0257: return ($n - 1);
0258: }
検索結果が複数ある場合に備え、緯度・経度・人間が読める住所のセットを、連想配列のプロパティ $items に格納しておく。
「YOLPコンテンツジオコーダAPI」による緯度・経度変換
得られる緯度・経度は世界測地系（wgs84）であることに留意されたい。
| ＵＲＬ |
|---|
| https://map.yahooapis.jp/geocode/cont/V1/contentsGeoCoder |
| フィールド名 | 要否 | 内 容 |
|---|---|---|
| appid | 必須 | アプリケーションID |
| query | 必須 | 住所やランドマーク |
| ei | 任意 | 文字エンコード：UTF-8（デフォルト）/EUC-JP/SJISなど |
| category | 任意 | 検索対象カテゴリ：address（デフォルト）/landmark/world |
| results | 任意 | 表示件数：最大10（デフォルト） |
| output | 任意 | 出力形式：xml（デフォルト）/json |
| callback | 任意 | JSONPとして出力する際のコールバック関数名を入力するためのパラメータ。UTF-8でエンコードした文字列を入力する。 |
解説：YOLPコンテンツジオコーダAPI
1240: /**
1241: * YOLPコンテンツジオコーダAPI のリクエストURLを取得する
1242: * @param string $query 検索キーワード（UTF-8）
1243: * @param string $category 検索対象カテゴリ
1244: * address = 住所（省略時）
1245: * landmark = ランドマーク
1246: * world = 世界
1247: * @return string URL リクエストURL
1248: */
1249: function getURL_YOLP_GeoCoder($query, $category='address') {
1250: $appid = $this->YAHOO_APPLICATION_ID;
1251: return "https://map.yahooapis.jp/geocode/cont/V1/contentsGeoCoder?appid={$appid}&el=UTF-8&output=xml&category={$category}&query=" . urlencode($query);
1252: }
1254: /**
1255: * YOLPコンテンツジオコーダAPI を用いて住所・駅名の緯度・経度を求める
1256: * @param string $query 検索キーワード
1257: * @param array $items 情報を格納する配列
1258: * @param string $category 検索対象カテゴリ
1259: * address = 住所（省略時）
1260: * landmark = ランドマーク
1261: * world = 世界
1262: * @return int ヒットした施設数／(-1)：API呼び出し失敗
1263: */
1264: function getPointsYOLP_all($query, &$items, $category='address') {
1265: $url = $this->getURL_YOLP_GeoCoder($query, $category); //リクエストURL
1266: $this->webapi = $url;
1267: $n = 1;
1268:
1269: $this->unknown_certificate();
1270: $res = simplexml_load_file($url);
1271: //レスポンス・チェック
1272: if (!isset($res->ResultInfo)) return (-1);
1273: if (isset($res->ResultInfo->Total) && ((int)$res->ResultInfo->Total <= 0)) return 0; //v.5.73追加
1274:
1275: foreach ($res->Feature as $element) {
1276: if (preg_match('/([\-0-9\.]+)\,([\-0-9\.]+)/i', $element->Geometry->Coordinates, $arr) > 0) {
1277: if (isset($arr[1]) && isset($arr[2])) {
1278: $items[$n]['latitude'] = (double)$arr[2];
1279: $items[$n]['longitude'] = (double)$arr[1];
1280: $items[$n]['address'] = (string)$element->Property->Address;
1281: $n++;
1282: }
1283: }
1284: }
1285:
1286: return ($n - 1);
1287: }
検索結果が複数ある場合に備え、緯度・経度・住所のセットを、連想配列のプロパティ $items に格納しておく。
1289: /**
1290: * YOLPコンテンツジオコーダAPI のカテゴリ選択ラジオボタンの生成
1291: * @param string $name HTML name
1292: * @param string $default デフォルト値（省略可能）
1293: * @return string HTML
1294: */
1295: function makeYOLP_GeoSelectCategory($name, $default='') {
1296: //デフォルト値設定
1297: if (isset($this->YOLP_GeoCategory[$default])) {
1298: foreach ($this->YOLP_GeoCategory as $key=>$item) {
1299: $item[$key]['checked'] = '';
1300: }
1301: $this->YOLP_GeoCategory[$default]['checked'] = 'checked';
1302: }
1303: //選択ラジオボタンの生成
1304: $html = '';
1305: $i = 1;
1306: foreach ($this->YOLP_GeoCategory as $key=>$val) {
1307: $html .= "<input type=\"radio\" name=\"{$name}\" value=\"{$key}\" {$val['checked']} />{$val['title']} ";
1308: $i++;
1309: }
1310: return $html;
1311: }
1321: /**
1322: * checkedされているカテゴリを検索する
1323: * @return string 選択された関数名／FALSE=checkedされている処理がない
1324: */
1325: function getYOLP_GeoSelectCategory() {
1326: foreach ($this->YOLP_GeoCategory as $key=>$val) {
1327: if ($val['checked'] == 'checked') return $key;
1328: }
1329:
1330: return FALSE;
1331: }
1333: /**
1334: * カテゴリをchekedする
1335: * @param string $val カテゴリ値
1336: * @return bool TRUE/FALSE
1337: */
1338: function setYOLP_GeoSelectCategory($val) {
1339: $old = $this->getYOLP_GeoSelectCategory();
1340: if ($val != FALSE) $this->YOLP_GeoCategory[$old]['checked'] = '';
1341: $this->YOLP_GeoCategory[$val]['checked'] = 'checked';
1342:
1343: return TRUE;
1344: }
「HeartRails Geo API」による緯度・経度変換
得られる緯度・経度は世界測地系（wgs84）であることに留意されたい。
| ＵＲＬ |
|---|
| https://geoapi.heartrails.com/api/xml?method=suggest |
| フィールド名 | 要否 | 内 容 |
|---|---|---|
| method | 必須 | メソッド名：suggest（固定） |
| keyword | 必須 | 検索キーワード（UTF-8でURLエンコード） |
| matching | 必須 | prefix（前方一致）、like（部分一致）、suffix（後方一致）のいずれか |
解説：HeartRails Geo API
1480: /**
1481: * HeartRails Geo API - 住所検索APIを用いて住所の緯度・経度を求める
1482: * @param string $query 検索キーワード：住所のみ（UTF-8）
1483: * @param array $items 情報を格納する配列
1484: * @param string $matching 検索方式
1485: * prefix = 前方一致
1486: * like = 部分一致（省略時）
1487: * suffix = 後方一致
1488: * @return int ヒットした地点数／(-1)：API呼び出し失敗
1489: */
1490: function getPointsHeartRailsGeo_all($query, &$items, $matching='like') {
1491: //リクエストURL
1492: $url = "https://geoapi.heartrails.com/api/xml?method=suggest&matching={$matching}&keyword=" . urlencode($query);
1493: $this->webapi = $url;
1494: $n = 1;
1495:
1496: $this->unknown_certificate();
1497: $res = simplexml_load_file($url);
1498: //レスポンス・チェック
1499: if (isset($res->error)) {
1500: $this->error = TRUE;
1501: $this->errmsg = (string)$res->error;
1502: $n = 0;
1503: } else if (! isset($res->location)) {
1504: $this->error = TRUE;
1505: $this->errmsg = 'Not found';
1506: $n = 1;
1507: } else {
1508: foreach ($res->location as $element) {
1509: $items[$n]['latitude'] = (double)$element->y;
1510: $items[$n]['longitude'] = (double)$element->x;
1511: $items[$n]['prefecture'] = (string)$element->prefecture;
1512: $items[$n]['city'] = (string)$element->city;
1513: $items[$n]['city_kana'] = (string)$element->{'city-kana'};
1514: $items[$n]['town'] = (string)$element->town;
1515: $items[$n]['town_kana'] = (string)$element->{'town-kana'};
1516: $items[$n]['postal'] = (string)$element->postal;
1517: $items[$n]['address'] = (string)$element->prefecture . (string)$element->city . (string)$element->town;
1518: $n++;
1519: }
1520: }
1521:
1522: return ($n - 1);
1523: }
検索結果が複数ある場合に備え、緯度・経度・住所のセットを、連想配列のプロパティ $items に格納しておく。
「OSM Nominatim Search API」による緯度・経度変換
| ＵＲＬ |
|---|
| https://nominatim.openstreetmap.org/search |
| フィールド名 | 要否 | 内 容 |
|---|---|---|
| format | 任意 | 出力形式。html|xml|json|jsonv2。省略時はhtml |
| q | 必須 | 住所やランドマーク（UTF-8） |
| json_callback | 任意 | json の出力をラップするコールバック関数（JSONP） |
| addressdetails | 任意 | 住所の要素への細分化を含むかどうか。0|1。省略時は0 |
解説：OSM Nominatim Search API
1716: /**
1717: * OSM Nominatim Search API - 住所検索APIを用いて住所の緯度・経度を求める
1718: * @param string $query 検索キーワード：住所のみ（UTF-8）
1719: * @param array $items 情報を格納する配列
1720: * @return int ヒットした地点数／(-1)：API呼び出し失敗
1721: */
1722: function getPointsNominatim_all($query, &$items) {
1723: //リクエストURL
1724: $url = 'https://nominatim.openstreetmap.org/search?format=json&q=' . urlencode($query);
1725: $this->webapi = $url;
1726: $n = 1;
1727:
1728: //User-Agent偽装
1729: $header = array(
1730: 'Content-Type: application/x-www-form-urlencoded',
1731: 'User-Agent: Mozilla/5.0 (Windows NT 5.1; rv:13.0) Gecko/20100101 Firefox/13.0.1'
1732: );
1733: $stream = stream_context_create(array(
1734: 'http' => array(
1735: 'method' => 'GET',
1736: 'header' => implode("\r\n", $header),
1737: 'ignore_errors'=>TRUE
1738: )
1739: ));
1740: $json = file_get_contents($url, FALSE, $stream);
1741:
1742: //レスポンス・チェック
1743: if ($json == FALSE) {
1744: $this->error = TRUE;
1745: $this->errmsg = '';
1746: $n = 0;
1747: } else {
1748: if ($this->isphp7over()) {
1749: $res = @json_decode($json, FALSE, 512, JSON_BIGINT_AS_STRING);
1750: } else {
1751: $res = @json_decode($json, FALSE, 512);
1752: }
1753: foreach ($res as $element) {
1754: $items[$n]['latitude'] = (double)$element->lat;
1755: $items[$n]['longitude'] = (double)$element->lon;
1756: $items[$n]['address'] = (string)$element->display_name;
1757: $n++;
1758: }
1759: }
1760: if ($n == 1) {
1761: $this->error = TRUE;
1762: $this->errmsg = 'Not found';
1763: }
1764:
1765: return ($n - 1);
1766: }
WebAPI の呼び出し時、User-Agent を設定する目的で、 stream_context_create 関数を利用し、 file_get_contents 関数を呼び出している。
json_decode 関数の呼び出しは、BIGINT の扱いが異なる PHP 7 以上と未満で場合分けしている。
検索結果が複数ある場合に備え、緯度・経度・人間が読める住所のセットを、連想配列のプロパティ $items に格納しておく。
解説：検索と結果取得
2065: /**
2066: * ジオコーダAPI を用いて住所・ランドマークの緯度・経度を検索
2067: *
2068: * @param string $query 検索キーワード（UTF-8）
2069: * @param int $api 0：Google Geocoding API（省略時）
2070: * 1：Yahoo!ジオコーダAPI
2071: * 11：HeartRails Geo API
2072: * 12：OSM Nominatim Search API
2073: * @param string $category 検索対象カテゴリ（YOLPのみ必要）
2074: * address = 住所（省略時）
2075: * landmark = ランドマーク
2076: * world = 世界
2077: * @return array(int ヒットした地点数,string WebAPI)
2078: */
2079: function searchPoint3($query, $api=0, $category='address') {
2080: static $pat1 = '/E(\d+\.?\d*)N(\d+\.?\d*)/i';
2081: static $pat2 = '/E(\d+)\.(\d+)\.(\d+)\.(\d+)N(\d+)\.(\d+)\.(\d+)\.(\d+)/i';
2082:
2083: unset($this->items);
2084: $this->items = array();
2085: $this->hits = 0;
2086:
2087: //緯度・経度表記(1)
2088: if (preg_match($pat1, $query) > 0) {
2089: list($this->items[1]['latitude'], $this->items[1]['longitude']) =
2090: $this->parse_geo($query);
2091: $this->items[1]['address'] = '';
2092: $this->hits = 1;
2093:
2094: //緯度・経度表記(2)
2095: } else if (preg_match($pat2, $query) > 0) {
2096: list($this->items[1]['latitude'], $this->items[1]['longitude']) =
2097: $this->parse_geo($query);
2098: $this->items[1]['address'] = '';
2099: $this->hits = 1;
2100:
2101: //Google Geocoding API使用
2102: } else if ($api == 0) {
2103: $n = $this->getPointsV3_all($query, $this->items);
2104: if ($n == (-1)) { //v.5.73修正
2105: $this->error = TRUE;
2106: $this->errmsg = 'Google Geocoding APIにトラブル発生';
2107: $this->hits = 0;
2108: } else if ($n == 0) {
2109: $this->error = TRUE;
2110: $this->errmsg = '指定キーワードでは検索できない';
2111: $this->hits = 0;
2112: } else {
2113: $this->hits = $n;
2114: }
2115:
2116: //Yahoo!ジオコーダAPI使用
2117: } else if ($api == 1) {
2118: $n = $this->getPointsYOLP_all($query, $this->items, $category);
2119: if ($n == (-1)) { //v.5.73修正
2120: $this->error = TRUE;
2121: $this->errmsg = 'Yahoo!ジオコーダAPIにトラブル発生';
2122: $this->hits = 0;
2123: } else if ($n == 0) {
2124: $this->error = TRUE;
2125: $this->errmsg = '指定キーワードでは検索できない';
2126: $this->hits = 0;
2127: } else {
2128: $this->hits = $n;
2129: }
2130:
2131: //HeartRails Geo API使用
2132: } else if ($api == 11) {
2133: $n = $this->getPointsHeartRailsGeo_all($query, $this->items, 'like');
2134: if ($n == (-1)) { //v.5.73修正
2135: $this->hits = 0;
2136: } else if ($n == 0) {
2137: $this->errmsg = '指定キーワードでは検索できない';
2138: $this->hits = 0;
2139: } else {
2140: $this->hits = $n;
2141: }
2142:
2143: //OSM Nominatim Search API使用
2144: } else if ($api == 12) {
2145: $n = $this->getPointsNominatim_all($query, $this->items);
2146: if ($n == (-1)) {
2147: $this->errmsg = 'OSM Nominatim Search APIにトラブル発生';
2148: $this->hits = 0;
2149: } else if ($n == 0) {
2150: $this->errmsg = '指定キーワードでは検索できない';
2151: $this->hits = 0;
2152: } else {
2153: $this->hits = $n;
2154: }
2155:
2156: //エラー
2157: } else {
2158: $this->error = TRUE;
2159: $this->errmsg = 'ジオコーダーAPIの指定間違い';
2160: $this->hits = 0;
2161: }
2162:
2163: return array($this->hits, $this->webapi);
2164: }
結果はプロパティ $items に格納する。戻り値としてヒットした件数を返す。
0325: /**
0326: * 検索結果（緯度・経度）を取得
0327: * @param int $id 取得したい地点番号
0328: * @return array(緯度,経度,住所)：世界測地系
0329: */
0330: function getPoint($id) {
0331: if ($id <= 0 || $id > $this->hits) {
0332: $this->error = TRUE;
0333: $this->errmsg = '不正な地点番号';
0334: $latitude = FALSE;
0335: $longitude = FALSE;
0336: $address = FALSE;
0337: } else {
0338: $this->error = FALSE;
0339: $this->errmsg = '';
0340: $latitude = $this->items[$id]['latitude'];
0341: $longitude = $this->items[$id]['longitude'];
0342: $address = $this->items[$id]['address'];
0343: }
0344:
0345: return array($latitude, $longitude, $address);
0346: }
引数の地点番号は、1 から順に増える正の整数である。最大値は searchPoint3 の戻り値である。
参考サイト
これらサービスのうち Google は全世界を対象として最も精度の高い検索が可能だが、有料サービスに移行したため（無料枠あり）、その他の無料利用できるサービスを選択できるようにしている。
ぱふぅ家のホームページで紹介するプログラムの住所検索機能は、すべてこのクラス pahooGeoCode を流用している。
（2021 年 9 月 18 日）PHP8 対応，リファラチェック改良，WenAPI の呼び出し https 化