API - XOOPS 2.5.11 Beta 2
By monxoops.fr
functions.php File Reference

Namespaces

namespace  kernel
 

Functions

 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_warning ($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_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)
 

Function Documentation

◆ checkEmail()

checkEmail (   $email,
  $antispam = false 
)

checkEmail()

Parameters
mixed$email
mixed$antispam
Returns
bool|mixed
Here is the caller graph for this function:

◆ formatTimestamp()

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

Function to display formatted times in user timezone

Parameters
$time
string$format
string$timeoffset
Returns
string
Here is the call graph for this function:
Here is the caller graph for this function:

◆ formatURL()

formatURL (   $url)

formatURL()

Parameters
mixed$url
Returns
mixed|string
Here is the caller graph for this function:

◆ redirect_header()

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

Function to redirect a user to certain pages

Parameters
$url
int$time
string$message
bool$addredirect
bool$allowExternalLink
Here is the call graph for this function:
Here is the caller graph for this function:

◆ userTimeToServerTime()

userTimeToServerTime (   $timestamp,
  $userTZ = null 
)

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

Parameters
$timestamp
null$userTZ
Returns

◆ xoops_confirm()

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

xoops_confirm()

Parameters
mixed$hiddens
mixed$action
mixed$msg
string$submit
mixed$addtoken
Returns
void

◆ xoops_convert_encoding()

xoops_convert_encoding ( $text)

xoops_convert_encoding()

Parameters
mixed$text
Returns
string
Here is the call graph for this function:

◆ xoops_error()

xoops_error (   $msg,
  $title = '' 
)

xoops_error

Parameters
mixed$msg
string$title
Returns
void
Here is the call graph for this function:
Here is the caller graph for this function:

◆ xoops_footer()

xoops_footer ( )

xoops_footer

Returns
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

Returns
array
Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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.

Parameters
string$urlURL or hostname to process
Returns
string the registrable domain or an empty string
Here is the caller graph for this function:

◆ xoops_getConfigOption()

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

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

Parameters
mixed$option
array | string$type
Here is the call graph for this function:
Here is the caller graph for this function:

◆ xoops_getcss()

xoops_getcss (   $theme = '')

Function to get css file for a certain themeset

Parameters
string$theme
Returns
string
Here is the call graph for this function:
Here is the caller graph for this function:

◆ xoops_getenv()

xoops_getenv (   $key)

xoops_getenv()

Parameters
mixed$key
Returns
string
Here is the caller graph for this function:

◆ xoops_getHandler()

xoops_getHandler (   $name,
  $optional = false 
)

xoops_getHandler()

Parameters
string$name
bool$optional
Returns
XoopsObjectHandler|false
Here is the call graph for this function:

◆ xoops_getMailer()

xoops_getMailer ( )

xoops_getMailer()

Returns
\XoopsMailer|\XoopsMailerLocal
Here is the caller graph for this function:

◆ xoops_getModuleHandler()

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

xoops_getModuleHandler()

Parameters
string$name
mixed$module_dir
bool$optional
Returns
XoopsObjectHandler|false
Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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.

Parameters
mixed$option
string$dirname
Returns
bool
Deprecated:
Here is the call graph for this function:
Here is the caller graph for this function:

◆ xoops_getOption()

xoops_getOption (   $option)

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

Parameters
mixed$option
Here is the caller graph for this function:

◆ xoops_getrank()

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

xoops_getrank()

Parameters
integer$rank_id
mixed$posts
Returns
Here is the call graph for this function:
Here is the caller graph for this function:

◆ xoops_getUrlDomain()

xoops_getUrlDomain (   $url)

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

Parameters
string$urlthe URL to be stripped.
Returns
string
Deprecated:

◆ xoops_getUserTimestamp()

xoops_getUserTimestamp (   $time,
  $timeoffset = '' 
)

xoops_getUserTimestamp()

Parameters
mixed$time
string$timeoffset
Returns
int
Here is the caller graph for this function:

◆ xoops_groupperm_deletebymoditem()

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
bool
Here is the call graph for this function:

◆ xoops_header()

xoops_header (   $closehead = true)

xoops_header()

Parameters
mixed$closehead
Returns
void
Here is the call graph for this function:

◆ 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

Parameters
$dirname
Returns
bool
Here is the call graph for this function:
Here is the caller graph for this function:

◆ xoops_load()

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

XOOPS class loader wrapper

Temporay solution for XOOPS 2.3

Parameters
string$nameName of class to be loaded
string$typedomain of the class, potential values: core - located in /class/; framework - located in /Frameworks/; other - module class, located in /modules/[$type]/class/
Returns
boolean
Here is the call graph for this function:
Here is the caller graph for this function:

◆ xoops_loadLanguage()

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

XOOPS language loader wrapper

Temporay solution, not encouraged to use

Parameters
string$nameName of language file to be loaded, without extension
string$domainModule dirname; global language file will be loaded if $domain is set to 'global' or not specified
string$languageLanguage 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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ xoops_makepass()

xoops_makepass ( )

xoops_makepass()

Returns
string

◆ xoops_notification_deletebyitem()

xoops_notification_deletebyitem (   $module_id,
  $category,
  $item_id 
)

xoops_notification_deletebyitem()

Parameters
mixed$module_id
mixed$category
mixed$item_id
Returns
Here is the call graph for this function:

◆ xoops_notification_deletebymodule()

xoops_notification_deletebymodule (   $module_id)
Parameters
$module_id
Returns
mixed
Here is the call graph for this function:
Here is the caller graph for this function:

◆ xoops_notification_deletebyuser()

xoops_notification_deletebyuser (   $user_id)

xoops_notification_deletebyuser()

Parameters
mixed$user_id
Returns
Here is the call graph for this function:

◆ xoops_result()

xoops_result (   $msg,
  $title = '' 
)

xoops_result

Parameters
mixed$msg
string$title
Returns
void
Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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

Returns
array
Here is the call graph for this function:
Here is the caller graph for this function:

◆ xoops_setConfigOption()

xoops_setConfigOption (   $option,
  $new = null 
)

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

Parameters
mixed$option
null$new
Returns
void
Deprecated:
Here is the caller graph for this function:

◆ 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.

Parameters
string$str
int$start
int$length
string$trimmarker
Returns
string
Here is the call graph for this function:

◆ xoops_trim()

xoops_trim (   $text)

xoops_trim()

Parameters
mixed$text
Returns
string
Here is the call graph for this function:

◆ xoops_utf8_encode()

xoops_utf8_encode ( $text)

xoops_utf8_encode()

Parameters
mixed$text
Returns
string
Here is the call graph for this function:
Here is the caller graph for this function:

◆ xoops_warning()

xoops_warning (   $msg,
  $title = '' 
)

xoops_warning

Parameters
mixed$msg
string$title
Returns
void
Here is the call graph for this function:
Here is the caller graph for this function: