main
in package
main.php
Table of Contents
- $command : mixed
- PXコマンド名
- $lb : mixed
- langbank
- $px : mixed
- Picklesオブジェクト
- $px2dtconfig : mixed
- px2dtconfig
- __construct() : mixed
- Constructor
- bind_path_files() : string
- リソースパステンプレートに実際の値を当てはめる。
- change_content_editor_mode() : mixed
- コンテンツ編集モードを変更する
- check_editor_mode() : mixed
- 編集モードを取得する
- check_status() : object
- セットアップ状態をチェックする。
- copy_content() : array<string|int, mixed>
- コンテンツを複製する
- document_modules() : mixed
- ドキュメントモジュール定義をロードする
- find_page_content() : mixed
- ページのコンテンツファイルを探す
- get_custom_fields() : mixed
- Get custom_fields
- get_navigation_info() : array<string|int, mixed>
- Get Navigation Info
- get_path_homedir() : string
- ホームディレクトリのパスを得る。
- get_path_resource_dir() : mixed
- Get path_resource_dir
- get_path_theme_collection_dir() : string
- テーマコレクションディレクトリのパスを得る。
- get_px2dtconfig() : mixed
- px2dtconfigを取得する。
- get_realpath_data_dir() : string
- realpath_data_dir のパスを得る。
- get_realpath_theme_collection_dir() : string
- テーマコレクションディレクトリのパスを得る。
- get_version() : string
- px2-px2dthelper のバージョン情報を取得する。
- init_content() : mixed
- コンテンツを初期化する
- lb() : mixed
- $lb
- packages() : mixed
- パッケージ操作オブジェクトをロードする
- path_files() : string
- ローカルリソースディレクトリのパスを得る。
- plugins() : mixed
- プラグイン操作オブジェクトをロードする
- realpath_files() : string
- ローカルリソースディレクトリのサーバー内部パスを得る。
- register() : mixed
- entry
- search_sitemap() : array<string|int, mixed>
- サイトマップ中のページを検索する
- authorize_required() : mixed
- Authorizeが必要
- route() : void
- route as PX Command
- route_only_post_and_cli() : mixed
- POSTメソッド、CLIのみ許容
Properties
$command
PXコマンド名
private
mixed
$command
= array()
$lb
langbank
private
mixed
$lb
$px
Picklesオブジェクト
private
mixed
$px
$px2dtconfig
px2dtconfig
private
mixed
$px2dtconfig
Methods
__construct()
Constructor
public
__construct(object $px) : mixed
Parameters
- $px : object
-
$pxオブジェクト
Return values
mixed —bind_path_files()
リソースパステンプレートに実際の値を当てはめる。
public
bind_path_files(string $template[, string $path_content = null ]) : string
Parameters
- $template : string
-
テンプレート
- $path_content : string = null
-
コンテンツのパス
Return values
string —バインド後のパス文字列
change_content_editor_mode()
コンテンツ編集モードを変更する
public
change_content_editor_mode(string $editor_mode) : mixed
Parameters
- $editor_mode : string
-
変更後の編集モード名
Return values
mixed —check_editor_mode()
編集モードを取得する
public
check_editor_mode([string $page_path = null ]) : mixed
Parameters
- $page_path : string = null
-
対象のページのパス
Return values
mixed —check_status()
セットアップ状態をチェックする。
public
check_status() : object
Return values
object —状態情報
copy_content()
コンテンツを複製する
public
copy_content(string $path_from, string $path_to[, array<string|int, mixed> $options = array() ]) : array<string|int, mixed>
Parameters
- $path_from : string
-
複製元ページのパス
- $path_to : string
-
複製先ページのパス
- $options : array<string|int, mixed> = array()
-
オプション (詳しくは
fncs_copy_content::copy()の説明を参照)
Return values
array<string|int, mixed> —実行結果
document_modules()
ドキュメントモジュール定義をロードする
public
document_modules() : mixed
Return values
mixed —find_page_content()
ページのコンテンツファイルを探す
public
find_page_content([string $page_path = null ]) : mixed
Parameters
- $page_path : string = null
-
ページのパス。
Return values
mixed —get_custom_fields()
Get custom_fields
public
get_custom_fields() : mixed
Return values
mixed —get_navigation_info()
Get Navigation Info
public
get_navigation_info([string $page_path = null ][, array<string|int, mixed> $opt = array() ]) : array<string|int, mixed>
Parameters
- $page_path : string = null
-
ページのパス (省略時: カレントページ)
- $opt : array<string|int, mixed> = array()
-
オプション(省略可)
- $opt['filter'] (初期値: `true`)
- フィルターの有効/無効を切り替えます。`true` のとき有効、`false`のとき無効となります。フィルターが有効な場合、サイトマップで `list_flg` が `0` のページが一覧から除外されます。
Return values
array<string|int, mixed> —ナビゲーション情報。 サイトマップがロードできない場合は false を返します。
get_path_homedir()
ホームディレクトリのパスを得る。
public
get_path_homedir() : string
NOTE: Pickles Framework に $px->get_path_homedir() があるが、
このメソッドは $px->get_realpath_homedir() の古い名前であり、絶対パスが返される。
過去の挙動を壊さないように、このメソッドの振る舞いは変更しない。
なので、代わりに $this->get_path_homedir() を作り、これを使うことにした。
Return values
string —ホームディレクトリのパス, 失敗した場合 false
get_path_resource_dir()
Get path_resource_dir
public
get_path_resource_dir([string $page_path = null ]) : mixed
Parameters
- $page_path : string = null
-
対象のページのパス
Return values
mixed —get_path_theme_collection_dir()
テーマコレクションディレクトリのパスを得る。
public
get_path_theme_collection_dir() : string
Return values
string —テーマコレクションディレクトリの絶対パス, 失敗した場合 false
get_px2dtconfig()
px2dtconfigを取得する。
public
get_px2dtconfig() : mixed
Return values
mixed —get_realpath_data_dir()
realpath_data_dir のパスを得る。
public
get_realpath_data_dir([string $page_path = null ]) : string
Parameters
- $page_path : string = null
-
対象のページのパス
Return values
string —ローカルリソースの実際の絶対パス
get_realpath_theme_collection_dir()
テーマコレクションディレクトリのパスを得る。
public
get_realpath_theme_collection_dir() : string
Return values
string —テーマコレクションディレクトリの絶対パス, 失敗した場合 false
get_version()
px2-px2dthelper のバージョン情報を取得する。
public
get_version() : string
px2-px2dthelper のバージョン番号はこのメソッドにハードコーディングされます。
バージョン番号発行の規則は、 Semantic Versioning 2.0.0 仕様に従います。
[開発版]
バージョン番号が振られていない、開発途中のリビジョンを、開発版と呼びます。
開発版の場合、バージョン番号は、次のリリースが予定されているバージョン番号に、
ビルドメタデータ +dev を付加します。
通常は、プレリリース記号 alpha または beta を伴うようにします。
- 例：1.0.0-beta.12+dev (=1.0.0-beta.12リリース前の開発版)
Return values
string —バージョン番号を示す文字列
init_content()
コンテンツを初期化する
public
init_content(string $editor_mode[, array<string|int, mixed> $options = array() ]) : mixed
Parameters
- $editor_mode : string
-
編集モード名
- $options : array<string|int, mixed> = array()
-
オプション (詳しくは
fncs_init_content::init_content()の説明を参照)
Return values
mixed —lb()
$lb
public
lb() : mixed
Return values
mixed —packages()
パッケージ操作オブジェクトをロードする
public
packages() : mixed
Return values
mixed —path_files()
ローカルリソースディレクトリのパスを得る。
public
path_files([string $page_path = null ]) : string
Parameters
- $page_path : string = null
-
対象のページのパス または ページID
Return values
string —ローカルリソースの実際の絶対パス
plugins()
プラグイン操作オブジェクトをロードする
public
plugins() : mixed
Return values
mixed —realpath_files()
ローカルリソースディレクトリのサーバー内部パスを得る。
public
realpath_files([string $page_path = null ]) : string
Parameters
- $page_path : string = null
-
対象のページのパス
Return values
string —ローカルリソースのサーバー内部パス
register()
entry
public
static register([object $px = null ][, object $options = null ]) : mixed
Parameters
- $px : object = null
-
Picklesオブジェクト
- $options : object = null
-
プラグイン設定
Return values
mixed —search_sitemap()
サイトマップ中のページを検索する
public
search_sitemap(string $keyword[, array<string|int, mixed> $options = array() ]) : array<string|int, mixed>
Parameters
- $keyword : string
-
キーワード
- $options : array<string|int, mixed> = array()
-
オプション
Return values
array<string|int, mixed> —検出されたページの一覧
authorize_required()
Authorizeが必要
private
authorize_required(mixed $authority_name) : mixed
Parameters
- $authority_name : mixed
Return values
mixed —route()
route as PX Command
private
route() : void
Return values
void —route_only_post_and_cli()
POSTメソッド、CLIのみ許容
private
route_only_post_and_cli() : mixed