System Class Reference

Public Member Functions
	adminVersion ($version, $value= '')
	checkRight ()
	cleanCache ($cache)
	cleanVars (&$global, $key, $default= '', $type= 'int')
	loadLanguage ($name, $domain= '', $language=null)

Static Public Member Functions
static	getInstance ()

Public Attributes
	$module = null

Private Member Functions
	__construct ()

Private Attributes
	$xoops = null

Detailed Description

Definition at line 20 of file system.php.

Constructor & Destructor Documentation

System::__construct ( )

private

Actual System Module

Definition at line 36 of file system.php.

References Xoops\getInstance().

Here is the call graph for this function:

Member Function Documentation

System::adminVersion	(		$version,
			$value = ''
	)

Parameters

string	$version
string	$value

Returns

string

Definition at line 138 of file system.php.

References $modversion, $path, $xoops, XoopsLoad\fileExists(), and Xoops\getInstance().

Here is the call graph for this function:

System::checkRight

(

)

Returns

bool

Definition at line 59 of file system.php.

System::cleanCache

(

$cache

)

System Clean cache 'xoops_data/caches/'

Parameters

integer[]

$cache cache caches to be cleaned 1 = Smarty cache 2 = Smarty compile 3 = cache

Note: clearing of the actual cache is now handled by the cache system. Only the 'default' cache is cleaned by this function. This function returns only a boolean status, not a count as done before.

The old behavior of cleaning the directory is maintained, but does not clean the actual cache, only artifacts of legacy programs that write files directly in the xoops_cache folder.

Returns

array|false associative array of status/count for each cache

Definition at line 174 of file system.php.

References $files, $i, $status, XoopsBaseConfig\get(), and Xoops\getInstance().

Here is the call graph for this function:

System::cleanVars	(	&	$global,
			$key,
			$default = '',
			$type = 'int'
	)

Parameters

	$global
	$key
string	$default
string	$type

Returns

int|mixed|string

Definition at line 79 of file system.php.

References $type.

static System::getInstance ( )

static

Access the only instance of this class

Returns

System

Definition at line 46 of file system.php.

Referenced by b_system_main_edit(), XcaptchaImage\VerifyData(), XcaptchaRecaptcha\VerifyData(), XcaptchaText\VerifyData(), and Xcaptcha\VerifyData().

Here is the caller graph for this function:

System::loadLanguage	(		$name,
			$domain = '',
			$language = null
	)

System language loader wrapper

Parameters

string	$name	Name of language file to be loaded, without extension
string	$domain	Module dirname; global language file will be loaded if $domain is set to 'global' or not specified
string	$language	Language to be loaded, current language content will be loaded if not specified

Returns

boolean

Todo:

expand domain to multiple categories, e.g. module:system, framework:filter, etc.

We must check later for an empty value. As xoops_getPageOption could be empty

Definition at line 114 of file system.php.

References $file, $language, $name, $path, $xoops, XoopsLoad\fileExists(), and Xoops\getInstance().

Here is the call graph for this function:

Member Data Documentation

System::$module = null

Definition at line 26 of file system.php.

System::$xoops = null

private

Definition at line 31 of file system.php.

Referenced by adminVersion(), and loadLanguage().

---

The documentation for this class was generated from the following file:

• C:/usr64/htdocs/modules/system/class/system.php