Functions
	XH_pluginVersion ($plugin)
	Returns the readable version of a plugin. More...

	XH_systemCheck (array $data)
	Returns the result view of the system check. More...

	XH_systemCheckLi ($class, $state, $text)
	Returns a single `<li>` of the system check. More...

	XH_absoluteUrlPath ($path)
	Returns the normalized absolute URL path. More...

	XH_isAccessProtected ($path)
	Returns whether a resource is access protected. More...

	XH_sysinfo ()
	Returns the system information view. More...

	XH_settingsView ()
	Returns the general settings view. More...

	XH_logFileView ()
	Returns the log file view. More...

	XH_backupsView ()
	Returns the backup view. More...

	XH_pluginsView ()
	Returns the plugins view. More...

	pluginMenu ($add='', $link='', $target='', $text='', array $style=array())
	Creates the menu of a plugin (add row, add tab), constructed as a table. More...

	XH_registerStandardPluginMenuItems ($showMain)
	Registers the standard plugin menu items for the admin menu. More...

	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. More...

	XH_adminMenu (array $plugins=array())
	Returns the admin menu. More...

	XH_adminMenuItem (array $item, $level=0)
	Returns the LI element of an admin menu item. More...

	print_plugin_admin ($main)
	Returns the plugin menu. More...

	plugin_admin_common ()
	Handles reading and writing of plugin files (e.g. More...

	XH_contentEditor ()
	Returns the content editor and activates it. More...

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

	XH_saveEditorContents ($text)
	Saves content.htm after submitting changes from the content editor. More...

	XH_emptyContents ()
	Empties the contents. More...

	XH_restore ($filename)
	Restores a content backup. More...

	XH_extraBackup ($suffix)
	Creates an extra backup of the contents file. More...

	XH_adminJSLocalization ()
	Returns SCRIPT element containing the localization for admin.min.js. More...

	XH_wantsPluginAdministration ($pluginName)
	Returns whether the administration of a certain plugin is requested. More...

Detailed Description

Admin only functions.

Author: Peter Harteg peter.nosp@m.@har.nosp@m.teg.d.nosp@m.k; The CMSimple_XH developers devs@.nosp@m.cmsi.nosp@m.mple-.nosp@m.xh.o.nosp@m.rg

Copyright: 1999-2009 Peter Harteg; 2009-2023 The CMSimple_XH developers https://www.cmsimple-xh.org/?About-CMSimple_XH/The-XH-Team; GNU GPLv3 http://www.gnu.org/licenses/gpl-3.0.en.html

Function Documentation

◆ plugin_admin_common()

plugin_admin_common ( )

Handles reading and writing of plugin files (e.g.

en.php, config.php, stylesheet.css).

Returns: string Returns the created form or the result of saving the data.

◆ 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.

Parameters

string	$add	Add a ROW, a TAB or DATA (Userdefineable content). SHOW will return the menu.
string	$link	The link, the TAB will lead to.
string	$target	Target of the link (with(!) 'target=').
string	$text	Description of the TAB.
array	$style	Array with style-data for the containing table-cell

Returns: mixed

◆ print_plugin_admin()

print_plugin_admin ( $main )

Returns the plugin menu.

Parameters

string $main Whether the main setting menu item should be shown ('ON'/'OFF').

Returns: string HTML

◆ XH_absoluteUrlPath()

XH_absoluteUrlPath ( $path )

Returns the normalized absolute URL path.

Parameters

string $path A relative path.

Returns: string

Since: 1.6.1

◆ XH_adminJSLocalization()

XH_adminJSLocalization ( )

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

Returns: string HTML

Since: 1.6

◆ XH_adminMenu()

XH_adminMenu ( array $plugins = array() )

Returns the admin menu.

Parameters

array $plugins A list of plugins.

Returns: string HTML

Since: 1.6

◆ XH_adminMenuItem()

XH_adminMenuItem	(	array	$item,
			$level = `0`
	)

Returns the LI element of an admin menu item.

Parameters

array	$item	The menu item.
int	$level	The level of the menu item.

Returns: string

Since: 1.6

◆ XH_backupsView()

XH_backupsView ( )

Returns the backup view.

Returns: string HTML

Since: 1.6

◆ XH_contentEditor()

XH_contentEditor ( )

Returns the content editor and activates it.

Returns: string HTML

Since: 1.6

◆ XH_emptyContents()

XH_emptyContents ( )

Empties the contents.

Returns: void

◆ XH_extraBackup()

XH_extraBackup ( $suffix )

Creates an extra backup of the contents file.

Parameters

string $suffix A suffix for the filename.

Returns: void

Since: 1.6

◆ XH_isAccessProtected()

XH_isAccessProtected ( $path )

Returns whether a resource is access protected.

Parameters

string $path A normalized absolute URL path.

Returns: bool

Since: 1.6.1

◆ XH_logFileView()

XH_logFileView ( )

Returns the log file view.

Returns: string HTML

Since: 1.6

◆ XH_pluginsView()

XH_pluginsView ( )

Returns the plugins view.

Returns: string HTML

Since: 1.7

◆ XH_pluginVersion()

XH_pluginVersion ( $plugin )

Returns the readable version of a plugin.

Parameters

string $plugin Name of a plugin.

Returns: string

Since: 1.6

◆ 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.

Parameters

string	$plugin	A plugin name.
string	$label	A menu item label.
string	$url	A URL to link to.
string	$target	A target attribute value.

Returns: mixed

Since: 1.6.2

◆ XH_registerStandardPluginMenuItems()

XH_registerStandardPluginMenuItems ( $showMain )

Registers the standard plugin menu items for the admin menu.

Parameters

bool $showMain Whether to display the main settings item.

Returns: void

Since: 1.6.2

◆ XH_restore()

XH_restore ( $filename )

Restores a content backup.

The current content.htm is backed up before.

Parameters

string $filename The filename.

Returns: void

Since: 1.6

◆ XH_saveContents()

XH_saveContents ( )

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

Returns: bool Whether that succeeded

Since: 1.6

◆ XH_saveEditorContents()

XH_saveEditorContents ( $text )

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

Parameters

string $text The text to save.

Returns: void

Since: 1.6

◆ XH_settingsView()

XH_settingsView ( )

Returns the general settings view.

Returns: string HTML

Since: 1.6

◆ XH_sysinfo()

XH_sysinfo ( )

Returns the system information view.

Returns: string HTML

Since: 1.6

◆ XH_systemCheck()

XH_systemCheck ( array $data )

Returns the result view of the system check.

Parameters

array $data The data ;)

Returns: string HTML

See also: http://www.cmsimple-xh.org/wiki/doku.php/plugin_interfaces#system_check

Since: 1.5.4

◆ XH_systemCheckLi()

XH_systemCheckLi	(	$class,
		$state,
		$text
	)

Returns a single <li> of the system check.

Parameters

string	$class	A CSS class.
string	$state	A state.
string	$text	A message text.

Returns: string

Since: 1.7.0

◆ XH_wantsPluginAdministration()

XH_wantsPluginAdministration ( $pluginName )

Returns whether the administration of a certain plugin is requested.

Parameters

string $pluginName A plugin name.

Returns: bool

Since: 1.6.3

Functions

Detailed Description

Function Documentation

◆ plugin_admin_common()

◆ pluginMenu()

◆ print_plugin_admin()

◆ XH_absoluteUrlPath()

◆ XH_adminJSLocalization()

◆ XH_adminMenu()

◆ XH_adminMenuItem()

◆ XH_backupsView()

◆ XH_contentEditor()

◆ XH_emptyContents()

◆ XH_extraBackup()

◆ XH_isAccessProtected()

◆ XH_logFileView()

◆ XH_pluginsView()

◆ XH_pluginVersion()

◆ XH_registerPluginMenuItem()

◆ XH_registerStandardPluginMenuItems()

◆ XH_restore()

◆ XH_saveContents()

◆ XH_saveEditorContents()

◆ XH_settingsView()

◆ XH_sysinfo()

◆ XH_systemCheck()

◆ XH_systemCheckLi()

◆ XH_wantsPluginAdministration()