config
in package
PX Commands "config"
- PX=config
- Pickles Framework 2 の設定情報を表示します。
Table of Contents
- $conf : mixed
- 設定オブジェクト
- $px : mixed
- Picklesオブジェクト
- __construct() : mixed
- constructor
- register() : mixed
- Starting function
- h() : string
- HTML特殊文字をエスケープする。
- kick() : mixed
- kick
- mk_config_unit() : string
- コンフィグ項目1件を出力する。
Properties
$conf
設定オブジェクト
private
mixed
$conf
$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 —h()
HTML特殊文字をエスケープする。
private
h(string $txt) : string
このメソッドは改行コードを改行タグ <br /> に変換します。
Parameters
- $txt : string
-
文字列
Return values
string —HTML特殊文字がエスケープされた文字列
kick()
kick
private
kick() : mixed
Return values
mixed —mk_config_unit()
コンフィグ項目1件を出力する。
private
mk_config_unit(string $key, string $label[, string $type = 'string' ][, bool $required = false ]) : string
Parameters
- $key : string
-
コンフィグのキー
- $label : string
-
コンフィグラベル
- $type : string = 'string'
-
値に期待される型
- $required : bool = false
-
必須項目の場合
true、それ以外はfalse
Return values
string —コンフィグ1件分のHTMLソース(trタグ)