Namespaces
	kernel

Functions
	checkEmail ($email, $antispam=false)

	formatTimestamp ($time, $format= 'l', $timeoffset= '')

	formatURL ($url)

	redirect_header ($url, $time=3, $message= '', $addredirect=true, $allowExternalLink=false)

	userTimeToServerTime ($timestamp, $userTZ=null)

if(!function_exists('http_response_code')) if(!defined('ENT_SUBSTITUTE'))	xhtmlspecialchars ($string, $dummy_flags=0, $dummy_encoding= '', $dummy_double_encode=true)

	xoops_comment_count ($module_id, $item_id=null)

	xoops_comment_delete ($module_id, $item_id)

	xoops_confirm ($hiddens, $action, $msg, $submit= '', $addtoken=true)

	xoops_convert_encoding (&$text)

	xoops_error ($msg, $title= '')

	xoops_footer ()

	xoops_getActiveModules ()

	xoops_getbanner ()

	xoops_getBaseDomain ($url, $debug=0)

	xoops_getConfigOption ($option, $type= 'XOOPS_CONF')

	xoops_getcss ($theme= '')

	xoops_getenv ($key)

	xoops_getHandler ($name, $optional=false)

	xoops_getMailer ()

	xoops_getModuleHandler ($name=null, $module_dir=null, $optional=false)

	xoops_getModuleOption ($option, $dirname= '')

	xoops_getOption ($option)

	xoops_getrank ($rank_id=0, $posts=0)

	xoops_getUrlDomain ($url)

	xoops_getUserTimestamp ($time, $timeoffset= '')

	xoops_groupperm_deletebymoditem ($module_id, $perm_name, $item_id=null)

	xoops_header ($closehead=true)

	xoops_isActiveModule ($dirname)

	xoops_load ($name, $type= 'core')

	xoops_loadLanguage ($name, $domain= '', $language=null)

	xoops_makepass ()

	xoops_notification_deletebyitem ($module_id, $category, $item_id)

	xoops_notification_deletebymodule ($module_id)

	xoops_notification_deletebyuser ($user_id)

	xoops_result ($msg, $title= '')

	xoops_setActiveModules ()

	xoops_setConfigOption ($option, $new=null)

	xoops_substr ($str, $start, $length, $trimmarker= '...')

	xoops_template_clear_module_cache ($mid)

	xoops_template_touch ($tpl_id, $clear_old=true)

	xoops_trim ($text)

	xoops_utf8_encode (&$text)

Function Documentation

checkEmail	(	$email,
		$antispam = `false`
	)

Deprecated:

Parameters

string	$email
bool	$antispam

Returns: false|string

Definition at line 232 of file functions.php.

formatTimestamp	(	$time,
		$format = `'l'`,
		$timeoffset = `''`
	)

Deprecated:

Parameters

int	$time
string	$format
string	$timeoffset

Returns: string

Definition at line 195 of file functions.php.

formatURL ( $url )

Deprecated:

Parameters

string $url

Returns: string

Definition at line 244 of file functions.php.

redirect_header	(	$url,
		$time = `3`,
		$message = `''`,
		$addredirect = `true`,
		$allowExternalLink = `false`
	)

Deprecated:

Parameters

string	$url
int	$time
string	$message
bool	$addredirect
bool	$allowExternalLink

Returns: void

Definition at line 271 of file functions.php.

Referenced by Xmf\Module\Helper\GenericHelper\redirect().

Here is the caller graph for this function:

userTimeToServerTime	(	$timestamp,
		$userTZ = `null`
	)

Deprecated:

Parameters

int	$timestamp
null	$userTZ

Returns: int

Definition at line 208 of file functions.php.

if (!function_exists('http_response_code')) if (!defined('ENT_SUBSTITUTE')) xhtmlspecialchars	(	$string,
		$dummy_flags = `0`,
		$dummy_encoding = `''`,
		$dummy_double_encode = `true`
	)

xhtmlspecialchars - a customized version of PHP htmlspecialchars to set the flags and encoding parameters to the most approriate values for general use in a UTF-8 environment.

This function forces UTF-8 encoding, the ENT_QUOTES flag, and will also use the ENT_SUBSTITUTE flag if it is available. This gives the optimal features for 5.3 and in >5.4

Parameters

string	$string	string to be encoded
integer	$dummy_flags	ignored - for call compatibility only
mixed	$dummy_encoding	ignored - for call compatibility only
mixed	$dummy_double_encode	ignored - for call compatibility only

Returns: string with any charachters with special significance in HTML converted to entities

Definition at line 601 of file functions.php.

xoops_comment_count	(	$module_id,
		$item_id = `null`
	)

Deprecated:

Parameters

int	$module_id
int \| null	$item_id

Returns: int

Definition at line 382 of file functions.php.

xoops_comment_delete	(	$module_id,
		$item_id
	)

Deprecated:

Parameters

int	$module_id
int	$item_id

Returns: boolean|null

Definition at line 394 of file functions.php.

xoops_confirm	(	$hiddens,
		$action,
		$msg,
		$submit = `''`,
		$addtoken = `true`
	)

Deprecated:

Parameters

mixed	$hiddens
mixed	$action
mixed	$msg
string	$submit
bool	$addtoken

Returns: void

Definition at line 168 of file functions.php.

xoops_convert_encoding ( & $text )

Deprecated:

Parameters

$text

Returns: void

Definition at line 431 of file functions.php.

xoops_error	(	$msg,
		$title = `''`
	)

Deprecated:

Parameters

mixed	$msg
string	$title

Returns: void

Definition at line 139 of file functions.php.

xoops_footer ( )

Deprecated:

Returns: void

Definition at line 126 of file functions.php.

xoops_getActiveModules ( )

Deprecated:

Returns: array

Definition at line 80 of file functions.php.

xoops_getbanner ( )

Deprecated:

Returns: string

Definition at line 255 of file functions.php.

xoops_getBaseDomain	(	$url,
		$debug = `0`
	)

Deprecated:

Parameters

	$url
int	$debug

Returns: string

Definition at line 507 of file functions.php.

xoops_getConfigOption	(	$option,
		$type = `'XOOPS_CONF'`
	)

Deprecated:

Parameters

string	$option
string \| int \| array	$type

Returns: mixed

Definition at line 468 of file functions.php.

xoops_getcss ( $theme = '' )

Deprecated:

Parameters

string $theme

Returns: string

Definition at line 295 of file functions.php.

xoops_getenv ( $key )

Deprecated:

Parameters

string $key

Returns: string

Definition at line 283 of file functions.php.

xoops_getHandler	(	$name,
		$optional = `false`
	)

Deprecated:

Parameters

string	$name
mixed	$optional

Returns: XoopsObjectHandler|XoopsPersistableObjectHandler|null

Definition at line 25 of file functions.php.

References $name, $xoops, and Xoops\getInstance().

Referenced by Xmf\Module\Helper\GenericHelper\_initObject().

Here is the call graph for this function:

Here is the caller graph for this function:

xoops_getMailer ( )

Deprecated:

Returns: XoopsMailer|XoopsMailerLocal

Definition at line 306 of file functions.php.

xoops_getModuleHandler	(	$name = `null`,
		$module_dir = `null`,
		$optional = `false`
	)

Deprecated:

Parameters

string \| null	$name
string \| null	$module_dir
bool	$optional

Returns: bool

Definition at line 40 of file functions.php.

xoops_getModuleOption	(	$option,
		$dirname = `''`
	)

Deprecated:

Parameters

string	$option
string	$dirname

Returns: mixed

Definition at line 494 of file functions.php.

xoops_getOption ( $option )

Deprecated:

Parameters

$option

Returns: string

Definition at line 455 of file functions.php.

xoops_getrank	(	$rank_id = `0`,
		$posts = `0`
	)

Deprecated:

Parameters

int	$rank_id
int	$posts

Returns: array

Definition at line 319 of file functions.php.

xoops_getUrlDomain ( $url )

Deprecated:

Parameters

string $url

Returns: string

Definition at line 519 of file functions.php.

xoops_getUserTimestamp	(	$time,
		$timeoffset = `''`
	)

Deprecated:

Parameters

	mixed$time
string	$timeoffset

Returns: int

Definition at line 181 of file functions.php.

xoops_groupperm_deletebymoditem	(	$module_id,
		$perm_name,
		$item_id = `null`
	)

Deprecated:

Parameters

int	$module_id
string	$perm_name
int \| null	$item_id

Returns: bool

Definition at line 407 of file functions.php.

xoops_header ( $closehead = true )

Deprecated:

Parameters

bool $closehead

Returns: void

Definition at line 115 of file functions.php.

xoops_isActiveModule ( $dirname )

Deprecated:

Parameters

string $dirname

Returns: bool

Definition at line 103 of file functions.php.

Referenced by Xmf\Module\Helper\getHelper().

Here is the caller graph for this function:

xoops_load	(	$name,
		$type = `'core'`
	)

Deprecated:

Parameters

string	$name	Name of class to be loaded
string	$type	domain of the class, potential values: core - locaded in /class/; framework - located in /Frameworks/; other - module class, located in /modules/[$type]/class/

Returns: boolean

Definition at line 53 of file functions.php.

xoops_loadLanguage	(	$name,
		$domain = `''`,
		$language = `null`
	)

Deprecated:

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.

Definition at line 69 of file functions.php.

xoops_makepass ( )

Deprecated:

Returns: string

Definition at line 219 of file functions.php.

xoops_notification_deletebyitem	(	$module_id,
		$category,
		$item_id
	)

Deprecated:

Parameters

$module_id
$category
$item_id

Returns: boolean|null

Definition at line 370 of file functions.php.

xoops_notification_deletebymodule ( $module_id )

Deprecated:

Parameters

int $module_id

Returns: boolean|null

Definition at line 346 of file functions.php.

xoops_notification_deletebyuser ( $user_id )

Deprecated:

Parameters

int $user_id

Returns: boolean|null

Definition at line 357 of file functions.php.

xoops_result	(	$msg,
		$title = `''`
	)

Deprecated:

Parameters

mixed	$msg
string	$title

Returns: void

Definition at line 152 of file functions.php.

xoops_setActiveModules ( )

Deprecated:

Returns: array

Definition at line 91 of file functions.php.

xoops_setConfigOption	(	$option,
		$new = `null`
	)

Deprecated:

Parameters

	$option
null	$new

Returns: void

Definition at line 481 of file functions.php.

xoops_substr	(	$str,
		$start,
		$length,
		$trimmarker = `'...'`
	)

Deprecated:

Parameters

string	$str
int	$start
int	$length
string	$trimmarker

Returns: string

Definition at line 334 of file functions.php.

xoops_template_clear_module_cache ( $mid )

Clear the module cache

Parameters

int $mid Module ID

Returns: void

http_response_code - conditionally defined for PHP <5.4

Taken from stackoverflow answer by "dualed," see: http://stackoverflow.com/questions/3258634/php-how-to-send-http-response-code

Parameters

int $newcode HTTP response code

Returns: int old status code

Definition at line 546 of file functions.php.

xoops_template_touch	(	$tpl_id,
		$clear_old = `true`
	)

function to update compiled template file in templates_c folder

Parameters

string	$tpl_id
boolean	$clear_old

Returns: boolean

Definition at line 533 of file functions.php.

xoops_trim ( $text )

Deprecated:

Parameters

$text

Returns: string

Definition at line 443 of file functions.php.

xoops_utf8_encode ( & $text )

Deprecated:

Parameters

$text

Returns: void

Definition at line 419 of file functions.php.

Namespaces

Functions

Function Documentation