Namespaces
namespace	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)

	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_trim ($text)

	xoops_utf8_encode (&$text)

Function Documentation

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

checkEmail()

Parameters

mixed	$email
mixed	$antispam

Returns

Definition at line 444 of file functions.php.

References $email, and $i.

Referenced by XoopsUserUtility\validate().

Here is the caller graph for this function:

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

Function to display formatted times in user timezone

Definition at line 390 of file functions.php.

References $time, XoopsLocalAbstract\formatTimestamp(), and xoops_load().

Referenced by XoopsCommentRenderer\_getPosterArray(), XoopsCommentRenderer\_renderNestReplies(), XoopsCommentRenderer\_renderThreadReplies(), b_system_comments_show(), b_system_newmembers_show(), bannerstats(), ProfileField\getOutputValue(), XoopsFormTextDateSelect\render(), ModuleAdmin\renderAbout(), XoopsCommentRenderer\renderFlatView(), XoopsCommentRenderer\renderNestView(), XoopsCommentRenderer\renderThreadView(), PmMessageHandler\sendEmail(), XoopsComments\showThreadPost(), and XoopsComments\showTreeItem().

Here is the call graph for this function:

Here is the caller graph for this function:

formatURL ( $url )

formatURL()

Parameters

mixed $url

Returns

Definition at line 480 of file functions.php.

References $url.

Referenced by ProfileField\getOutputValue().

Here is the caller graph for this function:

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

Function to redirect a user to certain pages

Definition at line 558 of file functions.php.

References $_SERVER, $pos, $time, $url, $xoopsConfig, $xoopsLogger, $xoopsModule, $xoopsPreload, $xoopsThemeFactory, $xoopsTpl, $xoopsUserIsAdmin, $xoTheme, _IFNOTRELOAD, _TAKINGBACK, exit, XoopsPreload\getInstance(), xoops_getcss(), and XOOPS_THEME_URL.

Referenced by XoopsAuthProvisionning\add(), bannerstats(), XoopsAuthProvisionning\change(), change_banner_url_by_client(), XoopsInstallWizard\checkAccess(), clickbanner(), EmailStats(), profile_stepsave_toggle(), profile_visible_toggle(), and synchronize().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Function to calculate server timestamp from user entered time (timestamp)

Definition at line 399 of file functions.php.

References $xoopsConfig.

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

xoops_comment_count()

Parameters

mixed	$module_id
mixed	$item_id

Returns

Definition at line 791 of file functions.php.

References $comment_handler, $criteria, $module_id, and xoops_gethandler().

Here is the call graph for this function:

xoops_comment_delete	(	$module_id,
		$item_id
	)

xoops_comment_delete()

Parameters

mixed	$module_id
mixed	$item_id

Returns

Definition at line 808 of file functions.php.

References $comment_handler, $comments, $i, $member_handler, $module_id, $user_id, and xoops_gethandler().

Here is the call graph for this function:

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

xoops_confirm()

Parameters

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

Returns

Definition at line 342 of file functions.php.

References $action, $GLOBALS, $msg, _CANCEL, and _SUBMIT.

xoops_convert_encoding ( & $text )

xoops_convert_encoding()

Parameters

mixed $text

Returns

Definition at line 877 of file functions.php.

References xoops_utf8_encode().

Here is the call graph for this function:

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

xoops_error

Parameters

mixed	$msg
string	$title

Returns

Definition at line 281 of file functions.php.

References $msg, and $title.

xoops_footer ( )

xoops_footer

Returns

Definition at line 268 of file functions.php.

xoops_getActiveModules ( )

YOU SHOULD BE CAREFUL WITH USING THIS METHOD SINCE IT WILL BE DEPRECATED xoops_getActiveModules()

Get active modules from cache file

Returns: array

Definition at line 161 of file functions.php.

References XoopsCache\read(), xoops_load(), and xoops_setActiveModules().

Referenced by xoops_isActiveModule().

Here is the call graph for this function:

Here is the caller graph for this function:

xoops_getbanner ( )

Function to get banner html tags for use in templates

Check if this impression is the last one

Print the banner

Definition at line 497 of file functions.php.

References $date, $db, $sql, $xoopsConfig, XoopsDatabaseFactory\getDatabaseConnection(), and xoops_getenv().

Referenced by showbanner(), and xos_opal_Theme\xoInit().

Here is the call graph for this function:

Here is the caller graph for this function:

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

YOU SHOULD NOT THIS METHOD, IT WILL BE REMOVED Function to get the base domain name from a URL. credit for this function should goto Phosphorus and Lime, it is released under LGPL.

Parameters

string $url the URL to be stripped.

Returns: string

Deprecated:

Definition at line 1007 of file functions.php.

References $url, and xoops_getUrlDomain().

Here is the call graph for this function:

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

YOU SHOULD NOT THIS METHOD, IT WILL BE REMOVED xoops_getConfigOption()

Parameters

mixed	$option
string	$dirname

Deprecated:

Returns

Definition at line 926 of file functions.php.

References $config_handler, $configs, $ret, $type, and xoops_gethandler().

Referenced by XoopsSystemCpanel\__construct(), xos_kernel_Xoops2\gzipCompression(), xos_opal_Theme\loadLocalization(), xos_kernel_Xoops2\themeSelect(), and xoops_header().

Here is the call graph for this function:

Here is the caller graph for this function:

xoops_getcss ( $theme = '' )

Function to get css file for a certain themeset

Definition at line 653 of file functions.php.

References $GLOBALS, xoops_getenv(), XOOPS_THEME_PATH, and XOOPS_THEME_URL.

Referenced by getcss(), TinyMCE\loadCss(), redirect_header(), xos_opal_Theme\xoInit(), and xoops_header().

Here is the call graph for this function:

Here is the caller graph for this function:

xoops_getenv ( $key )

xoops_getenv()

Parameters

mixed $key

Returns

Definition at line 636 of file functions.php.

References $_SERVER, and $ret.

Referenced by SystemMenuHandler\breadcrumb_nav(), XoopsSecurity\checkReferer(), xoops_getbanner(), and xoops_getcss().

Here is the caller graph for this function:

& xoops_gethandler	(	$name,
		$optional = `false`
	)

xoops_gethandler()

Parameters

mixed	$name
mixed	$optional

Returns

Definition at line 28 of file functions.php.

References $xoopsDB, and XoopsDatabaseFactory\getDatabaseConnection().

Referenced by XoopsXmlRpcApi\_checkUser(), XoopsAuthProvisionning\add(), XoopsAuthXoops\authenticate(), b_system_comments_show(), b_system_main_show(), b_system_newmembers_show(), b_system_notification_show(), b_system_online_show(), b_system_topposters_show(), b_system_user_show(), b_system_waiting_show(), XoopsAuthProvisionning\change(), createConfigform(), ProfileFieldHandler\delete(), SystemMaintenance\dump_modules(), form_user(), XoopsAuthFactory\getAuthConnection(), XoopsModule\getByDirName(), SystemUsers\getForm(), SystemBlock\getForm(), SystemAvatar\getForm(), SystemGroup\getForm(), XoopsUser\getGroups(), ProfileField\getOutputValue(), XoopsUser\getUnameFromId(), XoopsUserUtility\getUnameFromId(), XoopsAuthProvisionning\getXoopsUser(), XoopsGuiZetadigme\header(), XoopsGuiDefault\header(), XoopsUser\incrementPost(), install_acceptUser(), XoopsUser\isAdmin(), XoopsUser\isOnline(), MytsCensor\load(), XoopsObject\loadFilters(), mod_fetchConfig(), notificationCategoryInfo(), notificationEnabled(), notificationEventEnabled(), notificationEvents(), XoopsNotification\notifyUser(), profile_getFieldForm(), profile_getRegisterForm(), profile_getStepForm(), profile_getUserForm(), protector_postcommon(), XoopsGroupPermForm\render(), ProfileProfileHandler\search(), XoopsMailer\sendPM(), XoopsUserUtility\sendWelcome(), XoopsMailer\setToGroups(), smarty_function_xoInboxCount(), smarty_resource_db_tplinfo(), XoopsNotificationHandler\triggerEvent(), XoopsGuiThadmin\validate(), XoopsUserUtility\validate(), xos_opal_Theme\xoInit(), xoops_comment_count(), xoops_comment_delete(), xoops_getConfigOption(), xoops_getModuleOption(), xoops_groupperm_deletebymoditem(), xoops_legacy_cp_header(), xoops_legacy_module_get_admin_menu(), xoops_module_activate(), xoops_module_change(), xoops_module_deactivate(), xoops_module_get_admin_menu(), xoops_module_install(), xoops_module_system_update(), xoops_module_uninstall(), xoops_notification_deletebyitem(), xoops_notification_deletebymodule(), xoops_notification_deletebyuser(), xoops_setActiveModules(), xoops_template_touch(), XoopsAuthLdap\XoopsAuthLdap(), XoopsAuthProvisionning\XoopsAuthProvisionning(), XoopsBlock\XoopsBlock(), XoopsCommentRenderer\XoopsCommentRenderer(), XoopsFormSelectCheckGroup\XoopsFormSelectCheckGroup(), XoopsFormSelectGroup\XoopsFormSelectGroup(), XoopsFormSelectUser\XoopsFormSelectUser(), XoopsMultiMailer\XoopsMultiMailer(), and XoopsUser\XoopsUser().

Here is the call graph for this function:

& xoops_getMailer ( )

xoops_getMailer()

Returns

Definition at line 688 of file functions.php.

References $file, and $xoopsConfig.

Referenced by EmailStats(), getMailer(), XoopsNotification\notifyUser(), PmMessageHandler\sendEmail(), and XoopsUserUtility\sendWelcome().

Here is the caller graph for this function:

& xoops_getmodulehandler	(	$name = `null`,
		$module_dir = `null`,
		$optional = `false`
	)

xoops_getmodulehandler()

Parameters

mixed	$name
mixed	$module_dir
mixed	$optional

Returns

Definition at line 61 of file functions.php.

References $GLOBALS, $xoopsDB, and XoopsDatabaseFactory\getDatabaseConnection().

Referenced by ProfileProfileHandler\__construct(), ProfileRegstepHandler\delete(), ProfileFieldHandler\delete(), SystemBlock\getForm(), ProfileField\getUserVars(), XoopsSystemGui\header(), ProfileFieldHandler\insert(), langDropdown(), profile_getFieldForm(), profile_getRegisterForm(), profile_getUserForm(), and profile_stepsave_toggle().

Here is the call graph for this function:

Here is the caller graph for this function:

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

YOU SHOULD NOT THIS METHOD, IT WILL BE REMOVED xoops_getModuleOption

Method for module developers getting a module config item. This could be from any module requested.

Parameters

mixed	$option
string	$dirname

Returns

Deprecated:

Definition at line 975 of file functions.php.

References $config_handler, $dirname, $module, $module_handler, $ret, and xoops_gethandler().

Referenced by SystemBlock\getForm(), SystemGroup\getForm(), SystemBreadcrumb\render(), smarty_compiler_xoAdminIcons(), smarty_compiler_xoAdminNav(), and smarty_compiler_xoModuleIcons32().

Here is the call graph for this function:

Here is the caller graph for this function:

xoops_getOption ( $option )

YOU SHOULD NOT THIS METHOD, IT WILL BE REMOVED xoops_getOption()

Parameters

mixed	$option
string	$type

Deprecated:

Returns

Definition at line 905 of file functions.php.

References $GLOBALS, and $ret.

Referenced by xoops_loadLanguage().

Here is the caller graph for this function:

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

xoops_getrank()

Parameters

integer	$rank_id
mixed	$posts

Returns

Definition at line 717 of file functions.php.

References $db, $myts, $sql, XoopsDatabaseFactory\getDatabaseConnection(), and MyTextSanitizer\getInstance().

Referenced by XoopsUser\rank().

Here is the call graph for this function:

Here is the caller graph for this function:

xoops_getUrlDomain ( $url )

YOU SHOULD NOT THIS METHOD, IT WILL BE REMOVED Function to get the domain from a URL.

Parameters

string $url the URL to be stripped.

Returns: string

Deprecated:

Definition at line 1087 of file functions.php.

References $url.

Referenced by xoops_getBaseDomain().

Here is the caller graph for this function:

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

xoops_getUserTimestamp()

Parameters

mixed	$time
string	$timeoffset

Returns

Definition at line 373 of file functions.php.

References $time, $xoopsConfig, and $xoopsUser.

Referenced by XoopsLocalAbstract\formatTimestamp().

Here is the caller graph for this function:

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

xoops_groupperm_deletebymoditem()

Group Permission Helper Functions

Parameters

mixed	$module_id
mixed	$perm_name
mixed	$item_id

Returns

Definition at line 849 of file functions.php.

References $gperm_handler, $module_id, and xoops_gethandler().

Here is the call graph for this function:

xoops_header ( $closehead = true )

xoops_header()

Parameters

mixed $closehead

Returns

Definition at line 222 of file functions.php.

References $GLOBALS, $language, $myts, $xoopsConfig, $xoopsConfigMetaFooter, _CHARSET, _LANGCODE, MyTextSanitizer\getInstance(), xoops_getConfigOption(), and xoops_getcss().

Here is the call graph for this function:

xoops_isActiveModule ( $dirname )

YOU SHOULD BE CAREFUL WITH USING THIS METHOD SINCE IT WILL BE DEPRECATED xoops_isActiveModule()

Checks is module is installed and active

Returns: bool

Definition at line 208 of file functions.php.

References $dirname, and xoops_getActiveModules().

Referenced by b_system_waiting_show().

Here is the call graph for this function:

Here is the caller graph for this function:

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

XOOPS class loader wrapper

Temporay solution for XOOPS 2.3

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 106 of file functions.php.

References $type, and XoopsLoad\load().

Referenced by XoopsCaptchaImageHandler\__construct(), FormDhtmlTextArea\__construct(), xos_logos_PageBuilder\buildBlock(), MytsWiki\decode(), formatTimestamp(), MytsSyntaxhighlight\geshi(), SystemGroup\getForm(), SystemBannerclient\getForm(), SystemBanner\getForm(), XoopsSystemCpanel\getGuis(), XoopsCaptchaImageHandler\getList(), XoopsEditorHandler\getList(), MytsTextfilter\load(), XoopsObject\loadFilters(), XoopsModelFactory\loadHandler(), XoopsPersistableObjectHandler\loadHandler(), mod_clearConfig(), mod_createFile(), mod_loadConfig(), mod_loadFile(), XoopsFormSelectEditor\render(), xos_opal_Theme\render(), XoopsPersistableObjectHandler\setHandler(), xoops_cp_footer(), xoops_cp_header(), xoops_getActiveModules(), xoops_getLinkedUnameFromId(), xoops_setActiveModules(), xoops_substr(), xoops_trim(), xoops_utf8_encode(), xoopsCodeTarea(), XoopsFormCaptcha\XoopsFormCaptcha(), XoopsFormDhtmlTextArea\XoopsFormDhtmlTextArea(), and XoopsFormEditor\XoopsFormEditor().

Here is the call graph for this function:

Here is the caller graph for this function:

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

XOOPS language loader wrapper

Temporay solution, not encouraged to use

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.

Set pageType

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

Definition at line 126 of file functions.php.

References $GLOBALS, $language, $path, $ret, and xoops_getOption().

Referenced by XoopsCaptcha\__construct(), XoopsBlock\buildBlock(), XoopsSystemGui\header(), XoopsLocalWrapper\load(), notificationEvents(), profile_getUserForm(), XoopsFormDhtmlTextArea\render(), XoopsUserUtility\sendWelcome(), XoopsUserUtility\validate(), xoops_legacy_cp_header(), xoops_load_lang_file(), xoops_module_install_profile(), and XoopsFormSelectUser\XoopsFormSelectUser().

Here is the call graph for this function:

Here is the caller graph for this function:

xoops_makepass ( )

xoops_makepass()

Returns

Definition at line 414 of file functions.php.

xoops_notification_deletebyitem	(	$module_id,
		$category,
		$item_id
	)

xoops_notification_deletebyitem()

Parameters

mixed	$module_id
mixed	$category
mixed	$item_id

Returns

Definition at line 778 of file functions.php.

References $module_id, $notification_handler, and xoops_gethandler().

Here is the call graph for this function:

xoops_notification_deletebymodule ( $module_id )

Definition at line 752 of file functions.php.

References $module_id, $notification_handler, and xoops_gethandler().

Referenced by xoops_module_uninstall().

Here is the call graph for this function:

Here is the caller graph for this function:

xoops_notification_deletebyuser ( $user_id )

xoops_notification_deletebyuser()

Parameters

mixed $user_id

Returns

Definition at line 764 of file functions.php.

References $notification_handler, $user_id, and xoops_gethandler().

Here is the call graph for this function:

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

xoops_result

Parameters

mixed	$msg
string	$title

Returns

Definition at line 310 of file functions.php.

References $msg, and $title.

xoops_setActiveModules ( )

YOU SHOULD BE CAREFUL WITH USING THIS METHOD SINCE IT WILL BE DEPRECATED xoops_setActiveModules()

Write active modules to cache file

Returns: array

Definition at line 184 of file functions.php.

References $module_handler, XoopsCache\write(), xoops_gethandler(), and xoops_load().

Referenced by xoops_getActiveModules().

Here is the call graph for this function:

Here is the caller graph for this function:

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

YOU SHOULD NOT THIS METHOD, IT WILL BE REMOVED xoops_setConfigOption()

Parameters

mixed $option

Returns

Deprecated:

Definition at line 955 of file functions.php.

References $GLOBALS.

Referenced by xos_kernel_Xoops2\gzipCompression(), and xos_kernel_Xoops2\themeSelect().

Here is the caller graph for this function:

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

Returns the portion of string specified by the start and length parameters. If $trimmarker is supplied, it is appended to the return string. This function works fine with multi-byte characters if mb_* functions exist on the server.

Parameters