CDM
[ class tree: CDM ] [ index: CDM ] [ all elements ]

Procedural File: functions.php

Source Location: /modules/xbs_cdm/include/functions.php



Page Details:

API Functions



Tags:

copyright:  (c) 2004 Ashley Kitson, Great Britain
author:  Ashley Kitson http://xoobs.net








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
[ Top ]



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:

return:  The code value


Parameters

string   $codeSet   Name of code set
string   $codeKey   Name of code
string   $lang   Language set for code set
[ Top ]



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
[ Top ]



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
[ Top ]



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:

return:  The parameter string for the code


Parameters

string   $codeSet   Name of code set
string   $codeKey   Name of code
string   $lang   Language set for code set
[ Top ]



getXoopsUser [line 137]

string getXoopsUser( int $id)

Return a valid xoops user name given the user id



Tags:

return:  Xoops real name if available else the logon/username
global:  xoopsUser $xoopsUser: Xoops user object


Parameters

int   $id   Xoops user id
[ Top ]



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:

return:  Processing messages for display on Success else no return and redirect to specified page
version:  1


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)
[ Top ]



Documentation generated on Fri, 03 Mar 2006 08:56:04 +0000 by phpDocumentor 1.3.0RC3