px2project
px2project.php
Table of Contents
- $main : mixed
- $options : mixed
- $path_entry_script : mixed
- __construct() : mixed
- Constructor
- bind_dynamic_path_param() : mixed
- ダイナミックパスに値をバインドする
- clearcache() : mixed
- キャッシュを削除する
- get_actors() : mixed
- Actor のページID一覧を取得する
- get_breadcrumb_array() : mixed
- パンくず配列を取得する
- get_bros() : mixed
- 兄弟ページの一覧を取得する
- get_bros_next() : mixed
- 次の兄弟ページを取得する
- get_bros_prev() : mixed
- 前の兄弟ページを取得する
- get_children() : mixed
- 子階層のページの一覧を取得する
- get_config() : mixed
- configデータを取得する
- get_directory_index() : mixed
- directory_index(省略できるファイル名) の一覧を得る
- get_directory_index_primary() : mixed
- 最も優先されるインデックスファイル名を得る
- get_domain() : mixed
- domain を取得する
- get_dynamic_path_info() : mixed
- ダイナミックパス情報を得る
- get_next() : mixed
- 次のページを取得する
- get_page_info() : mixed
- pathまたはidからページ情報を得る
- get_parent() : mixed
- 親ページのIDを取得する
- get_path_content() : mixed
- get content path
- get_path_controot() : mixed
- コンテンツルートディレクトリのパス(=install path) を取得する
- get_path_docroot() : mixed
- DOCUMENT_ROOT のパスを取得する (deprecated)
- get_path_homedir() : mixed
- get home directory path (deprecated)
- get_path_proc_type() : mixed
- ファイルの処理方法を調べる
- get_prev() : mixed
- 前のページを取得する
- get_realpath_docroot() : mixed
- DOCUMENT_ROOT のパスを取得する
- get_realpath_homedir() : mixed
- get home directory path
- get_role() : mixed
- role を取得する
- get_sitemap() : mixed
- サイトマップデータを取得する
- get_version() : mixed
- バージョン番号を取得する
- href() : mixed
- リンク先のパスを生成する
- is_ignore_path() : mixed
- 除外ファイルか調べる
- is_match_dynamic_path() : mixed
- パスがダイナミックパスにマッチするか調べる
- is_page_in_breadcrumb() : mixed
- ページが、パンくず内に存在しているか調べる
- path_files() : mixed
- ローカルリソースディレクトリのパスを得る
- path_files_cache() : mixed
- ローカルリソースのキャッシュディレクトリのパスを得る
- publish() : mixed
- パブリッシュする
- px_command() : mixed
- PXコマンドを実行する
- query() : mixed
- Pickles 2 にクエリを投げて、結果を受け取る (汎用)
- realpath_files() : mixed
- ローカルリソースディレクトリのサーバー内部パスを得る
- realpath_files_cache() : mixed
- ローカルリソースのキャッシュディレクトリのサーバー内部パスを得る
- realpath_files_private_cache() : mixed
- コンテンツ別の非公開キャッシュディレクトリのサーバー内部パスを得る
- apiGet() : mixed
- PX=api.*を投げる
- sitemap_children_params() : mixed
- get_children() へ渡されるオプションを調整する この形式のオプションは、get_bros(), get_bros_next(), get_bros_prev(), get_next(), get_prev() でも共通です。
Properties
$main
private
mixed
$main
$options
private
mixed
$options
$path_entry_script
private
mixed
$path_entry_script
Methods
__construct()
Constructor
public
__construct(mixed $main, mixed $path_entry_script, mixed $options) : mixed
Parameters
- $main : mixed
- $path_entry_script : mixed
- $options : mixed
Return values
mixed —bind_dynamic_path_param()
ダイナミックパスに値をバインドする
public
bind_dynamic_path_param(mixed $path, mixed $param) : mixed
Parameters
- $path : mixed
- $param : mixed
Return values
mixed —clearcache()
キャッシュを削除する
public
clearcache([mixed $opt = array() ]) : mixed
Parameters
- $opt : mixed = array()
Return values
mixed —get_actors()
Actor のページID一覧を取得する
public
get_actors(mixed $path) : mixed
Parameters
- $path : mixed
Return values
mixed —get_breadcrumb_array()
パンくず配列を取得する
public
get_breadcrumb_array(mixed $path) : mixed
Parameters
- $path : mixed
Return values
mixed —get_bros()
兄弟ページの一覧を取得する
public
get_bros(mixed $path[, mixed $options = array() ]) : mixed
Parameters
- $path : mixed
- $options : mixed = array()
Return values
mixed —get_bros_next()
次の兄弟ページを取得する
public
get_bros_next(mixed $path[, mixed $options = array() ]) : mixed
Parameters
- $path : mixed
- $options : mixed = array()
Return values
mixed —get_bros_prev()
前の兄弟ページを取得する
public
get_bros_prev(mixed $path[, mixed $options = array() ]) : mixed
Parameters
- $path : mixed
- $options : mixed = array()
Return values
mixed —get_children()
子階層のページの一覧を取得する
public
get_children(mixed $path[, mixed $options = array() ]) : mixed
Parameters
- $path : mixed
- $options : mixed = array()
Return values
mixed —get_config()
configデータを取得する
public
get_config() : mixed
Return values
mixed —get_directory_index()
directory_index(省略できるファイル名) の一覧を得る
public
get_directory_index() : mixed
Return values
mixed —get_directory_index_primary()
最も優先されるインデックスファイル名を得る
public
get_directory_index_primary() : mixed
Return values
mixed —get_domain()
domain を取得する
public
get_domain() : mixed
Return values
mixed —get_dynamic_path_info()
ダイナミックパス情報を得る
public
get_dynamic_path_info(mixed $path) : mixed
Parameters
- $path : mixed
Return values
mixed —get_next()
次のページを取得する
public
get_next(mixed $path[, mixed $options = array() ]) : mixed
Parameters
- $path : mixed
- $options : mixed = array()
Return values
mixed —get_page_info()
pathまたはidからページ情報を得る
public
get_page_info(mixed $path) : mixed
Parameters
- $path : mixed
Return values
mixed —get_parent()
親ページのIDを取得する
public
get_parent(mixed $path) : mixed
Parameters
- $path : mixed
Return values
mixed —get_path_content()
get content path
public
get_path_content(mixed $path) : mixed
Parameters
- $path : mixed
Return values
mixed —get_path_controot()
コンテンツルートディレクトリのパス(=install path) を取得する
public
get_path_controot() : mixed
Return values
mixed —get_path_docroot()
DOCUMENT_ROOT のパスを取得する (deprecated)
public
get_path_docroot() : mixed
get_path_docroot() は 非推奨のメソッドです。
代わりに、 get_realpath_docroot() を使用してください。
Return values
mixed —get_path_homedir()
get home directory path (deprecated)
public
get_path_homedir() : mixed
get_path_homedir() は 非推奨のメソッドです。
代わりに、 get_realpath_homedir() を使用してください。
Return values
mixed —get_path_proc_type()
ファイルの処理方法を調べる
public
get_path_proc_type(mixed $path) : mixed
Parameters
- $path : mixed
Return values
mixed —get_prev()
前のページを取得する
public
get_prev(mixed $path[, mixed $options = array() ]) : mixed
Parameters
- $path : mixed
- $options : mixed = array()
Return values
mixed —get_realpath_docroot()
DOCUMENT_ROOT のパスを取得する
public
get_realpath_docroot() : mixed
Return values
mixed —get_realpath_homedir()
get home directory path
public
get_realpath_homedir() : mixed
Return values
mixed —get_role()
role を取得する
public
get_role(F $path) : mixed
Parameters
- $path : F
Return values
mixed —get_sitemap()
サイトマップデータを取得する
public
get_sitemap() : mixed
Return values
mixed —get_version()
バージョン番号を取得する
public
get_version() : mixed
Return values
mixed —href()
リンク先のパスを生成する
public
href(mixed $path_linkto) : mixed
Parameters
- $path_linkto : mixed
Return values
mixed —is_ignore_path()
除外ファイルか調べる
public
is_ignore_path(mixed $path) : mixed
Parameters
- $path : mixed
Return values
mixed —is_match_dynamic_path()
パスがダイナミックパスにマッチするか調べる
public
is_match_dynamic_path(mixed $path) : mixed
Parameters
- $path : mixed
Return values
mixed —is_page_in_breadcrumb()
ページが、パンくず内に存在しているか調べる
public
is_page_in_breadcrumb(mixed $path, mixed $path_in) : mixed
Parameters
- $path : mixed
- $path_in : mixed
Return values
mixed —path_files()
ローカルリソースディレクトリのパスを得る
public
path_files(mixed $path[, mixed $path_resource = null ]) : mixed
Parameters
- $path : mixed
- $path_resource : mixed = null
Return values
mixed —path_files_cache()
ローカルリソースのキャッシュディレクトリのパスを得る
public
path_files_cache(mixed $path[, mixed $path_resource = null ]) : mixed
Parameters
- $path : mixed
- $path_resource : mixed = null
Return values
mixed —publish()
パブリッシュする
public
publish([mixed $opt = array() ]) : mixed
Parameters
- $opt : mixed = array()
Return values
mixed —px_command()
PXコマンドを実行する
public
px_command(mixed $cmd, mixed $path, mixed $param) : mixed
Parameters
- $cmd : mixed
- $path : mixed
- $param : mixed
Return values
mixed —query()
Pickles 2 にクエリを投げて、結果を受け取る (汎用)
public
query(mixed $request_path[, mixed $options = null ][, mixed &$return_var = null ]) : mixed
Parameters
- $request_path : mixed
- $options : mixed = null
- $return_var : mixed = null
Return values
mixed —realpath_files()
ローカルリソースディレクトリのサーバー内部パスを得る
public
realpath_files(mixed $path[, mixed $path_resource = null ]) : mixed
Parameters
- $path : mixed
- $path_resource : mixed = null
Return values
mixed —realpath_files_cache()
ローカルリソースのキャッシュディレクトリのサーバー内部パスを得る
public
realpath_files_cache(mixed $path[, mixed $path_resource = null ]) : mixed
Parameters
- $path : mixed
- $path_resource : mixed = null
Return values
mixed —realpath_files_private_cache()
コンテンツ別の非公開キャッシュディレクトリのサーバー内部パスを得る
public
realpath_files_private_cache(mixed $path[, mixed $path_resource = null ]) : mixed
Parameters
- $path : mixed
- $path_resource : mixed = null
Return values
mixed —apiGet()
PX=api.*を投げる
protected
apiGet(mixed $cmd[, mixed $path = '/' ][, mixed $param = array() ]) : mixed
Parameters
- $cmd : mixed
- $path : mixed = '/'
- $param : mixed = array()
Return values
mixed —sitemap_children_params()
get_children() へ渡されるオプションを調整する この形式のオプションは、get_bros(), get_bros_next(), get_bros_prev(), get_next(), get_prev() でも共通です。
private
sitemap_children_params([mixed $options = array() ]) : mixed
Parameters
- $options : mixed = array()