Espaces de nommage
	kernel

Fonctions
	xoops_getHandler ($name, $optional=false)

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

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

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

	xoops_getActiveModules ()

	xoops_setActiveModules ()

	xoops_isActiveModule ($dirname)

	xoops_header ($closehead=true)

	xoops_footer ()

	xoops_error ($msg, $title='')

	xoops_result ($msg, $title='')

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

	xoops_getUserTimestamp ($time, $timeoffset='')

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

	userTimeToServerTime ($timestamp, $userTZ=null)

	xoops_makepass ()

	checkEmail ($email, $antispam=false)

	formatURL ($url)

	xoops_getbanner ()

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

	xoops_getenv ($key)

	xoops_getcss ($theme='')

	xoops_getMailer ()

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

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

	xoops_notification_deletebymodule ($module_id)

	xoops_notification_deletebyuser ($user_id)

	xoops_notification_deletebyitem ($module_id, $category, $item_id)

	xoops_comment_count ($module_id, $item_id=null)

	xoops_comment_delete ($module_id, $item_id)

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

	xoops_utf8_encode (&$text)

	xoops_convert_encoding (&$text)

	xoops_trim ($text)

	xoops_getOption ($option)

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

	xoops_setConfigOption ($option, $new=null)

	xoops_getModuleOption ($option, $dirname='')

	xoops_getBaseDomain ($url)

	xoops_getUrlDomain ($url)

Documentation des fonctions

◆ checkEmail()

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

checkEmail()

Paramètres

mixed	$email
mixed	$antispam

Renvoie: bool|mixed

Voici le graphe des appelants de cette fonction :

◆ formatTimestamp()

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

Function to display formatted times in user timezone

Paramètres

	$time
string	$format
string	$timeoffset

Renvoie: string

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ formatURL()

formatURL ( $url )

formatURL()

Paramètres

mixed $url

Renvoie: mixed|string

Voici le graphe des appelants de cette fonction :

◆ redirect_header()

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

Function to redirect a user to certain pages

Paramètres

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ userTimeToServerTime()

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

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

Paramètres

	$timestamp
null	$userTZ

Renvoie

◆ xoops_comment_count()

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

xoops_comment_count()

Paramètres

mixed	$module_id
mixed	$item_id

Renvoie

Voici le graphe d'appel pour cette fonction :

◆ xoops_comment_delete()

xoops_comment_delete	(	$module_id,
		$item_id
	)

xoops_comment_delete()

Paramètres

mixed	$module_id
mixed	$item_id

Renvoie: bool

Voici le graphe d'appel pour cette fonction :

◆ xoops_confirm()

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

xoops_confirm()

Paramètres

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

Renvoie: void

◆ xoops_convert_encoding()

xoops_convert_encoding ( & $text )

xoops_convert_encoding()

Paramètres

mixed $text

Renvoie: string

Voici le graphe d'appel pour cette fonction :

◆ xoops_error()

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

xoops_error

Paramètres

mixed	$msg
string	$title

Renvoie: void

Voici le graphe des appelants de cette fonction :

◆ xoops_footer()

xoops_footer ( )

xoops_footer

Renvoie: void

◆ xoops_getActiveModules()

xoops_getActiveModules ( )

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

Get active modules from cache file

Renvoie: array

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ xoops_getbanner()

xoops_getbanner ( )

Function to get banner html tags for use in templates

Check if this impression is the last one

Print the banner

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ xoops_getBaseDomain()

xoops_getBaseDomain ( $url )

Determine the base domain name for a URL. The primary use for this is to set the domain used for cookies to represent any subdomains.

The registrable domain is determined using the public suffix list. If the domain is not registrable, an empty string is returned. This empty string can be used in setcookie() as the domain, which restricts cookie to just the current host.

Paramètres

string $url URL or hostname to process

Renvoie: string the registrable domain or an empty string

Voici le graphe des appelants de cette fonction :

◆ xoops_getConfigOption()

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

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

Paramètres

mixed	$option
array \| string	$type

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ xoops_getcss()

xoops_getcss ( $theme = '' )

Function to get css file for a certain themeset

Paramètres

string $theme

Renvoie: string

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ xoops_getenv()

xoops_getenv ( $key )

xoops_getenv()

Paramètres

mixed $key

Renvoie: string

Voici le graphe des appelants de cette fonction :

◆ xoops_getHandler()

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

xoops_getHandler()

Paramètres

mixed	$name
mixed	$optional

Renvoie: XoopsObjectHandler|false

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ xoops_getMailer()

xoops_getMailer ( )

xoops_getMailer()

Renvoie: \XoopsMailer|\XoopsMailerLocal

Voici le graphe des appelants de cette fonction :

◆ xoops_getModuleHandler()

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

xoops_getModuleHandler()

Paramètres

mixed	$name
mixed	$module_dir
mixed	$optional

Renvoie: XoopsObjectHandler|false

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ xoops_getModuleOption()

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

YOU SHOULD NOT USE THIS METHOD, IT WILL BE REMOVED xoops_getModuleOption

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

Paramètres

mixed	$option
string	$dirname

Renvoie: bool

Obsolète:

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ xoops_getOption()

xoops_getOption ( $option )

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

Paramètres

mixed $option

Voici le graphe des appelants de cette fonction :

◆ xoops_getrank()

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

xoops_getrank()

Paramètres

integer	$rank_id
mixed	$posts

Renvoie

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ xoops_getUrlDomain()

xoops_getUrlDomain ( $url )

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

Paramètres

string $url the URL to be stripped.

Renvoie: string

Obsolète:

◆ xoops_getUserTimestamp()

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

xoops_getUserTimestamp()

Paramètres

mixed	$time
string	$timeoffset

Renvoie: int

Voici le graphe des appelants de cette fonction :

◆ xoops_groupperm_deletebymoditem()

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

xoops_groupperm_deletebymoditem()

Group Permission Helper Functions

Paramètres

mixed	$module_id
mixed	$perm_name
mixed	$item_id

Renvoie: bool

Voici le graphe d'appel pour cette fonction :

◆ xoops_header()

xoops_header ( $closehead = true )

xoops_header()

Paramètres

mixed $closehead

Renvoie: void

Voici le graphe d'appel pour cette fonction :

◆ xoops_isActiveModule()

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

Paramètres

$dirname

Renvoie: bool

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ xoops_load()

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

XOOPS class loader wrapper

Temporay solution for XOOPS 2.3

Paramètres

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

Renvoie: boolean

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ xoops_loadLanguage()

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

XOOPS language loader wrapper

Temporay solution, not encouraged to use

Paramètres

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

Renvoie: boolean

A faire:: 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

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ xoops_makepass()

xoops_makepass ( )

xoops_makepass()

Renvoie: string

◆ xoops_notification_deletebyitem()

xoops_notification_deletebyitem	(	$module_id,
		$category,
		$item_id
	)

xoops_notification_deletebyitem()

Paramètres

mixed	$module_id
mixed	$category
mixed	$item_id

Renvoie

Voici le graphe d'appel pour cette fonction :

◆ xoops_notification_deletebymodule()

xoops_notification_deletebymodule ( $module_id )

Paramètres

$module_id

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ xoops_notification_deletebyuser()

xoops_notification_deletebyuser ( $user_id )

xoops_notification_deletebyuser()

Paramètres

mixed $user_id

Renvoie

Voici le graphe d'appel pour cette fonction :

◆ xoops_result()

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

xoops_result

Paramètres

mixed	$msg
string	$title

Renvoie: void

◆ xoops_setActiveModules()

xoops_setActiveModules ( )

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

Write active modules to cache file

Renvoie: array

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ xoops_setConfigOption()

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

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

Paramètres

mixed	$option
null	$new

Renvoie: void

Obsolète:

Voici le graphe des appelants de cette fonction :

◆ xoops_substr()

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.

Paramètres

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

Renvoie: string

Voici le graphe d'appel pour cette fonction :

◆ xoops_trim()

xoops_trim ( $text )

xoops_trim()

Paramètres

mixed $text

Renvoie: string

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ xoops_utf8_encode()

xoops_utf8_encode ( & $text )

xoops_utf8_encode()

Paramètres

mixed $text

Renvoie: string

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

Espaces de nommage

Fonctions

Documentation des fonctions

◆ checkEmail()

◆ formatTimestamp()

◆ formatURL()

◆ redirect_header()

◆ userTimeToServerTime()

◆ xoops_comment_count()

◆ xoops_comment_delete()

◆ xoops_confirm()

◆ xoops_convert_encoding()

◆ xoops_error()

◆ xoops_footer()

◆ xoops_getActiveModules()

◆ xoops_getbanner()

◆ xoops_getBaseDomain()

◆ xoops_getConfigOption()

◆ xoops_getcss()

◆ xoops_getenv()

◆ xoops_getHandler()

◆ xoops_getMailer()

◆ xoops_getModuleHandler()

◆ xoops_getModuleOption()

◆ xoops_getOption()

◆ xoops_getrank()

◆ xoops_getUrlDomain()

◆ xoops_getUserTimestamp()

◆ xoops_groupperm_deletebymoditem()

◆ xoops_header()

◆ xoops_isActiveModule()

◆ xoops_load()

◆ xoops_loadLanguage()

◆ xoops_makepass()

◆ xoops_notification_deletebyitem()

◆ xoops_notification_deletebymodule()

◆ xoops_notification_deletebyuser()

◆ xoops_result()

◆ xoops_setActiveModules()

◆ xoops_setConfigOption()

◆ xoops_substr()

◆ xoops_trim()

◆ xoops_utf8_encode()