class Sitemap extends AbstractPage

Sitemapプロトコル ファイル生成モジュール.

PHP versions 4 and 5

このモジュールは Sitemapプロトコルに対応した XMLファイルを出力する.
EC-CUBE インストールディレクトリの htmlディレクトリへ配置することにより動作する.

このモジュールにより, 以下のページのサイトマップが生成される.
1. $staticURL で指定したページ
2. 管理画面のデザイン管理から生成したページ
3. 公開されている全ての商品一覧ページ
4. 公開されている全ての商品詳細ページ

このモジュールを設置後, 各検索エンジンにサイトマップを登録することにより, 検索エンジンの
インデックス化が促進される.

Properties

$tpl_mainpage メインテンプレート from AbstractPage
$tpl_column_num テンプレートのカラム数 from AbstractPage
$tpl_mainno メインナンバー from AbstractPage
$tpl_css CSS のパス from AbstractPage
$tpl_javascript JavaScript from AbstractPage
$tpl_title タイトル from AbstractPage
$tpl_login_email ログインメールアドレス from AbstractPage
$tpl_onload HTML ロード後に実行する JavaScript コード from AbstractPage
$transactionid トランザクションID from AbstractPage
$template メインテンプレート名 from AbstractPage
$arrSiteInfo 店舗基本情報 from AbstractPage
$plugin_activate_flg プラグインを実行フラグ from AbstractPage
$arrLimitPostMode POST に限定する mode from AbstractPage
$skip_load_page_layout ページレイアウトを読み込むか from AbstractPage
$load_legacy_js 2.12.x 以前のJavaScript関数を読み込むかどうか from AbstractPage
$tpl_page_class_name from AbstractPage
$arrForm from AbstractPage
$arrErr from AbstractPage
Display $objDisplay from AbstractPage
$staticURL 動的に生成しないページの配列
$arrPageList ページリスト

Methods

__construct($app = null)

No description

void
init()

Page を初期化する.

void
process()

Page のプロセス.

void
sendResponse()

Page のレスポンス送信.

void
sendResponseCSV(string $file_name, string $data)

Page のレスポンス送信(ダウンロード).

void
__destruct()

デストラクタ

void
doLocalHookpointBefore(PluginHelper $objPlugin)

ローカルフックポイントを生成し、実行します.

void
doLocalHookpointAfter(PluginHelper $objPlugin)

ローカルフックポイントを生成し、実行します.

getTemplate()

テンプレート取得

setTemplate($template)

テンプレート設定(ポップアップなどの場合)

string
getLocation(string $path, array $param = array(), mixed $useSSL = 'escape')

$path から URL を取得する.

string
getRootPath(string $path)

EC-CUBE のWEBルート(/html/)を / としたパスを返す

void
allowClientCache() deprecated

互換性確保用メソッド

void
httpCacheControl(string $mode = '')

クライアント・プロキシのキャッシュを制御する.

string|null
getMode()

リクエストパラメーター 'mode' を取得する.

void
doValidToken(boolean $is_admin = false)

POST アクセスの妥当性を検証する.

void
setTokenTo()

トランザクショントークンを取得し, 設定する.

log($mess, $log_level) deprecated

前方互換用

void
p(mixed $val)

デバック出力を行う.

void
checkLimitPostMode()

POST に限定された mode か検証する。

createSitemap(string $loc, string $lastmod = '', string $changefreq = '', double $priority = '')

Sitemap の を生成する.

array
getTopPage(array $arrPageList)

TOPページの情報を取得する.

array
getEditablePage(array $arrPageList)

全ての編集可能ページの情報を取得する.

array
getAllProducts()

全ての商品一覧ページを取得する.

array
getAllDetail()

全ての商品詳細ページを取得する.

array
getPageData(string $where = '', array $arrVal = '')

ブロック情報を取得する.

string
date2W3CDatetime(date $date)

date形式の文字列を W3C Datetime 形式に変換して出力する.

Details

in AbstractPage at line 102
__construct($app = null)

Parameters

$app

at line 69
void init()

Page を初期化する.

Return Value

void

at line 84
void process()

Page のプロセス.

Return Value

void

in AbstractPage at line 160
void sendResponse()

Page のレスポンス送信.

Return Value

void

in AbstractPage at line 190
void sendResponseCSV(string $file_name, string $data)

Page のレスポンス送信(ダウンロード).

Parameters

string $file_name
string $data

Return Value

void

in AbstractPage at line 209
void __destruct()

デストラクタ

・ブロックの基底クラス (Ecube\Page\Bloc) では、継承していない。

Return Value

void

in AbstractPage at line 229
void doLocalHookpointBefore(PluginHelper $objPlugin)

ローカルフックポイントを生成し、実行します.

Parameters

PluginHelper $objPlugin

Return Value

void

in AbstractPage at line 250
void doLocalHookpointAfter(PluginHelper $objPlugin)

ローカルフックポイントを生成し、実行します.

Parameters

PluginHelper $objPlugin

Return Value

void

in AbstractPage at line 269
getTemplate()

テンプレート取得

in AbstractPage at line 278
setTemplate($template)

テンプレート設定(ポップアップなどの場合)

Parameters

$template

in AbstractPage at line 303
string getLocation(string $path, array $param = array(), mixed $useSSL = 'escape')

$path から URL を取得する.

以下の順序で 引数 $path から URL を取得する. 1. realpath($path) で $path の 絶対パスを取得 2. $SERVER['DOCUMENTROOT'] と一致する文字列を削除 3. $useSSL の値に応じて, HTTPURL 又は, HTTPSURL を付与する.

返り値に, QUERY_STRING を含めたい場合は, key => value 形式 の配列を $param へ渡す.

Parameters

string $path 結果を取得するためのパス
array $param URL に付与するパラメーターの配列
mixed $useSSL 結果に HTTPSURL を使用する場合 true, HTTPURL を使用する場合 false, デフォルト 'escape' 現在のスキーマを使用

Return Value

string $path の存在する http(s):// から始まる絶対パス

See also

\Net_URL

in AbstractPage at line 337
string getRootPath(string $path)

EC-CUBE のWEBルート(/html/)を / としたパスを返す

Parameters

string $path 結果を取得するためのパス

Return Value

string EC-CUBE のWEBルート(/html/)からのパス。

in AbstractPage at line 367
void allowClientCache() deprecated

deprecated 決済モジュール互換のため

互換性確保用メソッド

Return Value

void

in AbstractPage at line 379
void httpCacheControl(string $mode = '')

クライアント・プロキシのキャッシュを制御する.

Parameters

string $mode (nocache/private)

Return Value

void

in AbstractPage at line 414
string|null getMode()

リクエストパラメーター 'mode' を取得する.

  1. $_REQUEST['mode'] の値を取得する.
  2. 存在しない場合は null を返す.

mode に, 半角英数字とアンダーバー(_) 以外の文字列が検出された場合は null を 返す.

Return Value

string|null $_REQUEST['mode'] の文字列

in AbstractPage at line 440
void doValidToken(boolean $is_admin = false)

POST アクセスの妥当性を検証する.

生成されたトランザクショントークンの妥当性を検証し, 不正な場合はエラー画面へ遷移する.

この関数は, 基本的に init() 関数で呼び出され, POST アクセスの場合は自動的に トランザクショントークンを検証する. ページによって検証タイミングなどを制御する必要がある場合は, この関数を オーバーライドし, 個別に設定を行うこと.

Parameters

boolean $is_admin 管理画面でエラー表示をする場合 true

Return Value

void

in AbstractPage at line 460
void setTokenTo()

トランザクショントークンを取得し, 設定する.

Return Value

void

in AbstractPage at line 470
log($mess, $log_level) deprecated

deprecated 2.12.0 GcUtils::gfPrintLog を使用すること

前方互換用

Parameters

$mess
$log_level

in AbstractPage at line 491
void p(mixed $val)

デバック出力を行う.

デバック用途のみに使用すること.

Parameters

mixed $val デバックする要素

Return Value

void

in AbstractPage at line 502
void checkLimitPostMode()

POST に限定された mode か検証する。

POST 以外で、POST に限定された mode を実行しようとした場合、落とす。

Return Value

void

at line 148
Sitemap createSitemap(string $loc, string $lastmod = '', string $changefreq = '', double $priority = '')

Sitemap の を生成する.

Parameters

string $loc ページの URL ※必須
string $lastmod ファイルの最終更新日 YYYY-MM-DD or W3C Datetime 形式
string $changefreq ページの更新頻度
double $priority URL の優先度

Return Value

Sitemap 形式の

See also

https://www.google.com/webmasters/tools/docs/ja/protocol.html#xmlTagDefinitions TODO Smarty に移行すべき?

at line 170
array getTopPage(array $arrPageList)

TOPページの情報を取得する.

Parameters

array $arrPageList 全てのページ情報の配列

Return Value

array TOPページの情報

at line 188
array getEditablePage(array $arrPageList)

全ての編集可能ページの情報を取得する.

Parameters

array $arrPageList 全てのページ情報の配列

Return Value

array 編集可能ページ

at line 205
array getAllProducts()

全ての商品一覧ページを取得する.

Return Value

array 検索エンジンからアクセス可能な商品一覧ページの情報

at line 228
array getAllDetail()

全ての商品詳細ページを取得する.

Return Value

array 検索エンジンからアクセス可能な商品詳細ページの情報

at line 252
array getPageData(string $where = '', array $arrVal = '')

ブロック情報を取得する.

Parameters

string $where WHERE句
array $arrVal WHERE句の値を格納した配列

Return Value

array $arrPageList ブロック情報

at line 303
string date2W3CDatetime(date $date)

date形式の文字列を W3C Datetime 形式に変換して出力する.

Parameters

date $date 変換する日付

Return Value

string