CMSimple_XH 開発者ドキュメント
adminfuncs.php ファイル

[ソースコード]

名前空間

 XH
 

関数

 XH_pluginVersion ($plugin)
 
 XH_systemCheck (array $data)
 
 XH_systemCheckLi ($class, $state, $text)
 
 XH_absoluteUrlPath ($path)
 
 XH_isAccessProtected ($path)
 
 XH_sysinfo ()
 
 XH_settingsView ()
 
 XH_logFileView ()
 
 XH_backupsView ()
 
 XH_pluginsView ()
 
 pluginMenu ($add='', $link='', $target='', $text='', array $style=array())
 
 XH_registerStandardPluginMenuItems ($showMain)
 
 XH_registerPluginMenuItem ($plugin, $label=null, $url=null, $target=null)
 
 XH_adminMenu (array $plugins=array())
 
 XH_adminMenuItem (array $item, $level=0)
 
 print_plugin_admin ($main)
 
 plugin_admin_common ()
 
 XH_contentEditor ()
 
 XH_saveContents ()
 
 XH_saveEditorContents ($text)
 
 XH_emptyContents ()
 
 XH_restore ($filename)
 
 XH_extraBackup ($suffix)
 
 XH_adminJSLocalization ()
 
 XH_wantsPluginAdministration ($pluginName)
 

詳解

Admin only functions.

adminfuncs.php に定義があります。

関数詳解

◆ plugin_admin_common()

plugin_admin_common ( )

プラグインのファイルの読み書き (例 en.php, config.php, stylesheet.css).
Handles reading and writing of plugin files (e.g. en.php, config.php, stylesheet.css).

string The requested action. string The requested admin-action.

戻り値
string Returns the created form or the result of saving the data.

adminfuncs.php828 行目に定義があります。

◆ pluginMenu()

pluginMenu (   $add = '',
  $link = '',
  $target = '',
  $text = '',
array  $style = array() 
)

Creates the menu of a plugin (add row, add tab), constructed as a table. This is an object implemented with a procedural interface.

引数
string$addAdd a ROW, a TAB or DATA (Userdefineable content). SHOW will return the menu.
string$linkThe link, the TAB will lead to.
string$targetTarget of the link (with(!) 'target=').
string$textDescription of the TAB.
array$styleArray with style-data for the containing table-cell
戻り値
mixed

XH The plugin menu builder.

adminfuncs.php535 行目に定義があります。

◆ print_plugin_admin()

print_plugin_admin (   $main)

Returns the plugin menu.
onでadmin=plugin_main のタブメニューが追加される。
$plugin_tx['プラグイン名']['menu_main']が設定されいれば使用され、無ければ ~mainと表示される・

プラグインのメニューのトップと同じ内容を表示する場合 例えば
  if ($admin == '' || $admin == 'plugin_main') { $o .= ...

引数
string$mainWhether the main setting menu item should be shown ('ON'/'OFF').
戻り値
string HTML

XH The plugin menu builder.

adminfuncs.php812 行目に定義があります。

◆ XH_absoluteUrlPath()

XH_absoluteUrlPath (   $path)

正規化された絶対URLパスを返します
Returns the normalized absolute URL path.

引数
string$pathA relative path.
戻り値
string

string The script name.

から
1.6.1

adminfuncs.php157 行目に定義があります。

◆ XH_adminJSLocalization()

XH_adminJSLocalization ( )

Returns SCRIPT element containing the localization for admin.min.js.

戻り値
string HTML

array The localization of the core.

から
1.6

adminfuncs.php1142 行目に定義があります。

◆ XH_adminMenu()

XH_adminMenu ( array  $plugins = array())

Returns the admin menu.

引数
array$pluginsA list of plugins.
戻り値
string HTML

string The scipt name. bool Whether edit mode is active. int The index of the current page. array The URLs of the pages. array The configuration of the core. array The localization of the core. string The URL of the current page. array The localization of the plugins.

から
1.6

adminfuncs.php622 行目に定義があります。

◆ XH_adminMenuItem()

XH_adminMenuItem ( array  $item,
  $level = 0 
)

Returns the LI element of an admin menu item.

引数
array$itemThe menu item.
int$levelThe level of the menu item.
戻り値
string
から
1.6

adminfuncs.php765 行目に定義があります。

◆ XH_backupsView()

XH_backupsView ( )

Returns the backup view.

戻り値
string HTML

array The paths of system files and folders. array The script name. array The localization of the core. object The CSRF protection object.

から
1.6

adminfuncs.php427 行目に定義があります。

◆ XH_contentEditor()

XH_contentEditor ( )

Returns the content editor and activates it.

string The script name. string The currently active page URL. int The index of the currently active page. array The URLs of the pages. array The content of the pages. string Error messages as HTML fragment consisting of LI Elements. array The configuration of the core. array The localization of the core. object The CSRF protection object.

戻り値
string HTML
から
1.6

adminfuncs.php875 行目に定義があります。

◆ XH_emptyContents()

XH_emptyContents ( )

Empties the contents.

戻り値
void

array The content of the pages. int The number of pages. array The paths of system files and folders. array An HTML fragment with error messages. object The pagedata router.

adminfuncs.php1049 行目に定義があります。

◆ XH_extraBackup()

XH_extraBackup (   $suffix)

Creates an extra backup of the contents file.

引数
string$suffixA suffix for the filename.
戻り値
void
から
1.6

adminfuncs.php1118 行目に定義があります。

◆ XH_isAccessProtected()

XH_isAccessProtected (   $path)

Returns whether a resource is access protected.

引数
string$pathA normalized absolute URL path.
戻り値
bool
から
1.6.1

adminfuncs.php190 行目に定義があります。

◆ XH_logFileView()

XH_logFileView ( )

Returns the log file view.

戻り値
string HTML

array The paths of system files and folders. array The localization of the core. string The title of the current page.

から
1.6

adminfuncs.php392 行目に定義があります。

◆ XH_pluginsView()

XH_pluginsView ( )

Returns the plugins view.

戻り値
string HTML

array The script name. array The configuration of the core array The localization of the core.

から
1.7

adminfuncs.php496 行目に定義があります。

◆ XH_pluginVersion()

XH_pluginVersion (   $plugin)

Returns the readable version of a plugin.

引数
string$pluginName of a plugin.
戻り値
string

array The paths of system files and folders.

から
1.6

adminfuncs.php29 行目に定義があります。

◆ XH_registerPluginMenuItem()

XH_registerPluginMenuItem (   $plugin,
  $label = null,
  $url = null,
  $target = null 
)

Register a new plugin menu item, or returns the registered plugin menu items, if $label and $url are null.

引数
string$pluginA plugin name.
string$labelA menu item label.
string$urlA URL to link to.
string$targetA target attribute value.
戻り値
mixed

array $pluginMenu The array of already registered menu items.

から
1.6.2

adminfuncs.php585 行目に定義があります。

◆ XH_registerStandardPluginMenuItems()

XH_registerStandardPluginMenuItems (   $showMain)

管理メニューのための標準的なプラグインのメニュー項目(プルダウンメニュー)の表示/非表示。

 XH_registerStandardPluginMenuItems(true)でデフォルトのプルダウンメニューが自動(強制)表示。
 XH_registerStandardPluginMenuItems(off)で翻訳ファイルに['menu_****]があればそのメニュー表示される

Registers the standard plugin menu items for the admin menu.

引数
bool$showMainWhether to display the main settings item.
戻り値
void
から
1.6.2

adminfuncs.php564 行目に定義があります。

◆ XH_restore()

XH_restore (   $filename)

Restores a content backup. The current content.htm is backed up before.

引数
string$filenameThe filename.
戻り値
void

array The paths of system files and folders. array An HTML fragment with error messages.

から
1.6

adminfuncs.php1083 行目に定義があります。

◆ XH_saveContents()

XH_saveContents ( )

Saves the current contents (including the page data), if edit mode is active.

戻り値
bool Whether that succeeded

array The content of the pages. array The paths of system files and folders. array The localization of the core. array Whether edit mode is active. object The page data router.

から
1.6

adminfuncs.php928 行目に定義があります。

◆ XH_saveEditorContents()

XH_saveEditorContents (   $text)

Saves content.htm after submitting changes from the content editor.

引数
string$textThe text to save.

array The paths of system files and folders. array The configuation of the core. array The localization of the core. object The page data router. array The content of the pages. int The index of the active page. array The URLs of the pages. string The URL of the active page.

戻り値
void
から
1.6

adminfuncs.php976 行目に定義があります。

◆ XH_settingsView()

XH_settingsView ( )

Returns the general settings view.

戻り値
string HTML

string The script name. array The localization of the core.

から
1.6

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

◆ XH_sysinfo()

XH_sysinfo ( )

Returns the system information view.

array The paths of system files and folders. array The configuration of the core. array The localization of the core. string The script name.

戻り値
string HTML
から
1.6

adminfuncs.php218 行目に定義があります。

◆ XH_systemCheck()

XH_systemCheck ( array  $data)

Returns the result view of the system check.

引数
array$dataThe data ;)

array The localization of the core.

戻り値
string HTML

1.5.4

adminfuncs.php64 行目に定義があります。

◆ XH_systemCheckLi()

XH_systemCheckLi (   $class,
  $state,
  $text 
)

Returns a single <li> of the system check.

引数
string$classA CSS class.
string$stateA state.
string$textA message text.

array The localization of the core.

戻り値
string
から
1.7.0

adminfuncs.php136 行目に定義があります。

◆ XH_wantsPluginAdministration()

XH_wantsPluginAdministration (   $pluginName)

Returns whether the administration of a certain plugin is requested.

引数
string$pluginNameA plugin name.
戻り値
bool
から
1.6.3

adminfuncs.php1172 行目に定義があります。