[ Index ]

PHP Cross Reference of Xoops v2.4.5 code documentation

title

Body

[close]

/include/ -> functions.php (summary)

Xoops Functions You may not change or alter any portion of this comment or credits of supporting developers from this source code or any supporting source code which is considered copyrighted (c) material of the original comment or credit authors. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Copyright: The XOOPS Project http://sourceforge.net/projects/xoops/
License: http://www.fsf.org/copyleft/gpl.html GNU public license
Version: $Id: functions.php 4897 2010-06-19 02:55:48Z phppp $
File Size: 1068 lines (36 kb)
Included or required: 2 times
Referenced: 1 time
Includes or requires: 4 files
 class/xoopsmailer.php
 class/template.php
 class/xoopsload.php
 class/theme.php

Defines 40 functions

  xoops_gethandler()
  xoops_getmodulehandler()
  xoops_load()
  xoops_loadLanguage()
  xoops_getActiveModules()
  xoops_setActiveModules()
  xoops_isActiveModule()
  xoops_header()
  xoops_footer()
  xoops_error()
  xoops_result()
  xoops_confirm()
  xoops_getUserTimestamp()
  formatTimestamp()
  userTimeToServerTime()
  xoops_makepass()
  checkEmail()
  formatURL()
  xoops_getbanner()
  redirect_header()
  xoops_getenv()
  xoops_getcss()
  xoops_getMailer()
  xoops_getrank()
  xoops_substr()
  xoops_notification_deletebymodule()
  xoops_notification_deletebyuser()
  xoops_notification_deletebyitem()
  xoops_comment_count()
  xoops_comment_delete()
  xoops_groupperm_deletebymoditem()
  xoops_utf8_encode()
  xoops_convert_encoding()
  xoops_trim()
  xoops_getOption()
  xoops_getConfigOption()
  xoops_setConfigOption()
  xoops_getModuleOption()
  xoops_getBaseDomain()
  xoops_getUrlDomain()

Functions
Functions that are not part of a class:

xoops_gethandler($name, $optional = false)   X-Ref
xoops_gethandler()

param: mixed $name
param: mixed $optional
return:

xoops_getmodulehandler($name = null, $module_dir = null, $optional = false)   X-Ref
xoops_getmodulehandler()

param: mixed $name
param: mixed $module_dir
param: mixed $optional
return:

xoops_load($name, $type = 'core')   X-Ref
XOOPS class loader wrapper

Temporay solution for XOOPS 2.3

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

xoops_loadLanguage($name, $domain = '', $language = null)   X-Ref
XOOPS language loader wrapper

Temporay solution, not encouraged to use

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

xoops_getActiveModules()   X-Ref
xoops_getActiveModules()

Get active modules from cache file

return: array

xoops_setActiveModules()   X-Ref
xoops_setActiveModules()

Write active modules to cache file

return: array

xoops_isActiveModule($dirname)   X-Ref
xoops_isActiveModule()

Checks is module is installed and active

return: bool

xoops_header($closehead = true)   X-Ref
xoops_header()

param: mixed $closehead
return:

xoops_footer()   X-Ref
xoops_footer

return:

xoops_error($msg, $title = '')   X-Ref
xoops_error

param: mixed $msg
param: string $title
return:

xoops_result($msg, $title = '')   X-Ref
xoops_result

param: mixed $msg
param: string $title
return:

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

param: mixed $hiddens
param: mixed $action
param: mixed $msg
param: string $submit
param: mixed $addtoken
return:

xoops_getUserTimestamp($time, $timeoffset = '')   X-Ref
xoops_getUserTimestamp()

param: mixed $time
param: string $timeoffset
return:

formatTimestamp($time, $format = 'l', $timeoffset = '')   X-Ref
Function to display formatted times in user timezone


userTimeToServerTime($timestamp, $userTZ = null)   X-Ref
Function to calculate server timestamp from user entered time (timestamp)


xoops_makepass()   X-Ref
xoops_makepass()

return:

checkEmail($email, $antispam = false)   X-Ref
checkEmail()

param: mixed $email
param: mixed $antispam
return:

formatURL($url)   X-Ref
formatURL()

param: mixed $url
return:

xoops_getbanner()   X-Ref
Function to get banner html tags for use in templates


redirect_header($url, $time = 3, $message = '', $addredirect = true, $allowExternalLink = false)   X-Ref
Function to redirect a user to certain pages


xoops_getenv($key)   X-Ref
xoops_getenv()

param: mixed $key
return:

xoops_getcss($theme = '')   X-Ref
Function to get css file for a certain themeset


xoops_getMailer()   X-Ref
xoops_getMailer()

return:

xoops_getrank($rank_id = 0, $posts = 0)   X-Ref
xoops_getrank()

param: integer $rank_id
param: mixed $posts
return:

xoops_substr($str, $start, $length, $trimmarker = '...')   X-Ref
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: string $str
param: int $start
param: int $length
param: string $trimmarker
return: string

xoops_notification_deletebymodule($module_id)   X-Ref
No description

xoops_notification_deletebyuser($user_id)   X-Ref
xoops_notification_deletebyuser()

param: mixed $user_id
return:

xoops_notification_deletebyitem($module_id, $category, $item_id)   X-Ref
xoops_notification_deletebyitem()

param: mixed $module_id
param: mixed $category
param: mixed $item_id
return:

xoops_comment_count($module_id, $item_id = null)   X-Ref
xoops_comment_count()

param: mixed $module_id
param: mixed $item_id
return:

xoops_comment_delete($module_id, $item_id)   X-Ref
xoops_comment_delete()

param: mixed $module_id
param: mixed $item_id
return:

xoops_groupperm_deletebymoditem($module_id, $perm_name, $item_id = null)   X-Ref
xoops_groupperm_deletebymoditem()

Group Permission Helper Functions

param: mixed $module_id
param: mixed $perm_name
param: mixed $item_id
return:

xoops_utf8_encode(&$text)   X-Ref
xoops_utf8_encode()

param: mixed $text
return:

xoops_convert_encoding(&$text)   X-Ref
xoops_convert_encoding()

param: mixed $text
return:

xoops_trim($text)   X-Ref
xoops_trim()

param: mixed $text
return:

xoops_getOption($option)   X-Ref
xoops_getOption()

param: mixed $option
param: string $type
return:

xoops_getConfigOption($option, $type = 'XOOPS_CONF')   X-Ref
xoops_getConfigOption()

param: mixed $option
param: string $dirname
return:

xoops_setConfigOption($option, $new = null)   X-Ref
xoops_setConfigOption()

param: mixed $option
return:

xoops_getModuleOption($option, $dirname = '')   X-Ref
xoops_getModuleOption

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

param: mixed $option
param: string $dirname
return:

xoops_getBaseDomain($url, $debug = 0)   X-Ref
Function to get the base domain name from a URL.
credit for this function should goto Phosphorus and Lime, it is released under LGPL.

param: string $url the URL to be stripped.
return: string

xoops_getUrlDomain($url)   X-Ref
Function to get the domain from a URL.

param: string $url the URL to be stripped.
return: string



Generated: Sun Aug 1 01:39:09 2010
Open Source related documentation for developers.