Public メソッド | Protected メソッド | Protected 変数

クラス PageHeader

PageHeaderに対する継承グラフ
PageSectionBase AdvancedHotelSearchPageHeader AirTicketSearchPageHeader HotelSearchPageHeader TourSearchPageHeader

Public メソッド

 __construct ($fileName)
 assignParams ($service)
 show ()

Protected メソッド

 isAdvancedSearchOptionOn ()
 getSortByOptions ()
 renderFlippering ($itemHtml)
 renderKeyword ($itemHtml)
 renderLocationCodes ($itemHtml)
 renderRegion ($itemHtml, $selectedRegion, $optionTitle='方面')
 renderCountry ($itemHtml, $regionCode, $selectedCountry, $optionTitle='国・地域', $exclude_countries=null)
 renderCity ($itemHtml, $cities, $selectedCity)
 renderCityByCountry ($itemHtml, $countryCode, $selectedCity=null)
 renderCityBySArea ($itemHtml, $sAreaCode, $selectedCity=null)
 renderLArea ($itemHtml, $countryCode, $optionTitle='地域')
 renderSArea ($itemHtml, $lAreaCode)
 renderPrice ($itemHtml)
 renderCreditCardOption ($itemHtml)
 renderSortBy ($itemHtml)
 renderSortOrder ($itemHtml)
 getLAreaName ($countryCode= 'JP')
 getSAreaName ($lAreaCode)
 getCityName ($cities, $selectedCity)
 getCityNameBySArea ($sAreaCode, $selectedCity=null)
 render ()

Protected 変数

 $view
 $page = null
 $larea_cd = null
 $sarea_cd = null
 $city_cd = null
 $price_min = null
 $price_max = null
 $c_card = null
 $sort_by = null
 $sort_order = null

説明

ページの表示部分のヘッダ

このWEBアプリケーションでは、表示するページをヘッダ部分とボディ部分の 2つのセクションとして扱います。このクラスは、表示ヘッダ部分、すなわち 検索フォーム部分の機能を実現しています。

作者:
hrahman

PageHeader.php の 15 行で定義されています。

コンストラクタとデストラクタ

__construct ( $  fileName )

コンストラクタには、表示ヘッダ部分のビューファイル(HTMLテンプレート）へのパスを渡します。

引数:
string$fileNameビューファイルへのパス

AdvancedHotelSearchPageHeader, AirTicketSearchPageHeader, HotelSearchPageHeader, と TourSearchPageHeaderで再定義されています。

PageHeader.php の 71 行で定義されています。

関数

assignParams ( $  service )

SDB Service API クラスのインスタンスに、フォームに設定されていた パラメータを指定します。

引数:
$serviceSDB Service API (VCSDBDriverHotel/VCSDBDriverTour/VCSDBDriverAirTicket) オブジェクト

AirTicketSearchPageHeader, HotelSearchPageHeader, と TourSearchPageHeaderで再定義されています。

PageHeader.php の 153 行で定義されています。

getCityName ( $  cities,
$  selectedCity 
) [protected]

都市名の取得

引数:
$citiescity XML 要素
戻り値:
都市名

PageHeader.php の 636 行で定義されています。

getCityNameBySArea ( $  sAreaCode,
$  selectedCity = null 
) [protected]

選択した都市名の取得

引数:
$itemHtmlHTML テンプレート
$sAreaCode小エリアコード
戻り値:
選択した都市コードの名前

PageHeader.php の 658 行で定義されています。

getLAreaName ( $  countryCode = 'JP' ) [protected]

選択した大エリア名の取得

引数:
$countryCode国コード
戻り値:
選択した大エリアコードの名前

PageHeader.php の 586 行で定義されています。

getSAreaName ( $  lAreaCode ) [protected]

選択した小エリア名の取得

引数:
$lAreaCode大エリアコード
戻り値:
選択した小エリアコードの名前

PageHeader.php の 612 行で定義されています。

getSortByOptions (  ) [protected]

並び順の属性

戻り値:
並び順属性のリスト

AirTicketSearchPageHeader, と TourSearchPageHeaderで再定義されています。

PageHeader.php の 239 行で定義されています。

isAdvancedSearchOptionOn (  ) [protected]

詳細検索が有効でもフックメソットをチェックします。 サブクラスを優先

戻り値:
false by default

AdvancedHotelSearchPageHeader, AirTicketSearchPageHeader, HotelSearchPageHeader, と TourSearchPageHeaderで再定義されています。

PageHeader.php の 230 行で定義されています。

render (  ) [protected]

Override this method to do a proper rendering. By default, renders the html view as it is.

戻り値:
HTMLテキスト

AdvancedHotelSearchPageHeader, AirTicketSearchPageHeader, HotelSearchPageHeader, と TourSearchPageHeaderで再定義されています。

PageHeader.php の 668 行で定義されています。

renderCity ( $  itemHtml,
$  cities,
$  selectedCity 
) [protected]

都市

引数:
$itemHtmlHTML テンプレート
$citiescity XML 要素
戻り値:
${CITY_CD} と ${CITY_STATUS} に置き換えたHTML

PageHeader.php の 381 行で定義されています。

renderCityByCountry ( $  itemHtml,
$  countryCode,
$  selectedCity = null 
) [protected]

選択した国にある都市

引数:
$itemHtmlHTML テンプレート
$countryCode国コード
戻り値:
${CITY_CD} と ${CITY_STATUS} に置き換えたHTML

PageHeader.php の 411 行で定義されています。

renderCityBySArea ( $  itemHtml,
$  sAreaCode,
$  selectedCity = null 
) [protected]

選択した小エリアにある都市

引数:
$itemHtmlHTML テンプレート
$sAreaCode小エリアコード
戻り値:
${CITY_CD} と ${CITY_STATUS} に置き換えたHTML

PageHeader.php の 422 行で定義されています。

renderCountry ( $  itemHtml,
$  regionCode,
$  selectedCountry,
$  optionTitle = '国・地域',
$  exclude_countries = null 
) [protected]

国

引数:
$itemHtmlHTML テンプレート
$regionCode地域コード
$selectedCountry国を選択
$optionTitleタイトル (デフォルト値は '国・地域')
$exclude_countriesリストから除かれる国 (任意のパラメータ)
戻り値:
${CTRY_CD} と ${CTRY_STATUS} に置き換えたHTML

PageHeader.php の 342 行で定義されています。

renderCreditCardOption ( $  itemHtml ) [protected]

クレジットカード支払いのオプション

引数:
$itemHtmlHTML テンプレート
戻り値:
${C_CARD} に置き換えたHTML

PageHeader.php の 524 行で定義されています。

renderFlippering ( $  itemHtml ) [protected]

Render 詳細検索フィールドの開閉

引数:
$itemHtmlHTML テンプレート
戻り値:
${FLIPPER_ON} と ${FLIPPER_OFF} に置き換えたHTML

PageHeader.php の 249 行で定義されています。

renderKeyword ( $  itemHtml ) [protected]

キーワードを入力

引数:
$itemHtmlHTML テンプレート
戻り値:
${KEYWORD} に置き換えたHTML

PageHeader.php の 270 行で定義されています。

renderLArea ( $  itemHtml,
$  countryCode,
$  optionTitle = '地域' 
) [protected]

選択した国にある大エリア

引数:
$itemHtmlHTML テンプレート
$countryCode国コード
戻り値:
${LAREA_CD} と ${LAREA_STATUS} に置き換えたHTML

PageHeader.php の 433 行で定義されています。

renderLocationCodes ( $  itemHtml ) [protected]

場所コード

引数:
$itemHtmlHTML テンプレート
戻り値:
${LOCATION_CODES} に置き換えたHTML

PageHeader.php の 286 行で定義されています。

renderPrice ( $  itemHtml ) [protected]

価格

引数:
$itemHtmlHTML テンプレート
戻り値:
${PRICE_MIN} と ${PRICE_MAX} に置き換えたHTML

PageHeader.php の 502 行で定義されています。

renderRegion ( $  itemHtml,
$  selectedRegion,
$  optionTitle = '方面' 
) [protected]

地域

引数:
$itemHtmlHTML テンプレート
$selectedRegion地域を選択
$optionTitleタイトル (デフォルト値は '方面')
戻り値:
${REGION_CD} と ${REGION_STATUS} に置き換えたHTML

PageHeader.php の 307 行で定義されています。

renderSArea ( $  itemHtml,
$  lAreaCode 
) [protected]

選択した大エリアに小エリア

引数:
$itemHtmlHTML テンプレート
$lAreaCode大エリアコード
戻り値:
${SAREA_CD} and ${SAREA_STATUS} に置き換えたHTML

PageHeader.php の 470 行で定義されています。

renderSortBy ( $  itemHtml ) [protected]

並び順の属性

引数:
$itemHtmlHTML テンプレート
戻り値:
${SORT_BY} に置き換えたHTML

PageHeader.php の 539 行で定義されています。

renderSortOrder ( $  itemHtml ) [protected]

並び順(昇順/降順))

引数:
$itemHtmlHTML テンプレート
戻り値:
${SORT_ORDER} に置き換えたHTML

PageHeader.php の 562 行で定義されています。

show (  ) [final]

ページに表示ヘッダを出力します。

Template method, override hook method render() for customized rendering

PageHeader.php の 677 行で定義されています。

構造体

$c_card = null [protected]

c_card パラメータ、クレジットカード可・不可を指定します。"y"なら"可"です。

PageHeader.php の 58 行で定義されています。

$city_cd = null [protected]

city_cd パラメータ、市区町村コード、値はSDB APIに準じます

PageHeader.php の 49 行で定義されています。

$larea_cd = null [protected]

larea_cd パラメータ、大エリアコード、値はSDB APIに準じます

PageHeader.php の 43 行で定義されています。

$page = null [protected]

page パラメータ 、現在のページ番号

PageHeader.php の 40 行で定義されています。

$price_max = null [protected]

price_max パラメータ 、検索結果に含める最高価格

PageHeader.php の 55 行で定義されています。

$price_min = null [protected]

price_min パラメータ 、検索結果に含める最低価格

PageHeader.php の 52 行で定義されています。

$sarea_cd = null [protected]

sarea_cd パラメータ、小エリアコード、値はSDB APIに準じます

PageHeader.php の 46 行で定義されています。

$sort_by = null [protected]

sort_by パラメータ、検索結果の表示順を指定します。値は SDB API に準じます

PageHeader.php の 61 行で定義されています。

$sort_order = null [protected]

sort_order parameter

PageHeader.php の 64 行で定義されています。

$view [protected]

表示ヘッダ部分のビューファイルの内容

PageHeader.php の 34 行で定義されています。

このクラスの説明は次のファイルから生成されました:
バリューコマース ウェブサービス トラベルAPIサンプル　ドキュメンテーションに対してTue Jan 11 2011 19:25:20に生成されました。  doxygen 1.7.2