Pickles Framework v2.1.19 API Document

api
in package

PX Commands "api"

[API] api.get.*

PX=api.get.version
Pickles Framework のバージョン番号を取得します。
PX=api.get.config
設定オブジェクトを取得します。
<dt>PX=api.get.sitemap</dt>
	<dd>サイトマップ全体の配列を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.sitemap_definition</dt>
	<dd>サイトマップ定義を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.page_info&path={$path}</dt>
	<dd><code>$px->site()->get_page_info({$path})</code> の返却値を取得します。<code>$path</code>を省略した場合は、カレントページの情報を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.page_originated_csv&path={$path}</dt>
	<dd><code>$px->site()->get_page_originated_csv({$path})</code> の返却値を取得します。<code>$path</code>を省略した場合は、カレントページの情報を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.parent</dt>
	<dd><code>$px->site()->get_parent()</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.actors</dt>
	<dd><code>$px->site()->get_actors()</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.role</dt>
	<dd><code>$px->site()->get_role()</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.children&filter={$filter}</dt>
	<dd><code>$px->site()->get_children()</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.bros&filter={$filter}</dt>
	<dd><code>$px->site()->get_bros()</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.bros_next&filter={$filter}</dt>
	<dd><code>$px->site()->get_bros_next()</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.bros_prev&filter={$filter}</dt>
	<dd><code>$px->site()->get_bros_prev()</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.next&filter={$filter}</dt>
	<dd><code>$px->site()->get_next()</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.prev&filter={$filter}</dt>
	<dd><code>$px->site()->get_prev()</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.breadcrumb_array</dt>
	<dd><code>$px->site()->get_breadcrumb_array()</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.dynamic_path_info&path={$path}</dt>
	<dd><code>$px->site()->get_dynamic_path_info({$path})</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.bind_dynamic_path_param&path={$path}&param={$param}</dt>
	<dd><code>$px->site()->bind_dynamic_path_param({$path}, {$param})</code> の返却値を取得します。<code>{$param}</code> には、パラメータのキーと値の組を必要分格納したオブジェクトをJSON形式の文字列で指定します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>

<dt>PX=api.get.path_homedir</dt>
	<dd>*[非推奨]* このAPIは <code>PX=api.get.realpath_homedir</code> に改名されました。 古い名前も残されていますが、使用は推奨されません。</dd>
<dt>PX=api.get.realpath_homedir</dt>
	<dd><code>$px->get_realpath_homedir()</code> の返却値を取得します。</dd>
<dt>PX=api.get.path_controot</dt>
	<dd><code>$px->get_path_controot()</code> の返却値を取得します。</dd>
<dt>PX=api.get.path_docroot</dt>
	<dd>*[非推奨]* このAPIは <code>PX=api.get.realpath_docroot</code> に改名されました。 古い名前も残されていますが、使用は推奨されません。</dd>
<dt>PX=api.get.realpath_docroot</dt>
	<dd><code>$px->get_realpath_docroot()</code> の返却値を取得します。</dd>
<dt>PX=api.get.path_content</dt>
	<dd><code>$px->get_path_content()</code> の返却値を取得します。</dd>
<dt>PX=api.get.path_files&path_resource={$path}</dt>
	<dd><code>$px->path_files({$path})</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.realpath_files&path_resource={$path}</dt>
	<dd><code>$px->realpath_files({$path})</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.path_files_cache&path_resource={$path}</dt>
	<dd><code>$px->path_files_cache({$path})</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.realpath_files_cache&path_resource={$path}</dt>
	<dd><code>$px->realpath_files_cache({$path})</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.realpath_files_private_cache&path_resource={$path}</dt>
	<dd><code>$px->realpath_files_private_cache({$path})</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.domain</dt>
	<dd><code>$px->get_domain()</code> の返却値を取得します。</dd>
<dt>PX=api.get.directory_index</dt>
	<dd><code>$px->get_directory_index()</code> の返却値を取得します。</dd>
<dt>PX=api.get.directory_index_primary</dt>
	<dd><code>$px->get_directory_index_primary()</code> の返却値を取得します。</dd>
<dt>PX=api.get.path_proc_type</dt>
	<dd><code>$px->get_path_proc_type()</code> の返却値を取得します。</dd>
<dt>PX=api.get.href&linkto={$path_linkto}</dt>
	<dd><code>$px->href({$path_linkto})</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>
<dt>PX=api.get.canonical&linkto={$path_linkto}</dt>
	<dd><code>$px->canonical({$path_linkto})</code> の返却値を取得します。<code>$px->site()</code>が利用できない場合、<code>false</code>を返します。</dd>

[API] api.is.*

PX=api.is.match_dynamic_path&path={$path}
$px->site()->is_match_dynamic_path({$path}) の返却値を取得します。
PX=api.is.page_in_breadcrumb&path={$path}
$px->site()->is_page_in_breadcrumb({$path}) の返却値を取得します。
PX=api.is.ignore_path&path={$path}
$px->is_ignore_path({$path}) の返却値を取得します。

Table of Contents

$command  : mixed
PXコマンド名
$px  : mixed
Picklesオブジェクト
__construct()  : mixed
constructor
register()  : mixed
Starting function
api_get()  : void
[API] api.get.*
api_is()  : void
[API] api.is.*
data2json()  : string
データをJSONに加工して返す。
data2jsonp()  : string
データをJSONPに加工して返す。
data2xml()  : string
データをXMLに加工して返す。
data_convert()  : string
データを自動的に加工して返す。
error()  : void
エラーメッセージを表示する。
escape_doublequote()  : string
ダブルクオートで囲えるようにエスケープ処理する。
homepage()  : void
ホームページを表示する。
kick()  : mixed
kick
user_message()  : mixed
ユーザーへのメッセージを表示して終了する
xml_encode()  : string
変数をXML構造に変換する

Properties

$command

PXコマンド名

private mixed $command = array()

$px

Picklesオブジェクト

private mixed $px

Methods

__construct()

constructor

public __construct(object $px) : mixed
Parameters
$px : object

Picklesオブジェクト

Return values
mixed —

register()

Starting function

public static register([object $px = null ][, object $options = null ]) : mixed
Parameters
$px : object = null

Picklesオブジェクト

$options : object = null

プラグイン設定

Return values
mixed —

api_get()

[API] api.get.*

private api_get() : void

結果を標準出力した後、exit() を発行してスクリプトを終了します。

Return values
void —

api_is()

[API] api.is.*

private api_is() : void

結果を標準出力した後、exit() を発行してスクリプトを終了します。

Return values
void —

data2json()

データをJSONに加工して返す。

private data2json(mixed $val) : string
Parameters
$val : mixed

加工するデータ

Return values
string —

加工されたテキストデータ

data2jsonp()

データをJSONPに加工して返す。

private data2jsonp(mixed $val) : string
Parameters
$val : mixed

加工するデータ

Return values
string —

加工されたテキストデータ

data2xml()

データをXMLに加工して返す。

private data2xml(mixed $val) : string
Parameters
$val : mixed

加工するデータ

Return values
string —

加工されたテキストデータ

data_convert()

データを自動的に加工して返す。

private data_convert(mixed $val) : string
Parameters
$val : mixed

加工するデータ

Return values
string —

加工されたテキストデータ

error()

エラーメッセージを表示する。

private error() : void

HTMLを標準出力した後、exit() を発行してスクリプトを終了します。

Return values
void —

escape_doublequote()

ダブルクオートで囲えるようにエスケープ処理する。

private static escape_doublequote(string $text) : string
Parameters
$text : string

テキスト

Return values
string —

エスケープされたテキスト

homepage()

ホームページを表示する。

private homepage() : void

HTMLを標準出力した後、exit() を発行してスクリプトを終了します。

Return values
void —

kick()

kick

private kick() : mixed
Return values
mixed —

user_message()

ユーザーへのメッセージを表示して終了する

private user_message(string $msg) : mixed
Parameters
$msg : string

メッセージテキスト

Return values
mixed —

xml_encode()

変数をXML構造に変換する

private static xml_encode([mixed $value = null ][, array<string|int, mixed> $options = array() ]) : string
Parameters
$value : mixed = null

値

$options : array<string|int, mixed> = array()

オプション

delete_arrayelm_if_null
配列の要素が `null` だった場合に削除。
array_break
配列に適当なところで改行を入れる。
Return values
string —

XMLシンタックスに変換された値

Search results