IP_match
addArtspec
array_csort
array_search_recursive
backToMainArea
buildArticleSelect
buildCategorySelect
buildStackString
cDeprecated
cDie
cError
cIDNADecode
cIDNAEncode
cInitializeArrayKey
cWarning
callPluginStore
checkMySQLConnectivity
cleanupSessions
createRandomName
defineIfNotDefined
define_if
deleteArtspec
deleteSystemProperty
displayDatetime
displayPlugin
endAndLogTiming
fakeheader
getAllClientsAndLanguages
getArtspec
getAvailableContentTypes
getCanonicalDay
getCanonicalMonth
getClientName
getEffectiveSetting
getEffectiveSettingsByType
getFileExtension
getGroupOrUserName
getIDForArea
getLanguageNamesByClient
getLanguagesByClient
getNamedFrame
getParentAreaId
getPhpModuleInfo
getSystemProperties
getSystemPropertiesByType
getSystemProperty
getmicrotime
htmldecode
humanReadableSize
human_readable_size
includePlugins
ipMatch
isAlphanumeric
isArtInMultipleUse
isGroup
isImageMagickAvailable
isRunningFromWeb
isUtf8
isValidMail
is_alphanumeric
is_dbfs
is_utf8
locale_arsort
markSubMenuItem
notifyOnError
recursive_copy
rereadClients
scanPlugins
sendEncodingHeader
sendPostRequest
setArtspecDefault
setArtspecOnline
setHelpContext
setSystemProperty
set_magic_quotes_gpc
showLocation
showTable
startTiming
str_ireplace_once
str_ireplace_once_reverse
str_rpos
trim_array
updateClientCache
$constant
IP_match($network, $mask, $ip)
deprecated | [2012-08-02] Use ipMatch() instead |
---|
addArtspec(string $artspectext, int $online) : void
string
specification text
int
Online status (1 or 0)
array_csort()
deprecated | [2012-08-02] Use cArray::csort() instead |
---|
array_search_recursive($search, $array, $partial, $strict)
deprecated | [2012-08-02] Use cArray::searchRecursive() instead |
---|
backToMainArea(bool $send)
bool
Redirect Yes/No
buildArticleSelect(string $sName, string $iIdCat, string $sValue) : string
string
Name of the SelectBox
string
category id
string
Value of the SelectBox
string
HTMLbuildCategorySelect(string $sName, string $sValue, int $sLevel, string $sStyle) : string
string
Name of the SelectBox
string
Value of the SelectBox
int
Value of highest level that should be shown
string
Optional style informations for select
string
HTMLbuildStackString(int $startlevel) : string
"\tfunction1() called in file $filename($line)" "\tfunction2() called in file $filename($line)" ...
int
The startlevel. Note that 0 is always buildStackString and 1 is the function called buildStackString (e.g. cWarning)
string
cDeprecated($message) : void
cDie(string $file, int $line, string $message)
Logs the message and calls die().
string
File name (use FILE)
int
Line number (use LINE)
string
Message to display
cError(\Multiple $file, $line, $message)
Examples:
// New version cWarning('Some error message'); // Old version cWarning(__FILE__, __LINE__, 'Some error message');
\Multiple
parameters
cIDNADecode($targetEncoding, $string)
deprecated | [2011-08-24] This function is not supported any longer |
---|
cIDNAEncode($sourceEncoding, $string)
deprecated | [2011-08-24] This function is not supported any longer |
---|
cInitializeArrayKey($aArray, $sKey, $mDefault)
deprecated | 2012-09-05 use function located in cArray instead of this function |
---|
cWarning()
Examples:
// New version cWarning('Some warning message'); // Old version cWarning(__FILE__, __LINE__, 'Some warning message');
callPluginStore(string $entity)
string
Name of the directory to scan
checkMySQLConnectivity()
deprecated | [2012-01-18] cDb performs the check for itself. This method is no longer needed |
---|
cleanupSessions()
As we are probably soon rewriting the session management, this hack is OK.
deprecated | [2012-07-??] PHP will handle cleaning up sessions |
---|
createRandomName(int $nameLength) : string
int
Length of the generated string
string
Random namedefineIfNotDefined(string $constant, mixed $value)
string
Name of constant to define
mixed
It's value
define_if($constant, $value)
deprecated | [2012-08-02] Use defineIfNotDefined() instead |
---|
deleteArtspec(int $idartspec) : void
int
article specification id
deleteSystemProperty(string $type, string $name) : bool
string
The type of the item
string
The name of the item
bool
displayDatetime(mixed $timestamp, bool $date, bool $time) : string
mixed
a timestamp. If no value is given the current time will be used.
bool
if true the date will be included in the string
bool
if true the time will be included in the string
string
the formatted timestring.displayPlugin($entity, $form)
deprecated | [2012-02-26] Function does not work and is not longer supported |
---|
endAndLogTiming($uuid)
int UUID which has been used for timing
fakeheader($time)
deprecated | [2012-03-05] This function is not longer supported. |
---|
getAllClientsAndLanguages() : array
array
Indexed array where the value is an assoziative array as
follows:
- $arr[0]['idlang'] - $arr[0]['langname'] - $arr[0]['idclient'] - $arr[0]['clientname']
getArtspec() : array
array
list of article specificationsgetAvailableContentTypes(int $idartlang) : void
Creates an array $a_content[type][number] = content string f.e. $a_content['CMS_HTML'][1] = content string Same for array $a_description
int
Language specific ID of the arcticle
getCanonicalDay(int $iDay) : string
int
The day number of date(w)
string
Dayname of current languagegetCanonicalMonth(int $month) : string
int
string
getClientName($idclient)
deprecated | [2012-06-21] Use cApiClientCollection->getClientname() |
---|
getEffectiveSetting(string $type, string $name, string $default) : mixed
The order is: System => Client => Group => User
System properties can be overridden by the group, and group properties can be overridden by the user.
string
The type of the item
string
The name of the item
string
Optional default value
mixed
boolean false if nothing was foundgetEffectiveSettingsByType(string $type) : array
The order is: System => Client => Group => User
System properties can be overridden by the group, and group properties can be overridden by the user.
string
The type of the item
array
ValuegetFileExtension($filename)
deprecated | [2012-06-20] Use getFileType() from functions.file.php |
---|
getGroupOrUserName($uid)
getIDForArea(int | string $area) : int
int
string
Area name or id
int
stringgetLanguageNamesByClient(int $client) : array
int
array
List of languages where the key is the language id and value
the language namegetLanguagesByClient(int $client) : array
int
array
getNamedFrame(int $frame) : string
int
Frame number
string
Canonical name of the framegetParentAreaId(mixed $area) : int
mixed
int
getPhpModuleInfo($moduleName)
deprecated | [2012-03-10] This function is not longer supported. |
---|
getSystemProperties(bool $bGetPropId) : array
Array format:
$array[$type][$name] = $value;
modified | Timo Trautmann 22.02.2008 Support for editing name and type editing by primaray key idsystemprop if bGetPropId is set: $array[$type][$name][value] = $value; $array[$type][$name][idsystemprop] = $idsystemprop; |
---|
bool
If true special mode is activated which generates for each property a third array, which also contains idsystemprop value
array
getSystemPropertiesByType(string $type) : array
string
The type of the properties
array
Assoziative array like $arr[name] = valuegetSystemProperty(string $type, string $name) : string
string
The type of the item
string
The name of the item
string
bool property value or false if nothing was foundgetmicrotime()
htmldecode($string)
humanReadableSize($number)
human_readable_size($number)
deprecated | [2012-08-02] Use humanReadableSize() instead |
---|
includePlugins($entity)
Name of the directory to scan
ipMatch(string $network, string $mask, string $ip) : boolean
string
string
string
boolean
isAlphanumeric(mixed $test, bool $umlauts) : bool
mixed
Value to test
bool
[Use german Umlaute] Optional
bool
Value is alphanumericisArtInMultipleUse(int $idart) : bool
int
Article-Id
bool
Article assigned to multiple categoriesisGroup($uid)
isImageMagickAvailable()
deprecated | [2012-06-21] Use capiIsImageMagickAvailable() from functions.api.images.php |
---|
isRunningFromWeb() : bool
bool
True if the script is running from the webisUtf8(string $input) : bool
string
bool
isValidMail(string $email, bool $strict)
string
bool
No more used!
is_alphanumeric($test, $umlauts)
deprecated | [2012-08-02] Use isAlphanumeric() instead |
---|
is_dbfs($file)
deprecated | [2012-06-20] Use cApiDbfs::isDbfs() |
---|
is_utf8($input)
deprecated | [2012-08-02] Use isUtf8() instead |
---|
locale_arsort($locale, $array)
deprecated | [2012-08-02] Use cArray::sortWithLocale() instead |
---|
markSubMenuItem(int $menuitem, bool $return)
int
Which menuitem to mark
bool
Return or echo script
notifyOnError($errortitle, $errormessage)
deprecated | 2012-09-04 Use cWarning or the like. |
---|
recursive_copy($from_path, $to_path)
deprecated | [2012-06-20] Use getFileType() from functions.file.php |
---|
rereadClients()
deprecated | no longer needed |
---|
scanPlugins(string $entity) : void
Result: $cfg['plugins']['frontendusers'] => array with all found plugins
Note: Plugins are only "found" if the following directory structure if found:
entity/ plugin1/plugin1.php plugin2/plugin2.php
The plugin's directory and file name have to be the same, otherwise the function won't find them!
string
Name of the directory to scan
sendEncodingHeader(\cDb $db, array $cfg, int $lang, string $contentType)
Based on this informations it will send an HTTP header for right encoding.
array
Global cfg-array
int
Global language id
string
Mime type
sendPostRequest($host, $path, $data, $referer, $port)
deprecated | 2011-08-23 This function is not supported any longer |
---|
setArtspecDefault(int $idartspec) : void
While creating a new article this defined article specification will be default setting
int
Article specification id
setArtspecOnline(int $idartspec, int $online) : void
Flag to switch if an article specification should be shown the frontend or not
int
article specification id
int
0/1 switch the status between on an offline
setHelpContext($area)
setSystemProperty(string $type, string $name, string $value, int $idsystemprop)
modified | Timo Trautmann 22.02.2008 Support for editing name and type |
---|
string
The type of the item
string
The name of the item
string
The value of the item
int
The sysprop id, use optional. If set it allows to modify type name and value
set_magic_quotes_gpc(string $code)
string
String by reference
showLocation($area)
deprecated | [2011-09-02] This function is not supported any longer |
---|
showTable($tablename)
deprecated | [2011-08-23] This function is not supported any longer |
---|
startTiming(string $function, array $parameters) : int
string
Name of the function
array
All parameters for the function to measure
int
uuid for this measure processstr_ireplace_once($find, $replace, $subject)
deprecated | [2012-08-02] Use cString::iReplaceOnce() instead |
---|
str_ireplace_once_reverse($find, $replace, $subject)
deprecated | [2012-08-02] Use cString::iReplaceOnceReverse() instead |
---|
str_rpos($haystack, $needle, $start)
deprecated | [2012-08-02] Use cString::posReverse() instead |
---|
trim_array($array)
deprecated | [2012-08-02] Use cArray::trim() instead |
---|
updateClientCache(\number $idclient, string $htmlpath, string $frontendpath)
Reinitializes the $cfgClient array and fills it wih updated information if provided.
\number
client id which will be updated
string
new HTML path. Starting with "http://"
string
path the to the frontend
$constant