Functions
	parseXml ($aXmlTemplates)

	makeGroup ($sXmlContent, $sXmlGroup="ray")

	setSettingValue ($sWidget, $sSettingKey, $sSettingValue, $sFile="config")

	getSettingValue ($sWidget, $sSettingKey, $sFile="config", $bFullReturn=false, $sFolder="xml")

	getWMode ()

	getRMSUrl ($sApplication, $bHttp=false)

	useServer ()

	getOnline ($aRange=array(), $bInRange=true)

	getExtraFiles ($sModule, $sFolder="langs", $bGetUserFile=true, $bGetDate=false)

	setCurrentFile ($sModule, $sFile, $sFolder="langs")

	printFiles ($sModule, $sFolder="langs", $bGetDate=false, $bGetNames=false)

	moveMp4Meta ($sFilePath)

Function Documentation

◆ getExtraFiles()

getExtraFiles	(	$sModule,
		$sFolder = `"langs"`,
		$bGetUserFile = `true`,
		$bGetDate = `false`
	)

------------— GET/SET Language/Skin Functions ------------— get extra files list for given module

Parameters

$sModule	- module name
$sFolder	- folder name where to look for files
$bGetUserFile	- get current user file (true) or default file (false)
$bGetDate	- get dates of files

Returns: $aResult - files array without extension and/or current file

Definition at line 168 of file apiFunctions.inc.php.

◆ getOnline()

getOnline	(	$aRange = `array()`,
		$bInRange = `true`
	)

------------— Online Users Retrieving and Updating Functions ------------— get online users

Parameters

aRange	- users IDs range to select from
$bInRange	- get users that in(not in) range

Definition at line 141 of file apiFunctions.inc.php.

◆ getRMSUrl()

getRMSUrl	(	$sApplication,
		$bHttp = `false`
	)

return RMS Url to given application

Parameters

sApplication - application name.

Returns: sRMSUrl - RMS Url.

Definition at line 116 of file apiFunctions.inc.php.

◆ getSettingValue()

getSettingValue	(	$sWidget,
		$sSettingKey,
		$sFile = `"config"`,
		$bFullReturn = `false`,
		$sFolder = `"xml"`
	)

Gets setting value from config.xml file.

Parameters

sWidget	- widget's name.
$sSettingKey	- setting's key.

Definition at line 82 of file apiFunctions.inc.php.

◆ getWMode()

getWMode ( )

Definition at line 106 of file apiFunctions.inc.php.

◆ makeGroup()

makeGroup	(	$sXmlContent,
		$sXmlGroup = `"ray"`
	)

Group specified content.

Parameters

sXmlContent	- content to be grouped.
sXmlGroup	- group name.

Definition at line 32 of file apiFunctions.inc.php.

◆ moveMp4Meta()

moveMp4Meta ( $sFilePath )

Definition at line 268 of file apiFunctions.inc.php.

◆ parseXml()

parseXml ( $aXmlTemplates )

This work, "Cheetah - https://www.cheetahwsb.com", is a derivative of "Dolphin Pro V7.4.2" by BoonEx Pty Limited - https://www.boonex.com/, used under CC-BY. "Cheetah" is licensed under CC-BY by Dean J. Bassett Jr. CC-BY License - http://creativecommons.org/licenses/by/3.0/ ------------— XML Retrieving and Formatting Functions ------------— Parse XML template using specified information.

Parameters

aXmlTemplates	- array with XML templates grouped by type.
...	- variable amount of incoming parameters with information to be used in the process of parsing.

Returns: $sContent - XML entry

Definition at line 15 of file apiFunctions.inc.php.

◆ printFiles()

printFiles	(	$sModule,
		$sFolder = `"langs"`,
		$bGetDate = `false`,
		$bGetNames = `false`
	)

get extra files for module in XML format

Parameters

$sModule	- module name
$sFolder	- folder name for which value is set
$bGetDate	- get dates of files

Returns: $sContents - XML formatted result

Definition at line 224 of file apiFunctions.inc.php.

◆ setCurrentFile()

setCurrentFile	(	$sModule,
		$sFile,
		$sFolder = `"langs"`
	)

set current file for module to cookie

Parameters

$sModule	- module name
$sFile	- file value
$sFolder	- folder name for which value is set

Definition at line 212 of file apiFunctions.inc.php.

◆ setSettingValue()

setSettingValue	(	$sWidget,
		$sSettingKey,
		$sSettingValue,
		$sFile = `"config"`
	)

Saves setting value in the config.xml file of the specified widget.

Parameters

sWidget	- widget's name.
$sSettingKey	- setting's key.
sSettingValue	- new value for specified setting.

Definition at line 43 of file apiFunctions.inc.php.

◆ useServer()

useServer ( )

is server turned on

Returns: bTurned

Definition at line 129 of file apiFunctions.inc.php.