sitemapUtils
in package
sitemapUtils.php
Table of Contents
- $lockfile_expire : mixed
- ロックファイルの有効期限
- $lockfilepath : mixed
- ロックファイルのパス
- $opened_csv : mixed
- 開かれているCSVファイルの内容
- $px : mixed
- Picklesオブジェクト
- $px2dthelper : mixed
- px2dthelperオブジェクト
- $realpath_sitemap_dir : mixed
- サイトマップディレクトリ
- $timeout_limit : mixed
- ロック解除を待つ回数(秒数)
- __construct() : mixed
- constructor
- csv2xlsx() : array<string|int, mixed>
- CSV を xlsx に変換する
- csv_add_row() : mixed
- CSVの行を追加する
- csv_get_row() : mixed
- CSVの行を取得する
- csv_has_sitemap_definition() : mixed
- サイトマップに定義行が含まれるか調べる
- csv_open() : mixed
- CSVファイルを開く
- csv_remove_row() : mixed
- CSVの行を削除する
- csv_save_all() : mixed
- 開かれているすべてのCSVファイルを保存して閉じる
- csv_update_row() : mixed
- CSVの行を更新する
- get_default_sitemap_definition() : mixed
- デフォルトのサイトマップ定義を取得する
- get_under_children_row() : mixed
- すべての下層ページの行番号を得る
- has_sitemap_definition() : mixed
- サイトマップに定義行が含まれるか調べる
- is_locked() : bool
- 排他ロックされているか確認する
- lock() : bool
- 排他ロックする
- parse_sitemap_definition() : mixed
- デフォルトのサイトマップ定義を取得する
- realpath_sitemap_file() : string|bool
- 実在するサイトマップファイルの絶対パスを取得する
- touch_lockfile() : bool
- アプリケーションロックファイルの更新日を更新する。
- unlock() : bool
- 排他ロックを解除する
- validate_page_info() : mixed
- Validation: ページ情報
Properties
$lockfile_expire
ロックファイルの有効期限
private
mixed
$lockfile_expire
= 60
$lockfilepath
ロックファイルのパス
private
mixed
$lockfilepath
$opened_csv
開かれているCSVファイルの内容
private
mixed
$opened_csv
= array()
$px
Picklesオブジェクト
private
mixed
$px
$px2dthelper
px2dthelperオブジェクト
private
mixed
$px2dthelper
$realpath_sitemap_dir
サイトマップディレクトリ
private
mixed
$realpath_sitemap_dir
$timeout_limit
ロック解除を待つ回数(秒数)
private
mixed
$timeout_limit
= 5
Methods
__construct()
constructor
public
__construct(object $px2dthelper, object $px) : mixed
Parameters
- $px2dthelper : object
-
$px2dthelperオブジェクト
- $px : object
-
$pxオブジェクト
Return values
mixed —csv2xlsx()
CSV を xlsx に変換する
public
csv2xlsx(string $filefullname) : array<string|int, mixed>
NOTE: これは暫定的な処理です。サイトマップのページ数が多くなると、この処理は重くなります。 TODO: CSV全体を変換することはせず、CSVに反映した変更と同じ変更をXlsxにも差分反映させる処理に変更します。
Parameters
- $filefullname : string
-
対象ファイル名(拡張子を含む)
Return values
array<string|int, mixed> —実行結果
csv_add_row()
CSVの行を追加する
public
csv_add_row(mixed $filefullname, mixed $row_index, mixed $row_assoc) : mixed
Parameters
- $filefullname : mixed
- $row_index : mixed
- $row_assoc : mixed
Return values
mixed —csv_get_row()
CSVの行を取得する
public
csv_get_row(mixed $filefullname, mixed $row_index) : mixed
Parameters
- $filefullname : mixed
- $row_index : mixed
Return values
mixed —csv_has_sitemap_definition()
サイトマップに定義行が含まれるか調べる
public
csv_has_sitemap_definition(mixed $filefullname) : mixed
Parameters
- $filefullname : mixed
Return values
mixed —csv_open()
CSVファイルを開く
public
& csv_open(mixed $filefullname) : mixed
Parameters
- $filefullname : mixed
Return values
mixed —csv_remove_row()
CSVの行を削除する
public
csv_remove_row(mixed $filefullname, mixed $row_index) : mixed
Parameters
- $filefullname : mixed
- $row_index : mixed
Return values
mixed —csv_save_all()
開かれているすべてのCSVファイルを保存して閉じる
public
csv_save_all() : mixed
Return values
mixed —csv_update_row()
CSVの行を更新する
public
csv_update_row(mixed $filefullname, mixed $row_index, mixed $row_assoc) : mixed
Parameters
- $filefullname : mixed
- $row_index : mixed
- $row_assoc : mixed
Return values
mixed —get_default_sitemap_definition()
デフォルトのサイトマップ定義を取得する
public
get_default_sitemap_definition() : mixed
Return values
mixed —get_under_children_row()
すべての下層ページの行番号を得る
public
get_under_children_row(mixed $path[, mixed &$all_list = array() ]) : mixed
ページ情報を更新する際に、パンくずを修正する必要のある影響範囲を返します。
Parameters
- $path : mixed
- $all_list : mixed = array()
Return values
mixed —has_sitemap_definition()
サイトマップに定義行が含まれるか調べる
public
has_sitemap_definition(mixed $csv) : mixed
Parameters
- $csv : mixed
Return values
mixed —is_locked()
排他ロックされているか確認する
public
is_locked() : bool
Return values
bool —ロック中の場合に true、それ以外の場合に false を返します。
lock()
排他ロックする
public
lock() : bool
Return values
bool —ロック成功時に true、失敗時に false を返します。
parse_sitemap_definition()
デフォルトのサイトマップ定義を取得する
public
parse_sitemap_definition(mixed $csv) : mixed
Parameters
- $csv : mixed
Return values
mixed —realpath_sitemap_file()
実在するサイトマップファイルの絶対パスを取得する
public
realpath_sitemap_file(string $filefullname) : string|bool
大文字・小文字 の区別をせずに検索する。
Parameters
- $filefullname : string
-
対象ファイル名(拡張子を含む)
Return values
string|bool —ファイルの絶対パスを返す。ファイルが見つからない場合に false を返す。
touch_lockfile()
アプリケーションロックファイルの更新日を更新する。
public
touch_lockfile() : bool
Return values
bool —成功時に true、失敗時に false を返します。
unlock()
排他ロックを解除する
public
unlock() : bool
Return values
bool —ロック解除成功時に true、失敗時に false を返します。
validate_page_info()
Validation: ページ情報
public
validate_page_info(mixed $page_info) : mixed
Parameters
- $page_info : mixed