Procedural File: functions.php
Source Location: /modules/xbs_cdm/include/functions.php
Page Details:
API Functions
Tags:
CDMCheckCode [line 125]
boolean CDMCheckCode(
string $codeSet, string $codeKey, string $value, [string $lang = CDM_DEF_LANG])
|
|
Check a code for a given value. Return true if value correct else false
Parameters
string |
$codeSet |
Name of code set |
string |
$codeKey |
Name of code |
string |
$value |
Value to check for |
string |
$lang |
Language set for code set |
CDMGetCode [line 83]
string CDMGetCode(
string $codeSet, string $codeKey, [string $lang = CDM_DEF_LANG])
|
|
Return a code value given a set and code key
Tags:
Parameters
string |
$codeSet |
Name of code set |
string |
$codeKey |
Name of code |
string |
$lang |
Language set for code set |
CDMGetCodeObj [line 63]
CDMCode CDMGetCodeObj(
string $codeSet, string $codeKey, [string $lang = CDM_DEF_LANG])
|
|
Return a code object
Parameters
string |
$codeSet |
Name of code set |
string |
$codeKey |
Name of code |
string |
$lang |
Language set for code set |
CDMGetCodeSet [line 50]
CDMSet CDMGetCodeSet(
string $codeSet, [string $lang = CDM_DEF_LANG])
|
|
Return a code set
Parameters
string |
$codeSet |
Name of code set |
string |
$lang |
Language set for code set |
CDMGetParams [line 104]
string CDMGetParams(
string $codeSet, string $codeKey, [string $lang = CDM_DEF_LANG])
|
|
Get parameters for a code given a set and code key
Tags:
Parameters
string |
$codeSet |
Name of code set |
string |
$codeKey |
Name of code |
string |
$lang |
Language set for code set |
getXoopsUser [line 137]
string getXoopsUser(
int $id)
|
|
Return a valid xoops user name given the user id
Tags:
Parameters
updateDatabase [line 156]
string updateDatabase(
string $sqlFile, string $errorPage)
|
|
Function: updateDatabase Takes a SQL command file and applies it to the current Xoops database
Tags:
Parameters
string |
$sqlFile |
url (relative to XOOPS_ROOT_PATH) of sql file to process (no leading slash) |
string |
$errorPage |
url (relative to XOOPS_ROOT_PATH) of page to redirect to if an error occurs (no leading slash) |
|
|