PHPで空き室のあるホテルを検索する

(1/1)
PHPで最寄りのネットができるホテルを検索する」ではネットができるホテルを検索したが、今回は、「楽天トラベル空室検索API」を利用し、入力された住所または地図の中心の近く(半径2km以内)にあり、指定チェックイン日・チェックアウト日に空いているホテルを地図上にマッピングするプログラムを作ってみる。

(2021年10月17日)PHP8対応,リファラ・チェック改良

目次

サンプル・プログラムの実行例

PHPで空き室のあるホテルを検索する
Googleマップ表示

サンプル・プログラム

圧縮ファイルの内容
searchOutlet.phpサンプル・プログラム本体
pahooGeoCode.php住所・緯度・経度に関わるクラス pahooGeoCode。
使い方は「PHPで住所・ランドマークから最寄り駅を求める」「PHPで住所・ランドマークから緯度・経度を求める」などを参照。include_path が通ったディレクトリに配置すること。
pahooRakuten.php楽天ウェブサービスに関わるクラス pahooRakuten。
使い方は「PHPで最寄りのネットができるホテルを検索する」などを参照。include_path が通ったディレクトリに配置すること。

サンプル・プログラムの流れ

PHPで空き室のあるホテルを検索する
プログラムの流れは「PHPで最寄りのネットができるホテルを検索する」の時とほぼ同じである。

準備: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 = '*****************************';

地図描画や住所検索を行うために、クラスファイル "pahooGeoCode.php" を使用する。組み込み関数  require_once  を使って読めるディレクトリに配置する。ディレクトリは、設定ファイル php.ini に記述されているオプション設定 include_path に設定しておく。
クラスについては「PHPでクラスを使ってテキストの読みやすさを調べる」を参照されたい。

地図や住所検索として Google を利用するのであれば、Google Cloud Platform APIキー が必要で、その入手方法は「Google Cloud Platform - WebAPIの登録方法」を、Yahoo!JAPAN を利用するのであれば、Yahoo! JAPAN Webサービス アプリケーションIDが必要で、その入手方法は「Yahoo!JAPAN デベロッパーネットワーク - WebAPIの登録方法」を、それぞれ参照されたい。

準備:地図サービス(WebAPI)の選択

0038: //地図描画サービスの選択
0039: //    0:Google
0040: //    2:地理院地図・OSM
0041: define('MAPSERVICE', 0);
0042: 
0043: //住所検索サービスの選択
0044: //    0:Google
0045: //    1:Yahoo!JAPAN
0046: //   11:HeartRails Geo API
0047: //   12:OSM Nominatim Search API
0048: define('GEOSERVICE', 0);
0049: 
0050: //逆ジオコーディングサービスの選択
0051: //    0:Google
0052: //    1:Yahoo!JAPAN
0053: //   11:HeartRails Geo API
0054: //   21:簡易ジオコーディングサービス
0055: define('REVGEOSERVICE', 21);

表示する地図は、Googleマップ、[Yahoo!マップ]blue]、地理院地図・オープンストリートマップ(OSM)から選べる。あらかじめ、定数 MAPSERVIC に値を設定すること。
住所検索サービスは、GoogleYahoo!JAPANHeartRails Geo APIOSM Nominatim Search API から選べる。あらかじめ、定数 GEOSERVICE に値を設定すること。
逆ジオコーディングサービスは、GoogleYahoo!JAPANHeartRails Geo API簡易ジオコーディングサービスから選べる。あらかじめ、定数 REVGEOSERVICE に値を設定すること。
PHPで空き室のあるホテルを検索する
Yahoo!マップ表示
PHPで空き室のあるホテルを検索する
地理院地図(淡色)
PHPで空き室のあるホテルを検索する
OpenStreetMap

準備:pahooRakuten クラス

0016: // 楽天ウェブサービス・クラス ===============================================
0017: class pahooRakuten {
0018:     var $error;          //エラーフラグ
0019:     var $hits;           //検索ヒット件数
0020:     var $webapi;     //直前に呼び出したWebAPI URL
0021: 
0022:     //楽天ウェブサービス
0023:     //https://www.pahoo.org/e-soul/webtech/php06/php06-01-02.shtm#Rakuten 参照
0024:     var $APPLICATIONID      = '*******************';    //アプリID
0025:     var $APPLICATION_SECRET = '****************';       //シークレット
0026:     var $AFFILIATEID        = '*******************';    //アフィリエイトID

楽天トラベルのホテル検索、楽天市場の商品検索など、楽天ウェブサービスを利用するために、クラスファイル "pahooRakuten.php" を使用する。組み込み関数  require_once  を使って読めるディレクトリに配置する。ディレクトリは、設定ファイル php.ini に記述されているオプション設定 include_path に設定しておく。
クラスについては「PHPでクラスを使ってテキストの読みやすさを調べる」を参照されたい。

楽天ウェブサービスには、アプリIDアフィリエイトID が必要で、その入手方法は「楽天ウェブサービス - WebAPIの登録方法」を参照されたい。

「楽天トラベル施設検索API」による施設情報検索

「https://webservice.rakuten.co.jp/documentation/vacant-hotel-search:title=楽天トラベル空室検索API]」は、入力パラメータ(IN)は GET 渡しで、出力結果(OUT)は XML で戻るという形である。今回使う入力パラメータと出力結果のデータ構造を以下に示す。
WebAPIのURL
URL
https://app.rakuten.co.jp/services/api/Travel/VacantHotelSearch/20170426

入力パラメータ
フィールド名 要否 内  容
appid 必須 楽天ウェブサービスのアプリケーションID。
affiliateId 任意 楽天ウェブサービスのアフィリエイトID。
format 任意 レスポンス形式:'xml'または'json'
【デフォルト】json
callback 任意 JSONPとして出力する際のコールバック関数名 (UTF-8でURLエンコードした文字列)
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上
elements 任意 出力パラメーター指定:カンマ区切りで、必要な出力パラメータを指定した場合、指定された出力パラメータのみを返却する。
【デフォルト】ALL
latitude 必須 緯度:日本測地系、単位は秒、ミリ秒は小数点以下2桁以内で指定すること。
例)128216.17
ただし、datumTypeに1を指定した場合は、世界測地系、単位は度で指定すること。
例)35.6065914
longitude 必須 経度。日本測地系、単位は秒、ミリ秒は小数点以下2桁以内で指定すること。
例)503259.29
ただし、datumTypeに1を指定した場合は、世界測地系、単位は度で指定すること。
例)139.7513225
searchRadius 任意 検索半径:緯度経度検索時の検索半径(単位km)
0.1以上、3.0以下
小数点以下は1桁までであること
datumType 任意 緯度経度タイプ:入力及び出力パラメータの緯度経度タイプを指定する。
1:世界測地系、単位は度。
2:日本測地系、単位は秒。
【デフォルト】2
応答データ(xml) root pagingInfo recordCount 検索結果総数 pageCount 総ページ数 page ページ番号 first ページ内結果開始番号 last ページ内結果終了番号 hotels hotel hotelBasicInfo hotelNo 施設番号 hotelName 施設名称 hotelInformationUrl 施設情報ページURL planListUrl 宿泊プラン一覧ページURL dpPlanListUrl ダイナミックパッケージ宿泊プラン一覧ページURL reviewUrl お客様の声ページURL hotelKanaName 施設かな名称 hotelSpecial 施設特色 hotelMinCharge 最安料金 latitude 緯度 longitude 経度 postalCode 郵便番号 address1 住所1 address2 住所2 telephoneNo 施設電話番号 faxNo ファックス番号 access 施設へのアクセス parkingInformation 駐車場情報 nearestStation 最寄駅名称 hotelImageUrl 施設画像URL hotelThumbnailUrl 施設画像サムネイルURL roomImageUrl 部屋画像URL roomThumbnailUrl 部屋画像サムネイルURL hotelMapImageUrl 施設提供地図画像URL reviewCount 投稿件数 reviewAverage ★の数(総合) userReview お客さまの声(1件目)

解説:WebAPIコール

0074: /**
0075:  * WebAPIを呼び出して応答データを取得する(https用)
0076:  * @param   string $url リスクエストURL
0077:  * @return  string 応答データ/FALSE=失敗
0078: */
0079: function callWebAPI($url) {
0080:     $ch = curl_init($url);
0081:     curl_setopt($chCURLOPT_HEADERFALSE);
0082:     curl_setopt($chCURLOPT_RETURNTRANSFERTRUE);
0083:     curl_setopt($chCURLOPT_SSL_VERIFYPEERFALSE); //サーバ証明書検証をスキップ
0084:     curl_setopt($chCURLOPT_SSL_VERIFYHOSTFALSE); //  〃
0085:     $result = curl_exec($ch);
0086:     curl_close($ch);
0087: 
0088:     return $result;
0089: }

WebAPIはhttpsプロトコルであるため、ユーザー関数 callWebAPI のように cURL 関数を用いて呼び出している。このあたりについては「PHPセキュリティ対策:SSL通信を行う」で解説している。

解説:日付選択

チェックイン日・チェックアウト日を指定するのに、jQuery UIの Datepicker を利用した。カレンダーから年月日を選択できる。

0073: //楽天ウェブサービス・クラス:include_pathが通ったディレクトリに配置
0074: require_once('pahooRakuten.php');
0075: 
0076: /**
0077:  * 共通HTMLヘッダ
0078:  * @global string $HtmlHeader
0079: */
0080: $encode = INTERNAL_ENCODING;
0081: $title  = TITLE;
0082: $width  = MAP_WIDTH;
0083: $HtmlHeader =<<< EOT
0084: <!DOCTYPE html>
0085: <html lang="ja">
0086: <head>
0087: <meta charset="{$encode}">

0268: <th>住所</th>
0269: </tr>
0270: 
0271: EOT;
0272:         foreach ($items as $key=>$val) {

解説:ホテル検索

0093: var $RakutenBooksItems = array(
0094:     'title',           //書籍タイトル
0095:     'titleKana',       //書籍タイトル カナ
0096:     'subTitle',            //書籍サブタイトル
0097:     'subTitleKana',        //書籍サブタイトル カナ
0098:     'seriesName',      //叢書名
0099:     'seriesNameKana',  //叢書名カナ
0100:     'contents',            //多巻物収録内容
0101:     'contentsKana',        //多巻物収録内容カナ
0102:     'author',          //著者名
0103:     'authorKana',      //著者名カナ
0104:     'publisherName',   //出版社名
0105:     'size',                //書籍のサイズ
0106:     'isbn',                //ISBNコード(書籍コード)
0107:     'itemCaption',     //商品説明文
0108:     'salesDate',       //発売日
0109:     'itemPrice',       //税込み販売価格
0110:     'listPrice',       //定価
0111:     'discountRate',        //割引率
0112:     'discountPrice',   //割引価格
0113:     'itemUrl',         //商品URL
0114:     'affiliateUrl',        //アフィリエイトURL
0115:     'smallImageUrl',   //商品画像 64x64URL
0116:     'mediumImageUrl',  //商品画像 128x128URL
0117:     'largeImageUrl',   //商品画像 200x200URL
0118:     'chirayomiUrl',        //チラよみURL
0119:     'availability',        //在庫状況
0120:     'postageFlag',     //送料フラグ
0121:     'limitedFlag',     //限定フラグ
0122:     'reviewCount',     //レビュー件数
0123:     'reviewAverage',   //レビュー平均
0124:     'booksGenreId'     //楽天ブックスジャンルID
0125: );

0443: /**
0444:  * 楽天トラベル空室検索API のURLを取得する
0445:  * @param   double $latitude  緯度(世界測地系)
0446:  * @param   double $longitude 経度(世界測地系)
0447:  * @param   int    $searchRadius 検索半径,単位km
0448:  * @param   string $checkin  チェックイン年月日(YYYY-MM-DD)
0449:  * @param   string $checkout チェックアウト年月日(YYYY-MM-DD)
0450:  * @return  string URL 楽天トラベル空室検索API のURL
0451: */
0452: function searchVacantHotelsURL($latitude$longitude$searchRadius$checkin$checkout) {
0453:     $appid = $this->APPLICATIONID;
0454:     $affid = $this->AFFILIATEID;
0455:     $res = "https://app.rakuten.co.jp/services/api/Travel/VacantHotelSearch/20170426?applicationId={$appid}&affiliateId={$affid}&format=xml&latitude={$latitude}&longitude={$longitude}&searchRadius={$searchRadius}&checkinDate={$checkin}&checkoutDate={$checkout}&datumType=1&responseType=large&searchPattern=0";
0456: 
0457:     return $res;
0458: }

0460: /**
0461:  * 楽天トラベル系API を利用してホテルを検索する
0462:  * @param   array  $items 情報を格納する配列
0463:  * @param   double $latitude  緯度(世界測地系)
0464:  * @param   double $longitude 経度(世界測地系)
0465:  * @param   int    $searchRadius 検索半径,単位km
0466:  * @param   array  $squeezeConditions 絞込み条件の配列:省略可能
0467:  * @param   string $checkin  チェックイン年月日(YYYY-MM-DD):省略可能
0468:  * @param   string $checkout チェックアウト年月日(YYYY-MM-DD):省略可能
0469:  * @return  ヒットした件数/FALSE:検索に失敗
0470: */
0471: function searchHotels(&$items$latitude$longitude$searchRadius$squeezeConditions=array(''), $checkin='', $checkout='') {
0472:     //楽天トラベル空室検索API
0473:     if (preg_match('/\d{4}\-\d{2}\-\d{2}/i', $checkin) > 0) {
0474:         $url = $this->searchVacanthotelsURL($latitude$longitude$searchRadius$checkin$checkout);
0475:     //楽天トラベル施設検索API
0476:     } else {
0477:         $url = $this->searchHotelsURL($latitude$longitude$searchRadius$squeezeConditions);
0478:     }
0479: 
0480:     //APIコール
0481:     if (($res = $this->callWebAPI($url)) == FALSE) {
0482:         $this->error  = TRUE;
0483:         $this->errmsg = 'WebAPI呼び出しに失敗';
0484:         return FALSE;
0485:     }
0486:     $this->webapi = $url;
0487: 
0488: //PHP4用; DOM XML利用
0489:     if (isphp5over() == FALSE) {
0490:         if (($dom = domxml_open_mem($res)) == NULL) {
0491:             $this->error  = TRUE;
0492:             $this->errmsg = '楽天トラベルAPIの不具合';
0493:             $this->hits = 0;
0494:             return FALSE;
0495:         }
0496:         $pagingInfo = $dom->get_elements_by_tagname('pagingInfo');
0497:         //レスポンス・チェック
0498:         if (! is_object($pagingInfo )) {
0499:             $this->error  = TRUE;
0500:             $this->errmsg = 'ホテルが見当たらない';
0501:             $this->hits = 0;
0502:             return FALSE;
0503:         }
0504:         $rc = $pagingInfo[0]->get_elements_by_tagname('recordCount');
0505:         if (! is_object($rc)) {
0506:             $this->error  = TRUE;
0507:             $this->errmsg = 'ホテルが見当たらない';
0508:             $this->hits = 0;
0509:             return FALSE;
0510:         }
0511:         $rc = (int)$rc[0]->get_content();
0512:         if ($rc <= 0) {
0513:             $this->error  = TRUE;
0514:             $this->errmsg = 'ホテルが見当たらない';
0515:             $this->hits = 0;
0516:             return FALSE;
0517:         }
0518:         //検索結果取りだし
0519:         $hotels = $dom->get_elements_by_tagname('hotels');
0520:         $hotel  = $hotels[0]->get_elements_by_tagname('hotel');
0521:         $cnt = 1;
0522:         foreach ($hotel as $val) {
0523:             foreach ($this->RakutenHotelItems as $name) {
0524:                 $node = $val->get_elements_by_tagname('hotelBasicInfo');
0525:                 $node = $node[0]->get_elements_by_tagname($name);
0526:                 if ($node != NULL) {
0527:                     $items[$cnt][$name] = (string)$node[0]->get_content();
0528:                 }
0529:             }
0530:             $items[$cnt]['id']          = $this->num2alpha($cnt);
0531:             $items[$cnt]['title']       = $items[$cnt]['hotelName'];
0532: $items[$cnt]['description'] =<<< EOT
0533: <a href="{$items[$cnt]['hotelInformationUrl']}" target="_blank">{$items[$cnt]['hotelName']}</a>&nbsp;({$items[$cnt]['address1']}{$items[$cnt]['address2']})
0534: EOT;
0535:             $cnt++;
0536:         }
0537: 
0538: //PHP5用; SimpleXML利用
0539:     } else {
0540:         $xml = simplexml_load_string($res);
0541:         if ($xml == '|| $xml == FALSE) {
0542:             $this->error  = TRUE;
0543:             $this->errmsg = '楽天トラベルAPIの不具合';
0544:             $this->hits = 0;
0545:             return FALSE;
0546:         }
0547:         //レスポンス・チェック
0548:         if ($xml->pagingInfo->recordCount <= 0) {
0549:             $this->error  = TRUE;
0550:             $this->errmsg = 'ホテルが見当たらない';
0551:             $this->hits = 0;
0552:             return FALSE;
0553:         }
0554:         //検索結果取りだし
0555:         $cnt = 1;
0556:         $hotel = $xml->hotels->hotel;
0557:         foreach ($hotel as $element) {
0558:             foreach ($this->RakutenHotelItems as $name) {
0559:                 if (isset($element->hotelBasicInfo->$name)) {
0560:                     $items[$cnt][$name] = (string)$element->hotelBasicInfo->$name;
0561:                 } else if (isset($element->hotelDetailInfo->$name)) {
0562:                     $items[$cnt][$name] = (string)$element->hotelDetailInfo->$name;
0563:                 }
0564:             }
0565:             //部屋設備情報取り出し
0566:             if (isset($element->hotelFacilitiesInfo->roomFacilities->item)) {
0567:                 $node = $element->hotelFacilitiesInfo->roomFacilities->item;
0568:                 $i = 0;
0569:                 while (isset($node[$i])) {
0570:                     $items[$cnt]['roomFacilities'][$i] = (string)$node[$i];
0571:                     $i++;
0572:                 }
0573:             }
0574:             //Googleマップ描画用
0575:             $items[$cnt]['id']          = $this->num2alpha($cnt);
0576:             $items[$cnt]['title']       = $items[$cnt]['hotelName'];
0577: $items[$cnt]['description'] =<<< EOT
0578: <a href="{$items[$cnt]['hotelInformationUrl']}" target="_blank">{$items[$cnt]['hotelName']}</a>&nbsp;({$items[$cnt]['address1']}{$items[$cnt]['address2']})
0579: EOT;
0580:             $cnt++;
0581:         }
0582:     }
0583:     $this->hits = $cnt - 1;
0584: 
0585:     return $this->hits;
0586: }

応答データの要素が多いので、取得したい要素を $RakutenHotelItems にあらかじめ定義しておき、ユーザー関数 searchHotels の中で付き合わせながら配列$items に格納していく。

ユーザー関数 searchHotels の引数 $checkin$checkout は省略可能で、省略した場合は、今回使用している「楽天トラベル空室検索API」を呼び出す。省略しなければ、「楽天トラベル施設検索API」を呼び出す。

参考サイト

(この項おわり)
header