CMSimple_XH 開発者ドキュメント
XH\ArrayFileEdit クラス
XH\ArrayFileEdit の継承関係図
XH\FileEdit XH\CoreArrayFileEdit XH\PluginArrayFileEdit XH\CoreConfigFileEdit XH\CoreLangFileEdit XH\PluginConfigFileEdit XH\PluginLanguageFileEdit

公開メンバ関数

 __construct ()
 
 form ()
 
 submit ()
 
- 基底クラス XH\FileEdit に属する継承公開メンバ関数
 form ()
 
 submit ()
 

限定公開メンバ関数

 save ()
 
 translate ($key)
 
 splitKey ($key)
 
 hasVisibleFields (array $options, $advanced)
 
 formField ($cat, $name, array $opt)
 
 renderFormFields ($advanced)
 
 option ($mcf, $val, $hint)
 
- 基底クラス XH\FileEdit に属する継承限定公開メンバ関数
 save ()
 
 asString ()
 

限定公開変数類

 $cfg = null
 
 $lang = null
 
 $metaLangFile
 
- 基底クラス XH\FileEdit に属する継承限定公開変数類
 $params = array()
 
 $plugin = null
 
 $caption = null
 
 $filename = null
 
 $redir = null
 

詳解

ArrayFileEdit.php28 行目に定義があります。

構築子と解体子

◆ __construct()

XH\ArrayFileEdit::__construct ( )

Construct an instance

ArrayFileEdit.php57 行目に定義があります。

関数詳解

◆ form()

XH\ArrayFileEdit::form ( )

Returns the form to edit the file contents.

戻り値
string HTML

string The script name. array The localization of the core. string The title of the current page. object The CSRF protection object.

ArrayFileEdit.php215 行目に定義があります。

◆ formField()

XH\ArrayFileEdit::formField (   $cat,
  $name,
array  $opt 
)
protected

Returns a form field.

引数
string$catThe category.
string$nameThe name.
array$optThe field options.
戻り値
string HTML

array The localization of the core.

ArrayFileEdit.php152 行目に定義があります。

◆ hasVisibleFields()

XH\ArrayFileEdit::hasVisibleFields ( array  $options,
  $advanced 
)
protected

Returns whether all options are hidden.

引数
array$optionsThe list of options.
bool$advancedWhether normal or advanced fields are to be checked.
戻り値
bool

ArrayFileEdit.php129 行目に定義があります。

◆ option()

XH\ArrayFileEdit::option (   $mcf,
  $val,
  $hint 
)
protected

Returns an option array.

引数
string$mcfThe meta config of the option.
mixed$valThe current value of the option.
string$hintA hint for the option usage.
戻り値
array

ArrayFileEdit.php344 行目に定義があります。

◆ renderFormFields()

XH\ArrayFileEdit::renderFormFields (   $advanced)
protected

Renders the form fields grouped by category.

引数
bool$advancedWhether to render the normal or the advanced fields.
戻り値
string HTML

ArrayFileEdit.php253 行目に定義があります。

◆ save()

XH\ArrayFileEdit::save ( )
protected

Saves the file and returns whether that succeeded. Invalidates the cached file, if OPcache is enabled.

戻り値
bool

ArrayFileEdit.php74 行目に定義があります。

◆ splitKey()

XH\ArrayFileEdit::splitKey (   $key)
protected

Returns a key split to category and rest.

引数
string$keyThe original key.
戻り値
array

ArrayFileEdit.php110 行目に定義があります。

◆ submit()

XH\ArrayFileEdit::submit ( )

Handles the form submission.

Triggers a redirect, if the submission was valid and the file could be successfully saved. Otherwise writes an error message to $e, and returns the edit form.

戻り値
string HTML

string Error messages. object The CSRF protection object.

ArrayFileEdit.php305 行目に定義があります。

◆ translate()

XH\ArrayFileEdit::translate (   $key)
protected

Returns the localization of the given config or language key.

引数
string$keyA config or language key.
戻り値
string

ArrayFileEdit.php90 行目に定義があります。


このクラス詳解は次のファイルから抽出されました: