IP_match($network, $mask, $ip)
deprecated | [2012-08-02] Use ipMatch() instead |
---|
__cmp($a, $b)
_error_report($error)
deprecated | 2011-09-02 this function is not supported any longer |
---|
_processCmsTags(array $aList, array | array $contentList, bool $saveKeywords, $layoutCode)
.. tags within passed code
array
CMS_...tags list
array
array
all CMS variables
bool
Flag to save collected keywords during replacement process.
_swiftmailer_init()
_swiftmailer_init()
addArtspec(string $artspectext, int $online) : void
string
specification text
int
Online status (1 or 0)
addslashes_deep(mixed $value) : array
mixed
Either a string or a multi-dimensional array of values
array
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
HTMLbuildCategorySelectRights() : string
string
HTMLbuildHeapTable(string $sHeapTable, \cDb $db) : void
buildStackString(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
buildTree($rootItem, $items)
buildUserOrGroupPermsFromRequest(bool $bAddUserToClient) : array
todo | Do we really need to add other perms, if the user/group gets the 'sysadmin' permission? |
---|
bool
Flag to add current user to current client, if no client is specified.
array
cApiCatGetLevelNode(int $idcat, int $minLevel) : int
Example: + Category A (15) |-+ News (16) | |- News A (17) + Category B (18) |-+ Internal (19)
Given you are in the leaf "News A" (idcat 17), and you want to get out in which "main" tree you are, you can call the function like this:
cApiCatGetLevelNode(17,1);
The example would return "Category A" (idcat 15). If you specify an invalid level, the results are undefined.
int
The category number
int
The level to extract
int
The category node on a specific levelcApiImageCheckCachedImageValidity(string $cacheFile, int $cacheTime) : bool
string
int
bool
Returns true, if cache file exists and7or is still valid or falsecApiImageCheckImageEditingPosibility() : mixed
mixed
Information about installed image editing extensions/tools
- 'im' ImageMagick is available and usage is enabled - '2' GD library version 2 is available - '1' GD library version 1 is available - '0' Nothing could detected
cApiImageGetCacheFileName(string $md5, string $filetype, bool $keepType) : string
string
string
bool
string
cApiImageGetTargetDimensions(int $x, int $y, int $maxX, int $maxY, bool $expand) : array
int
int
int
int
bool
array
Index 0 is target X and index 1 is target YcApiImageIsAnimGif(string $sFile) : bool
string
file path
bool
True (gif is animated)/ false (single frame gif)cApiImgScale(string $img, int $maxX, int $maxY, bool $crop, bool $expand, int $cacheTime, bool $wantHQ, int $quality, bool $keepType) : string
If scaling, the aspect ratio is maintained.
This function chooses the best method to scale, depending on the system environment and/or the parameters.
Returns the path to the scaled temporary image.
Note that this function does some very poor caching; it calculates an md5 hash out of the image plus the maximum X and Y sizes, and uses that as the file name. If the file is older than 10 minutes, regenerate it.
string
The path to the image (relative to the frontend)
int
The maximum size in x-direction
int
The maximum size in y-direction
bool
If true, the image is cropped and not scaled.
bool
If true, the image is expanded (e.g. really scaled). If false, the image will only be made smaller.
int
The number of minutes to cache the image, use 0 for unlimited
bool
If true, try to force high quality mode
int
The quality of the output file
bool
If true and a png file is source, output file is also png
string
Path to the resulting imagecApiImgScaleGetMD5CacheFile(string $sImg, int $iMaxX, int $iMaxY, bool $bCrop, bool $bExpand) : string
string
Path to upload image
int
Maximum image x size
int
Maximum image y size
bool
Flag to crop image
bool
Flag to expand image
string
Path to the resulting imagecApiImgScaleHQ(string $img, int $maxX, int $maxY, bool $crop, bool $expand, int $cacheTime, int $quality, bool $keepType) : string
If scaling, the aspect ratio is maintained.
Note: GDLib 2.x is required!
Returns the path to the scaled temporary image.
Note that this function does some very poor caching; it calculates an md5 hash out of the image plus the maximum X and Y sizes, and uses that as the file name. If the file is older than the specified cache time, regenerate it.
string
The path to the image (relative to the frontend)
int
The maximum size in x-direction
int
The maximum size in y-direction
bool
If true, the image is cropped and not scaled.
bool
If true, the image is expanded (e.g. really scaled). If false, the image will only be made smaller.
int
The number of minutes to cache the image, use 0 for unlimited
int
The quality of the output file
bool
If true and a png file is source, output file is also png
string
Url to the resulting image (http://...)cApiImgScaleImageMagick(string $img, int $maxX, int $maxY, bool $crop, bool $expand, int $cacheTime, int $quality, bool $keepType) : string
If scaling, the aspect ratio is maintained.
Note: ImageMagick is required!
Returns the path to the scaled temporary image.
Note that this function does some very poor caching; it calculates an md5 hash out of the image plus the maximum X and Y sizes, and uses that as the file name. If the file is older than the specified cache time, regenerate it.
string
The path to the image (relative to the frontend)
int
The maximum size in x-direction
int
The maximum size in y-direction
bool
If true, the image is cropped and not scaled.
bool
If true, the image is expanded (e.g. really scaled). If false, the image will only be made smaller.
int
The number of minutes to cache the image, use 0 for unlimited
int
The quality of the output file
bool
If true and a png file is source, output file is also png
string
Url to the resulting image (http://...)cApiImgScaleLQ(string $img, int $maxX, int $maxY, bool $crop, bool $expand, int $cacheTime, int $quality, bool $keepType) : string
If scaling, the aspect ratio is maintained.
Returns the path to the scaled temporary image.
Note that this function does some very poor caching; it calculates an md5 hash out of the image plus the maximum X and Y sizes, and uses that as the file name. If the file is older than 10 minutes, regenerate it.
string
The path to the image (relative to the frontend)
int
The maximum size in x-direction
int
The maximum size in y-direction
bool
If true, the image is cropped and not scaled.
bool
If true, the image is expanded (e.g. really scaled). If false, the image will only be made smaller.
int
The number of minutes to cache the image, use 0 for unlimited
int
The quality of the output file
bool
If true and a png file is source, output file is also png
string
url to the resulting image (http://...cApiIsImageMagickAvailable() : bool
bool
true if ImageMagick is availablecApiStrCleanURLCharacters(string $sString, bool $bReplace) : string
This function removes or converts all characters which can make an URL invalid.
Clean characters include: - All characters between 32 and 126 which are not alphanumeric and aren't one of the following: _-.
string
The string to operate on
bool
If true, all "unclean" characters are replaced
string
The resulting stringcApiStrNormalizeLineEndings(string $sString, string $sLineEnding) : string
string
string
Feasible values are "\n", "\r" or "\r\n"
string
cApiStrRecodeString(string $sString, string $sourceEncoding, string $targetEncoding) : string
This function tries to detect which function to use (either recode or iconv).
If $sourceEncoding and $targetEncoding are the same, this function returns immediately.
For more information about encodings, refer to http://en.wikipedia.org/wiki/Character_encoding
For more information about the supported encodings in recode, refer to http://www.delorie.com/gnu/docs/recode/recode_toc.html
Note: depending on whether recode or iconv is used, the supported charsets differ. The following ones are commonly used and are most likely supported by both converters:
todo | Check if the charset names are the same for both converters |
---|---|
todo | Implement a converter and charset checker to ensure compilance. |
string
The string to operate on
string
The source encoding (default: ISO-8859-1)
string
The target encoding (if false, use source encoding)
string
The resulting stringcApiStrReplaceDiacritics(string $sString, string $sourceEncoding, string $targetEncoding) : string
For german umlauts, this function converts the umlauts to their ASCII equalients (e.g. � => ae).
For more information about diacritics, refer to http://en.wikipedia.org/wiki/Diacritic
For other languages, the diacritic marks are removed, if possible.
string
The string to operate on
string
The source encoding (default: ISO-8859-1)
string
The target encoding (default: ISO-8859-1)
string
The resulting stringcApiStrTrimAfterWord(string $string, int $maxlen) : string
Warning: Currently, this function uses a regular ASCII-Whitespace to do the seperation test. If you are using ' ' to create spaces, this function will fail.
Example: $string = "This is a simple test"; echo cApiStrTrimAfterWord ($string, 15);
This would output "This is a", since this function respects word boundaries and doesn't operate beyond the limit given by $maxlen.
string
The string to operate on
int
The maximum number of characters
string
The resulting stringcApiStrTrimHard(string $string, int $maxlen, $fillup) : string
If the string is longer than $maxlen, dots are inserted ("...") right before $maxlen.
Example: $string = "This is a simple test"; echo cApiStrTrimHard ($string, 15);
This would output "This is a si...", since the string is longer than $maxlen and the resulting string matches 15 characters including the dots.
string
The string to operate on
int
The maximum number of characters
string
The resulting stringcApiStrTrimSentence(string $string, int $approxlen, bool $hard) : string
Sentence boundaries are preserved.
The algorythm inside calculates the sentence length to the previous and next sentences. The distance to the next sentence which is smaller will be taken to trim the string to match the approximate length parameter.
Example:
$string = "This contains two sentences. "; $string .= "Lets play around with them. ";
echo cApiStrTrimSentence($string, 40); echo cApiStrTrimSentence($string, 50);
The first example would only output the first sentence, the second example both sentences.
Explanation:
To match the given max length closely, the function calculates the distance to the next and previous sentences. Using the maxlength of 40 characters, the distance to the previous sentence would be 8 characters, and to the next sentence it would be 19 characters. Therefore, only the previous sentence is displayed.
The second example displays the second sentence also, since the distance to the next sentence is only 9 characters, but to the previous it is 18 characters.
If you specify the boolean flag "$hard", the limit parameter creates a hard limit instead of calculating the distance.
This function ensures that at least one sentence is returned.
string
The string to operate on
int
The approximate number of characters
bool
If true, use a hard limit for the number of characters
string
The resulting stringcCatPerm($widcat, $db)
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
cHandler_ItemArea($sName, $aAttribs, $sContent)
deprecated | 2012-03-03 Not supported any longer. |
---|
cHandler_ItemData($sName, $aAttribs, $sContent)
deprecated | 2012-03-03 Not supported any longer. |
---|
cHandler_ItemName($sName, $aAttribs, $sContent)
deprecated | 2012-03-03 Not supported any longer. |
---|
cHandler_ModuleData($sName, $aAttribs, $sContent)
deprecated | 2012-03-03 Not supported any longer. |
---|
cHandler_Translation($sName, $aAttribs, $sContent)
deprecated | 2012-03-03 Not supported any longer. |
---|
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 |
---|
cInclude(string $sWhere, string $sWhat, bool $bForce, string $bReturnPath) : void
Example: cInclude('classes', 'class.backend.php');
Currently defined areas:
frontend Path to the current frontend conlib Path to conlib [deprecated] pear Path to the bundled pear copy [deprecated] classes Path to the CONTENIDO classes (see NOTE below) cronjobs Path to the cronjobs external Path to the external tools includes Path to the CONTENIDO includes scripts Path to the CONTENIDO scripts module Path to module
NOTE: Since CONTENIDO (since v 4.9.0) provides autoloading of required class files, there is no need to load CONTENIDO class files of by using cInclude().
string
The area which should be included
string
The filename of the include
bool
If true, force the file to be included
string
Flag to return the path instead of including the file
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');
calcDensity($singlewordcounter, $string, $quantifier)
callPluginStore(string $entity)
string
Name of the directory to scan
capi_cat_getlevelnode($idcat, $minLevel)
deprecated | [2012-06-23] Use cApiCatGetLevelNode() |
---|
cecCreateBaseHref($sCurrentBaseHref)
cecFrontendCategoryAccess($idlang, $idcat, $user)
cecFrontendCategoryAccess_Backend($idlang, $idcat, $user)
checkCatPermission($idcatlang, $public)
checkImageEditingPosibility()
deprecated | [2012-06-23] Use cApiImageCheckImageEditingPosibility() |
---|
checkLangInClients(array $aClients, integer $iLang, array $aCfg, object $oDb) : boolean
array
integer
array
object
boolean
- status (if language id corresponds to list of clients true
otherwise false)checkLinks()
checkMySQLConnectivity()
deprecated | [2012-01-18] cDb performs the check for itself. This method is no longer needed |
---|
checkPathInformation(string $strConUrl, string $strBrowserUrl) : string
string
CONTENIDO fullhtmlPath
string
current browser string
string
Status of path comparementcleanupSessions()
As we are probably soon rewriting the session management, this hack is OK.
deprecated | [2012-07-??] PHP will handle cleaning up sessions |
---|
compareUrlStrings($arrConUrl, $arrBrowserUrl, $isIP)
checks two path informations against each other to get potential nonconformities
conChangeTemplateForCat(int $idcat, int $idtpl)
int
Category Id
int
Template Id
conCopyArtLang(int $srcidart, int $dstidart, int $newtitle, int $useCopyLabel)
global | array $cfg |
---|---|
global | int $lang |
int
int
int
int
conCopyArticle(int $srcidart, int $targetcat, string $newtitle, bool $useCopyLabel) : bool
global | object $auth |
---|
int
int
string
bool
bool
conCopyContainerConf(int $srcidtplcfg, int $dstidtplcfg)
int
int
conCopyContent(int $srcidartlang, int $dstidartlang)
int
int
conCopyMetaTags(int $srcidartlang, int $dstidartlang)
int
int
conCopyTemplateConfiguration(int $srcidtplcfg)
int
conCreateLocationString(int $idcat, string $seperator, string $catStr, bool $makeLink, string $linkClass, int $firstTreeElementToUse, int $uselang, bool $final, bool $usecache) : string
int
ID of the starting category
string
Seperation string
string
Category location string (by reference)
bool
Create location string with links
string
Stylesheet class for the links
int
First navigation Level location string should be printed out (first level = 0!!)
int
Id of language
bool
bool
string
Location stringconDeeperCategoriesArray(int $idcat) : array
int
Id of category
array
Array with all deeper categoriesconDeleteart(int $idart)
int
Article Id
conEditArt(mixed $idcat, $idcatnew, $idart, $isstart, $idtpl, $idartlang, $idlang, $title, $summary, $artspec, $created, $lastmodified, $author, $online, $datestart, $dateend, $artsort, $keyart, $searchable, $sitemapprio, $changefreq) : void
mixed
many
conEditFirstTime(mixed $idcat, $idcatnew, $idart, $isstart, $idtpl, $idartlang, $idlang, $title, $summary, $artspec, $created, $lastmodified, $author, $online, $datestart, $dateend, $artsort, $keyart, $searchable, $sitemapprio, $changefreq) : int
mixed
many
int
Id of the new articleconFetchCategoryTree(int $client, int $lang) : array
int
Uses global set client if not set
int
Uses global set language if not set
array
conFlagOnOffline()
conGenerateCode(int $idcat, int $idart, int $lang, int $client, int $layout, bool $save, $contype) : string
int
Id of category
int
Id of article
int
Id of language
int
Id of client
int
Layout-ID of alternate Layout (if false, use associated layout)
bool
Flag to persist generated code in database
string
The generated code or "0601" if neither article nor category configuration
was foundconGenerateCodeForAllArts()
conGenerateCodeForAllArtsInCategory(int $idcat)
int
Category ID
conGenerateCodeForAllArtsUsingTemplate(int $idtpl)
int
Template-Id
conGenerateCodeForAllartsUsingLayout(int $idlay)
int
Layout-ID
conGenerateCodeForAllartsUsingMod(int $idmod)
int
Module id
conGenerateCodeForArtInAllCategories(int $idart)
int
Article ID
conGenerateCodeForClient()
conGenerateKeywords(int $client, int $lang) : void
author | Willi Man Created : 12.05.2004 Modified : 13.05.2004 |
---|---|
copyright | four for business AG 2003 |
int
Client
int
Language of a client
conGetAvailableMetaTagTypes() : array
array
Assoziative meta tags listconGetCategoryArticleId(int $idcat, int $idart) : int | null
int
int
int
null
conGetCategoryAssignments(int $idart, \cDb | null $db) : array
int
Article ID
array
Flat array which contains all category id'sconGetContainerConfiguration(int $idtplcfg) : array
int
Template configuration id
array
Assoziative array where the key is the number and value the container
configurationconGetContentFromArticle(int $iIdArtLang) : array
int
ArticleLanguageId of an article (idartlang)
array
Array with content of an article indexed by content-types as follows:
- $arr[type][typeid] = value;conGetHtmlTranslationTable($table, $flags)
conGetMetaValue(int $idartlang, int $idmetatype) : string
int
ID of the article
int
Metatype-ID
string
conGetTemplateConfigurationIdForArticle(int $idart, int $idcat, int $lang, int $client) : int | null
int
int
NOT used
int
int
int
null
conGetTemplateConfigurationIdForCategory(int $idcat, int $lang, int $client) : int | null
int
int
int
int
null
conGetTopmostCat(int $idcat, int $minLevel) : int
todo | Returns something.... |
---|---|
global | array $cfg |
global | int $client |
global | int $lang |
int
int
int
conGetUsedModules(int $idtpl) : array
int
Template id
array
Assoziative array where the key is the number and value the module idconHtmlEntityDecode($value, $flags, $encoding)
conHtmlSpecialChars($value, $flags, $encoding)
conHtmlentities($value, $flags, $encoding)
conIsLocked(int $idart, int $lang) : bool
int
Article Id
int
Language Id
bool
conLock(int $idart, \ing $lang)
int
Article Id
\ing
Language Id
conLockBulkEditing(array $idarts, int $idlang, bool $lock)
array
All articles
int
bool
conMakeArticleIndex($idartlang, integer $idart)
added by stese removed from function conSaveContentEntry before Touch the article to update last modified date
see | \global\conSaveContentEntry |
---|
integer
conMakeCatOnline(int $idcat, int $lang, int $status)
int
Id of the category
int
Id of the language
int
Status of the category
conMakeOnline(int $idart, \ing $lang)
int
Article Id
\ing
Language Id
conMakeOnlineBulkEditing(array $idarts, int $idlang, bool $online)
array
All articles
int
bool
conMakePublic(int | int $idcat, $lang, bool $public)
Almost the same function as strMakePublic in functions.str.php (conDeeperCategoriesArray instead of strDeeperCategoriesArray)
int
int
Category Id
bool
Public status of the Article
conMakeStart(int $idcatart, bool $isstart)
fixme | Do we still need the isstart. The old start compatibility has already been removed... |
---|
int
Idcatart of the article
bool
Start article flag
conMoveArticles()
conPhp54Check()
conRemoveOldCategoryArticle(int $idcat, int $idart, int $idartlang, int $client, int $lang)
global | array $cfgClient |
---|
int
int
int
int
int
conSaveContentEntry(int $idartlang, string $type, int $typeid, string $value, bool $bForce) : void
int
idartlang of the article
string
Type of content element
int
Serial number of the content element
string
Content
bool
Not used: Was a flag to use existing db instance in global scope
conSetCodeFlag(int $idcatart)
int
Category article id
conSetCodeFlagBulkEditing(array $idcatarts)
array
List of category article ids
conSetMetaValue(int $idartlang, int $idmetatype, string $value) : bool
int
ID of the article
int
Metatype-ID
string
Value of the meta tag
bool
whether the meta value has been saved successfullyconSyncArticle(int $idart, int $srclang, int $dstlang) : void
int
Article id
int
Source language id
int
Destination language id
contenido_include($sWhere, $sWhat, $bForce, $bReturnPath)
deprecated | 2012-09-12 |
---|
copyRightsForElement(string $area, int $iditem, int $newiditem, int $idlang) : bool
author | Martin Horwath |
---|---|
author | Murat Purc |
copyright | dayside.net |
string
Main area name (e. g. 'lay', 'mod', 'str', 'tpl', etc.)
int
ID of element to copy
int
ID of the new element
int
ID of language, if passed only rights for this language will be created, otherwhise for all existing languages
bool
True on success otherwhise falsecreateBulkEditingFunction(string $class, string $imageSrc, string $alt, string $onclick) : string
string
the class for the link
string
the path to the image
string
the alt tag for the image
string
[optional] the onlick attribute for the link
string
rendered HTML codecreateFile(string $filename, string $path) : \(void | \bool)
Exits the script, if filename is not valid or creation (touch or chmod) fails!
deprecated | [2012-07-04] These functions are now in cFileHandler |
---|
string
The file to create
string
Path to the file
\(void
\bool)
Either true on success or nothingcreateNewWorkflow()
createRandomName(int $nameLength) : string
int
Length of the generated string
string
Random namecreateRightsForElement(string $area, int $iditem, int $idlang) : bool
author | Martin Horwath |
---|---|
author | Murat Purc |
copyright | dayside.net |
string
Main area name (e. g. 'lay', 'mod', 'str', 'tpl', etc.)
int
ID of new element
int
ID of language, if passed only rights for this language will be created, otherwhise for all existing languages
bool
True on success otherwhise falsedbGetIndexes(\cDb $db, string $table) : array
\cDb
string
array
Assoziative array where the key and the value is the index namedbUpdateSequence($sequencetable, $table, $db)
deprecated | 2012-03-04 This function is not longer supported. |
---|
dbUpgradeTable(\cDb $db, string $table, string $field, string $type, string $null, string $key, string $default, string $extra, string $upgradeStatement, bool $bRemoveIndexes) : bool
Used e. g. by CONTENIDO setup to create or update tables. Function logic: 1 .) Check, if the table exists 2a.) If not, create it with the field specification, exit 2b.) If the table exists, check, if the field exist 3 .) If not, try to find the field using previous names (if specified in $field like 'name1,name2') 4a.) If the field hasn't been found, create the field as specified, exit 4b.) If the field has been found using a previous name (if specified) rename the column to $field 5 .) As the field has been found, check, if the field's type is matching 5a.) If the type is matching, exit 5b.) If the field's content type is not matching, try to convert first (e.g. string to int or int to string), then use the upgrade statement if applicable
Note about the upgrade statement: - the code must be eval'able - the code needs to read $oldVal (old field value) and needs to set $newVal (value to which the field will be set) - $oldVal might be empty if the field didn't exist - $tableValues['fieldname'] contains the already existing values
string
Name of table to create/update
string
Name of field to create/update
string
Data type of field. Feasible values are all possible data types e. g. int(10), varchar(32), datetime, varchar(255), text, tinyint(1)
string
Parameter to forbid null values, feasible values '', 'NULL' or 'YES' where 'NULL' or 'YES' allows null values and '' doesn't
string
The field will be added as a primary key, if value is 'PRI', otherwhise the value should be empty ''
string
The default value for the field. Feasible is each possible value depending on passed $type
string
Additional info for the field, e. g. 'auto_increment', if the field should have the AUTO_INCREMENT attribute and empty otherwise.
string
NOT USED AT THE MOMENT
bool
Flag to remove all indexes
bool
debug($string)
decDate($dateArr, $amount, $unit, $PC_debug)
defineIfNotDefined(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
deleteRightsForElement(string $area, int $iditem, int $idlang)
author | Martin Horwath |
---|---|
author | Murat Purc |
copyright | dayside.net |
string
main area name
int
ID of new element
int
ID of lang parameter
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 |
---|
doWorkflowAction($idartlang, $action)
domxml_new_doc($version)
deprecated | 2011-09-02 this function is not supported any longer |
---|
domxml_new_xmldoc($version)
deprecated | 2011-09-02 this function is not supported any longer |
---|
domxml_open_file($filename, $mode, $error)
deprecated | 2011-09-02 this function is not supported any longer |
---|
domxml_open_mem($str, $mode, $error)
deprecated | 2011-09-02 this function is not supported any longer |
---|
domxml_xslt_stylesheet($xslstring)
deprecated | 2011-09-02 this function is not supported any longer |
---|
domxml_xslt_stylesheet_doc($dom_document)
deprecated | 2011-09-02 this function is not supported any longer |
---|
domxml_xslt_stylesheet_file($xslfile)
deprecated | 2011-09-02 this function is not supported any longer |
---|
editWorkflowStep($idworkflowitem)
emptyLogFile() : string
string
Message if clearing was successfull or notendAndLogTiming($uuid)
int UUID which has been used for timing
extractNumber(string $string)
string
String var by reference
fakeheader($time)
deprecated | [2012-03-05] This function is not longer supported. |
---|
fileEdit(string $filename, string $sCode, string $path) : \(string | \void)
Exits the script, if file could not opened!
deprecated | [2012-07-04] These functions are now in cFileHandler |
---|
string
The file to write the content
string
File content to write
string
Path to the file
\(string
\void)
Either content of file o nothingfileGetMimeContentType(string $file) : string | null
deprecated | [2012-07-04] These functions are now in cFileHandler |
---|
string
Full path and name of file
string
null
MIME content-type on success, or nullfileValidateFilename(string $filename, bool $notifyAndExitOnFailure) : \(void | \bool)
Filename can contain alphanumeric characters, dot, underscore or a hyphen.
Exits the script, if second parameter is set to true and validation fails!
deprecated | 2012-08-16 Use cFileHandler::validateFilename instead |
---|
string
The filename to validate
bool
Flag to display notification and to exit further script execution, ifd validation fails
\(void
\bool)
Either validation result or nothing (depends on second parameter)formGenerateCheckbox($name, $value, $checked, $caption) : \Generated
author | Timo A. Hummel <Timo.Hummel@4fb.de> |
---|---|
copyright | four for business AG |
Name of the checkbox
Value of the checkbox
Initially checked?
\Generated
field codeformGenerateField($type, $name, $initvalue, $width, $maxlen) : \Generated
author | Timo A. Hummel <Timo.Hummel@4fb.de> |
---|---|
copyright | four for business AG |
Either "text", "password" or "textbox"
Name of the field
Init value of the field
Maximum length of the field
\Generated
field codefrontendusers_groupselect_canonicalVariables()
frontendusers_groupselect_display()
frontendusers_groupselect_getTitle()
frontendusers_groupselect_getvalue($key)
frontendusers_groupselect_store($variables)
frontendusers_groupselect_wantedVariables()
frontendusers_valid_from_display()
frontendusers_valid_from_getTitle()
frontendusers_valid_from_store($variables)
frontendusers_valid_from_wantedVariables()
frontendusers_valid_to_display()
frontendusers_valid_to_getTitle()
frontendusers_valid_to_store($variables)
frontendusers_valid_to_wantedVariables()
generateDisplayFilePath(string $sDisplayPath, int $iLimit) : string
author | Timo Trautmann (4fb) |
---|
string
Original filepath
int
Limit of chars which were displayed directly. If the path string is shorter there will be no tooltipp
string
Contains short path name and tooltipp if neccessarygetActionSelect($idartlang, $idusersequence)
getAktuellType(array $r, array $aList)
.. tags within passed code
array
active CMS variables
array
CMS_...tags list
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']
getArtLang(int $idart, int $idlang) : mixed
author | Timo A. Hummel <Timo.Hummel@4fb.de> |
---|---|
copyright | four for business AG 2003 |
int
ID of the article
int
ID of the language
mixed
idartlang of the article or false if nothing was foundgetArtspec() : 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
getCatLang($idcat, $idlang)
getCategoryName($cat_id, $db)
getCategoryPath($cat_id, $level, $reverse, $db)
getClientName($idclient)
deprecated | [2012-06-21] Use cApiClientCollection->getClientname() |
---|
getCurrentUserSequence(int $idartlang, int $defaultidworkflow) : int | false
int
Article language id
int
Default workflow id
int
false
Id of found user sequence or falsegetDirectorySize(string $sDirectory, bool $bRecursive) : bool | int
AKA the combined filesizes of all files within it. Note that this function uses filesize(). There could be problems with files that are larger than 2GiB
string
The directory
bool
true if all the subdirectories should be included in the calculation
bool
int
Returns false in case of an error or the sizegetEffectiveSetting(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
ValuegetEncodingByLanguage(\cDb $db, int $lang) : string
The parameter $db has to be an instance of cDb (global $db in con) and $cfg is the equivalent to global $cfg array in CONTENIDO. If no encoding is found or any parameter is not valid, the function will return false, otherwise the encoding as string like it is stored in database. modified 18.03.2008 - Removed special mySQl behaviour (using db object instead) Timo Trautmann
int
string
getFileContent(string $filename, string $path) : \(string | \void)
Exits the script, if file could not opened!
deprecated | [2012-07-04] These functions are now in cFileHandler |
---|
string
The file to get the content
string
Path to the file
\(string
\void)
Either content of file o nothinggetFileExtension($filename)
deprecated | [2012-06-20] Use getFileType() from functions.file.php |
---|
getFileInformation(int $iIdClient, string $sFilename, string $sType, \DB_Contenido $oDb) : array
author | Timo Trautmann |
---|
int
string
string
\DB_Contenido
array
Indexes:
idsfi - Primary key of database record
created - Datetime when file was created
lastmodified - Datetime when file was last modified
author - Author of file (CONTENIDO Backend User)
modifiedby - Last modifier of file (CONTENIDO Backend User)
description - Description which was inserted for this filegetFileType(string $filename) : string
string
The file to get the type
string
FiletypegetGroupIDs($db)
getGroupOrUserName($uid)
getIDForArea(int | string $area) : int
int
string
Area name or id
int
stringgetJobFileName($jobname, $PC_writeDir)
getLanguageNamesByClient(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
getLastActialRunTime($jobname, $PC_writeDir)
getLastScheduledRunTime($job, $PC_debug)
getLastWorkflowStatus($idartlang)
getLevel($catid, $db)
getLocationString($iStartCat, $level, $seperator, $sLinkStyleClass, $sTextStyleClass, $fullweblink, $reverse, $mod_rewrite, $db)
getNamedFrame(int $frame) : string
int
Frame number
string
Canonical name of the framegetNextId($row)
getParent($preid, $db)
getParentAreaId(mixed $area) : int
mixed
int
getPhpModuleInfo($moduleName)
deprecated | [2012-03-10] This function is not longer supported. |
---|
getProtectedSubCategories($parent_id, $db)
getProtectedSubTree($idcat_start, $db) : array
copyright | four for business AG |
---|
array
Array with all deeper categoriesgetStrExpandCollapseButton($item, $catName)
getSubCategories($parent_id, $db)
getSubTree($idcat_start, $db) : array
array
Array with all deeper categoriesgetSystemProperties(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 foundgetTemplateSelect()
getTimeUnitSelector($listid, $default)
getUplExpandCollapseButton($item)
getUsers($listid, $default)
getWorkflowForCat($idcat)
getWorkflowForUserSequence($usersequence)
getWorkflowList()
getWorkflowUsers($idworkflowitem)
getmicrotime()
html_doc($html_doc, $from_file)
deprecated | 2011-09-02 this function is not supported any longer |
---|
html_doc_file($filename)
deprecated | 2011-09-02 this function is not supported any longer |
---|
htmldecode($string)
htmlentities_iso88592(string $input) : string
string
string
humanReadableSize($number)
human_readable_size($number)
deprecated | [2012-08-02] Use humanReadableSize() instead |
---|
i18n(string $string, string $domain) : string
Usage: i18n('Your text which has to be translated');
string
The string to translate
string
The domain to look up
string
Returns the translationi18nEmulateGettext(string $string, string $domain) : string
string
The string to translate
string
The domain to look up
string
Returns the translationi18nGetAvailableLanguages() : array
array
All available languagesi18nInit(string $localePath, string $langCode)
string
Path to the locales
string
Language code to set
i18nMatchBrowserAccept(string $accept) : string
string
Language to accept
string
The locale key for the given accept stringi18nRegisterDomain(string $domain, string $localePath) : string
string
Domain to bind to
string
Path to the locales
string
Returns the translationi18nStripAcceptLanguages(string $accept) : array
Example: de,nl;q=0.7,en-us;q=0.3 would become an array with de,nl,en-us
string
Comma searated list of languages to accept
array
array with the short form of the accept languagesincludePlugins($entity)
Name of the directory to scan
installationRoutine(\cGuiPage $page, boolean $isExtracted, string $extractedPath)
\cGuiPage
boolean
string
foldername from extracted plugin
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 alphanumericisAnimGif($sFile)
deprecated | [2012-06-23] Use cApiImageIsAnimGif() |
---|
isArtInMultipleUse(int $idart) : bool
int
Article-Id
bool
Article assigned to multiple categoriesisCurrentEditor($uid)
isGroup($uid)
isIPv4(string $strHostAdress) : bool
string
IP adress
bool
If string is a valid ip or notisImageMagickAvailable()
deprecated | [2012-06-21] Use capiIsImageMagickAvailable() from functions.api.images.php |
---|
isParent($parentid, $catid, $db)
isRunningFromWeb() : bool
bool
True if the script is running from the webisStartArticle(int $idartlang, int $idcat, int $idlang, \cDb | null $db) : bool
global | array $cfg |
---|
int
int
int
bool
isUtf8(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 |
---|
keywordDensity($headline, $text)
lTrimZeros($number)
langActivateDeactivateLanguage(int $idlang, int $active) : bool
int
int
bool
langDeleteLanguage(int $iIdLang, int $iIdClient)
int
Id of the language
int
Id of the client, uses global client id by default
langDuplicateFromFirstLanguage(int $client, int $idlang)
deprecated | [2012-03-05] This function is not longer supported. |
---|
int
Id of the client
int
Id of the language
langEditLanguage(int $idlang, string $langname, string $encoding, int $active, string $direction) : bool
int
string
Name of the language
string
int
Flag for active state, 1 or 0
string
bool
langGetTextDirection(int $idlang, \cDb $db) : string
langNewLanguage(string $name, int $client)
string
Name of the language
int
Id of client
langRenameLanguage(int $idlang, string $name) : bool
int
Id of the language
string
Name of the language
bool
layDeleteLayout(int $idlay) : string
int
the ID of the layout
string
an error code if the layout is still in uselayEditLayout(int $idlay, string $name, string $description, string $code) : int
author | Olaf Niemann <olaf.niemann@4fb.de> @copryright four for business AG <www.4fb.de> |
---|
int
Id of the Layout
string
Name of the Layout
string
Description of the Layout
string
Layout HTML Code
int
$idlay Id of the new or edited Layoutlinksort($sErrors)
locale_arsort($locale, $array)
deprecated | [2012-08-02] Use cArray::sortWithLocale() instead |
---|
logMessage($msg, $PC_writeDir, $PC_useLog, $PC_debug)
mailLogBulkEditingFunctions()
mailLogDecodeAddresses(array $addresses) : string
array
associative array containing the mail addresses as keys and the mailer names as values
string
HTML code showing the given mail addresses and namesmarkLastRun($jobname, $lastRun, $PC_writeDir)
markSubMenuItem(int $menuitem, bool $return)
int
Which menuitem to mark
bool
Return or echo script
mi18n(string $string) : string
e.g. echo mi18n('May the %s be with %s', 'force', 'you'); will output: May the force be with you
string
the string to translate
string
the translated stringmodDeleteModule($idmod)
modEditModule($idmod, $name, $description, $input, $output, $template, $type)
modTestModule($code, $id, $output)
mr_arrayValue(array $array, mixed $key, mixed $default) : mixed
Shortcut function for some ways to access to arrays:
// old way
if (is_array($foo) && isset($foo['bar']) && $foo['bar'] == 'yieeha') {
// do something
}
// new, more readable way:
if (mr_arrayValue($foo, 'bar') == 'yieeha') {
// do something
}
// old way
if (is_array($foo) && isset($foo['bar'])) {
$jep = $foo['bar'];
} else {
$jep = 'yummy';
}
// new way
$jep = mr_arrayValue($foo, 'bar', 'yummy');
array
The array
mixed
Position of an indexed array or key of an assoziative array
mixed
Default value to return
mixed
Either the found value or the default valuemr_buildGeneratedCode(string $code) : string
Will be called by chain 'Contenido.Content.conGenerateCode' or 'Contenido.Frontend.HTMLCodeOutput' depening on mod_rewrite settings.
string
Code to prepare
string
New codemr_buildNewUrl(string $url) : string
Will also be called by chain 'Contenido.Frontend.CreateURL'.
todo | : Still exists bcause of downwards compatibility (some other modules/plugins are using it) |
---|
string
URL to rebuild
string
New URLmr_conCopyArtLang(array $data) : array
Will be called by chain 'Contenido.Article.conCopyArtLang_AfterInsert'.
array
Assoziative array with record entries
array
Loop through of argumentsmr_conMoveArticles(array $data) : array
Will be called by chain 'Contenido.Article.conMoveArticles_Loop'.
array
Assoziative array with record entries
array
Loop through of argumentsmr_conSaveArticle(array $data) : array
Will be called by chain 'Contenido.Action.con_saveart.AfterCall'.
array
Assoziative array with some article properties
array
Passed parametermr_conSyncArticle(array $data) : array
Will be called by chain 'Contenido.Article.conSyncArticle_AfterInsert'.
array
Assoziative array with record entries as follows:
array(
'src_art_lang' => Recordset (assoziative array) of source item from con_art_lang table
'dest_art_lang' => Recordset (assoziative array) of inserted destination item from con_art_lang table
);
array
Loop through of argumentmr_debugOutput(bool $print) : mixed
bool
Flag to echo the debug data
mixed
Either the debug data, if parameter $print is set to true, or nothingmr_getConfiguration(int $clientId) : array | null
File is placed in /contenido/mod_rewrite/includes/and is named like config.mod_rewrite_{client_id}.php.
int
Id of client
array
null
mr_getRequest(string $key, mixed $default) : mixed
Checks occurance in $_GET, then in $_POST. Uses trim() and strip_tags() to preclean data.
string
Name of var to get
mixed
Default value to return
mixed
The valuemr_header($header)
Header value for redirect
mr_i18n(string $key) : string
string
The message id as string
string
Related messagemr_loadConfiguration(int $clientId, bool $forceReload)
File is placed in /contenido/mod_rewrite/includes/and is named like config.mod_rewrite_{client_id}.php.
int
Id of client
bool
Flag to force to reload configuration, e. g. after done changes on it
mr_queryAndNextRecord(string $query) : mixed
Used to execute a select statement and to return the result of first recordset.
Minimizes following code:
// default way
$db = cRegistry::getDb();
$sql = "SELECT * FROM foo WHERE bar='foobar'";
$db->query($sql);
$db->next_record();
$data = $db->Record;
// new way
$sql = "SELECT * FROM foo WHERE bar='foobar'";
$data = mr_queryAndNextRecord($sql);
string
Query to execute
mixed
Assoziative array including recordset or nullmr_removeMultipleChars(string $char, string $string) : string
string
Character to remove
string
String to clean from character
string
Cleaned stringmr_requestCleanup(mixed $data, array $options) : mixed
Request data is allways tainted and must be filtered. Pass the array to cleanup using several options. Emulates array_walk_recursive().
mixed
Data to cleanup
array
Default options array, provides only 'filter' key with several
filter functions which are to execute as follows:
$options['filter'] = array('trim', 'myFilterFunc');
If no filter functions are set, 'trim', 'strip_tags' and 'stripslashes'
will be used by default.
A userdefined function must accept the value as a parameter and must return
the filtered parameter, e. g.
function myFilter($data) {
// do what you want with the data, e. g. cleanup of xss content
return $data;
}
mixed
Cleaned datamr_runFrontendController() : bool
Will be called by chain 'Contenido.Frontend.AfterLoadPlugins' at front_content.php.
bool
Just a return valuemr_setClientLanguageId(int $client)
int
Client id
mr_setConfiguration(int $clientId, array $config) : bool
File is placed in /contenido/mod_rewrite/includes/and is named like config.mod_rewrite_{client_id}.php.
int
Id of client
array
Configuration to save
bool
mr_strCopyCategory(array $data) : array
Will be called by chain 'Contenido.Category.strCopyCategory'.
array
Assoziative array with some values
array
Passed parametermr_strMoveSubtree(array $data) : array
Will be called by chain 'Contenido.Action.str_movesubtree.AfterCall'.
array
Assoziative array with some values
array
Passed parametermr_strMoveUpCategory(int $idcat) : int
Will be called by chain 'Contenido.Action.str_moveupcat.AfterCall'.
todo | do we really need processing of the category? there is no mr relevant data changes while moving the category on same level, level and name won't change |
---|
int
Category id
int
Category idmr_strMovedownCategory(int $idcat) : int
Will be called by chain 'Contenido.Action.str_movedowncat.AfterCall'.
todo | do we really need processing of the category? there is no mr relevant data changes while moving the category on same level, level and name won't change |
---|
int
Id of category beeing moved down
int
Category idmr_strNewCategory(array $data) : array
Will be called by chain 'Contenido.Action.str_newcat.AfterCall'.
array
Assoziative array with some values
array
Passed parametermr_strNewTree(array $data) : array
Will be called by chain 'Contenido.Action.str_newtree.AfterCall'.
array
Assoziative array with some values
array
Passed parametermr_strRenameCategory(array $data) : array
.. 2010-02-01: max 50 recursion level
Will be called by chain 'Contenido.Action.str_renamecat.AfterCall'.
array
Assoziative array with some values
array
Passed parametermr_strSyncCategory(array $data) : array
Will be called by chain 'Contenido.Category.strSyncCategory_Loop'.
array
Assoziative array with some values
array
Passed parameternotifyOnError($errortitle, $errormessage)
deprecated | 2012-09-04 Use cWarning or the like. |
---|
parseCronFile($PC_cronTabFile, $PC_debug)
parseElement($element, $targetArray, $numberOfElements)
phpInfoToHtml() : string
string
HTML output of phpinfo()piUsAfterLoadPlugins()
If the string placeholder in the example URL http://www.domain.de/placeholder is a defined short URL, the user is redirected to the correct URL.
piUsConSaveArtAfter(array $values)
Checks whether a short URL has been given via $_POST and saves/deletes it.
array
the values which are saved
piUsEditFormAdditionalRows($idart, $idlang, $idclient) : string
string
rendered HTML codepiUsGetErrorMessage(int $errorCode, $shortUrlItem) : string
int
the error code
string
the error message describing the given error codepica_ArticleListActions($aActions)
pica_GetCustomTabProperties($sIntName)
pica_RegisterCustomTab()
pica_RenderArticleAction($idcat, $idart, $idartlang, $actionkey)
piworkflowAllowArticleEdit($idlang, $idcat, $idart, $user)
piworkflowCategoryColumns($array)
piworkflowCategoryRenderColumn($idcat, $type)
piworkflowCreateTasksFolder()
piworkflowProcessActions($array)
piworkflowProcessArticleColumns($array)
piworkflowRenderAction($idcat, $idart, $idartlang, $type)
piworkflowRenderColumn($idcat, $idart, $idartlang, $column)
plugin_include(string $sWhere, string $sWhat) : void
Example: plugin_include('formedit', 'classes/class.formedit.php');
string
The name of the plugin
string
The filename of the include
prCreateURLNameLocationString(int $idcat, string $seperator, string $cat_str, bool $makeLink, string $linkClass, integer $firstTreeElementToUse, $uselang, $final, $usecache) : string
int
ID of the starting category
string
Seperation string
string
Category location string (by reference)
bool
create location string with links
string
stylesheet class for the links
integer
first navigation level location string should be printed out (first level = 0!!)
string
location stringprDeleteCacheFileContent(int $client, int $lang) : bool
global | array $cfgClient |
---|
int
int
bool
prGetCacheFileContent(int $client, int $lang) : array
global | array $cfgClient |
---|
int
int
array
$dataprResolvePathViaCategoryNames($path, $iLangCheck) : integer
Warning: If you use this function, try to pass a 'good' path. This function doesn't guarantee that the matches are logically best-matches.
This function operates on the actual category names.
string Path to resolve
integer
Closest matching category ID (idcat)prResolvePathViaURLNames($path) : integer
Warning: If you use this function, try to pass a 'good' path. This function doesn't guarantee that the matches are logically best-matches.
This function operates on the category aliases. It compares the given path with the urlpaths generated by function prCreateURLNameLocationString() based on category aliases.
string Path to resolve
integer
Closest matching category ID (idcat)prWriteCacheFileContent(array $data, int $client, int $lang) : bool
global | array $cfgClient |
---|
array
int
int
bool
prepareWorkflowItems()
recCats($aCats, $sInsertQuery, $aAllCats, $iLevel)
deprecated | 2012-04-26 This function is not longer supported, use strBuildSqlValues() instead |
---|
recursiveCopy(string $sourcePath, string $destinationPath, int $mode, array $options)
string
string
int
Octal representation of file mode (0644, 0750, etc.)
array
Some additional options as follows
$options['force_overwrite'] (bool) Flag to overwrite existing destination file, default value is false
recursive_copy($from_path, $to_path)
deprecated | [2012-06-20] Use getFileType() from functions.file.php |
---|
removeFileInformation(int $iIdClient, string $sFilename, string $sType, \DB_Contenido $oDb)
author | Timo Trautmann |
---|
int
string
string
\DB_Contenido
renameFile(string $sOldFile, string $sNewFile, string $path) : \(void | \string)
Exits the script, if new filename is not valid or renaming fails!
deprecated | [2012-07-04] These functions are now in cFileHandler |
---|
string
Old filename
string
New filename
string
Path to the file
\(void
\string)
Either new filename or nothingrenderLabel(string $text, string $name, string $width, string $seperator) : string
string
the label text
string
the name of the corresponding input element
string
the width in pixel
string
the seperator which is written at the end of the label
string
the rendered cHTMLLabel elementrenderSelectProperty(string $name, array $possibleValues, string $value, string $label) : array
If there are only two possible values which are called true/false, enabled/disabled or 0/1, a checkbox is rendered. Returns an associative array with the label and the input field.
string
the name of the form element
array
the possible values
string
the value which should be selected
string
the label text which should be rendered
array
associative array with the label and the input fieldrenderTextProperty(string $name, string $value, string $label) : array
Returns an associative array with the label and the input field.
string
the name of the form element
string
the value of the text field
string
the label text
array
associative array with the label and the input fieldrereadClients()
deprecated | no longer needed |
---|
runJob($job, $PC_jobDir, $PC_writeDir, $PC_useLog, $PC_debug)
saveGroupRights()
saveRights()
scanDirectory(string $sDirectory, bool $bRecursive) : bool | array
string
bool
bool
array
List of found files (full path and name) or falsescanPlugins(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
searchFrontContentLinks($sValue, $iArt, $sArt, $iCat, $sCat)
searchLinks($sValue, $iArt, $sArt, $iCat, $sCat, $iLang, $sFromtype)
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
setUserSequence($idartlang, $defaultidworkflow)
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 |
---|
showTree($iIdcat, $aWholelist)
smartyAutoload($class)
smarty_block_php($params, string $content, object $template, $repeat) : string
string
contents of the block
object
template object
string
content re-formattedsmarty_block_textformat(array $params, string $content, \Smarty_Internal_Template $template, boolean $repeat) : string
Type: block function
Name: textformat
Purpose: format text a certain way with preset styles
or custom wrap/indent settings
Params:
- style - string (email) - indent - integer (0) - wrap - integer (80) - wrap_char - string ("\n") - indent_char - string (" ") - wrap_boundary - boolean (true)
link | {textformat} (Smarty online manual) |
---|---|
author | Monte Ohrt <monte at ohrt dot com> |
array
parameters
string
contents of the block
boolean
&$repeat repeat flag
string
content re-formattedsmarty_function_counter(array $params, \Smarty_Internal_Template $template) : string | null
Type: function
Name: counter
Purpose: print out a counter value
author | Monte Ohrt <monte at ohrt dot com> |
---|---|
link | {counter} (Smarty online manual) |
array
parameters
string
null
smarty_function_cycle(array $params, \Smarty_Internal_Template $template) : string | null
Type: function
Name: cycle
Date: May 3, 2002
Purpose: cycle through given values
Params:
- name - name of cycle (optional) - values - comma separated list of values to cycle, or an array of values to cycle (this can be left out for subsequent calls) - reset - boolean - resets given var to true - print - boolean - print var or not. default is true - advance - boolean - whether or not to advance the cycle - delimiter - the value delimiter, default is "," - assign - boolean, assigns to template var instead of printed.
Examples:
{cycle values="#eeeeee,#d0d0d0d"} {cycle name=row values="one,two,three" reset=true} {cycle name=row}
link | {cycle} (Smarty online manual) |
---|---|
author | Monte Ohrt <monte at ohrt dot com> |
author | credit to Mark Priatel |
author | credit to Gerard |
author | credit to Jason Sweat |
version | 1.3 |
array
parameters
string
null
smarty_function_escape_special_chars(string $string) : string
Function: smarty_function_escape_special_chars
Purpose: used by other smarty functions to escape
special chars except for already escaped ones
author | Monte Ohrt <monte at ohrt dot com> |
---|
string
text that should by escaped
string
smarty_function_escape_special_chars(string $string) : string
Function: smarty_function_escape_special_chars
Purpose: used by other smarty functions to escape
special chars except for already escaped ones
author | Monte Ohrt <monte at ohrt dot com> |
---|
string
text that should by escaped
string
smarty_function_fetch(array $params, \Smarty_Internal_Template $template) : string | null
Type: function
Name: fetch
Purpose: fetch file, web or ftp data and display results
link | {fetch} (Smarty online manual) |
---|---|
author | Monte Ohrt <monte at ohrt dot com> |
array
parameters
string
null
if the assign parameter is passed, Smarty assigns the result to a template variablesmarty_function_html_checkboxes(array $params, object $template) : string
File: function.html_checkboxes.php
Type: function
Name: html_checkboxes
Date: 24.Feb.2003
Purpose: Prints out a list of checkbox input types
Examples:
{html_checkboxes values=$ids output=$names} {html_checkboxes values=$ids name='box' separator='
' output=$names} {html_checkboxes values=$ids checked=$checked separator='
' output=$names}
Params:
- name (optional) - string default "checkbox" - values (required) - array - options (optional) - associative array - checked (optional) - array default not set - separator (optional) - ie
or - output (optional) - the output next to each checkbox - assign (optional) - assign the output as an array to this variable - escape (optional) - escape the content (not value), defaults to true
link | {html_checkboxes} (Smarty online manual) |
---|---|
author | Christopher Kvarme |
author | credits to Monte Ohrt <monte at ohrt dot com> |
version | 1.0 |
uses | \global\smarty_function_escape_special_chars() |
array
parameters
object
template object
string
smarty_function_html_checkboxes_output($name, $value, $output, $selected, $extra, $separator, $labels, $label_ids, $escape)
smarty_function_html_image(array $params, \Smarty_Internal_Template $template) : string
Type: function
Name: html_image
Date: Feb 24, 2003
Purpose: format HTML tags for the image
Examples: {html_image file="/images/masthead.gif"}
Output:
Params:
- file - (required) - file (and path) of image - height - (optional) - image height (default actual height) - width - (optional) - image width (default actual width) - basedir - (optional) - base directory for absolute paths, default is environment variable DOCUMENT_ROOT - path_prefix - prefix for path output (optional, default empty)
link | {html_image} (Smarty online manual) |
---|---|
author | Monte Ohrt <monte at ohrt dot com> |
author | credits to Duda |
version | 1.0 |
uses | \global\smarty_function_escape_special_chars() |
array
parameters
string
smarty_function_html_radios(array $params, \Smarty_Internal_Template $template) : string
File: function.html_radios.php
Type: function
Name: html_radios
Date: 24.Feb.2003
Purpose: Prints out a list of radio input types
Params:
- name (optional) - string default "radio" - values (required) - array - options (required) - associative array - checked (optional) - array default not set - separator (optional) - ie
or - output (optional) - the output next to each radio button - assign (optional) - assign the output as an array to this variable - escape (optional) - escape the content (not value), defaults to true
Examples:
{html_radios values=$ids output=$names} {html_radios values=$ids name='box' separator='
' output=$names} {html_radios values=$ids checked=$checked separator='
' output=$names}
link | {html_radios} (Smarty online manual) |
---|---|
author | Christopher Kvarme |
author | credits to Monte Ohrt <monte at ohrt dot com> |
version | 1.0 |
uses | \global\smarty_function_escape_special_chars() |
array
parameters
string
smarty_function_html_radios_output($name, $value, $output, $selected, $extra, $separator, $labels, $label_ids, $escape)
smarty_function_html_select_date(array $params, \Smarty_Internal_Template $template) : string
Type: function
Name: html_select_date
Purpose: Prints the dropdowns for date selection.
ChangeLog:
- 1.0 initial release - 1.1 added support for +/- N syntax for begin and end year values. (Monte) - 1.2 added support for yyyy-mm-dd syntax for time value. (Jan Rosier) - 1.3 added support for choosing format for month values (Gary Loescher) - 1.3.1 added support for choosing format for day values (Marcus Bointon) - 1.3.2 support negative timestamps, force year dropdown to include given date unless explicitly set (Monte) - 1.3.4 fix behaviour of 0000-00-00 00:00:00 dates to match that of 0000-00-00 dates (cybot, boots) - 2.0 complete rewrite for performance, added attributes month_names, *_id
link | {html_select_date} (Smarty online manual) |
---|---|
version | 2.0 |
author | Andrei Zmievski |
author | Monte Ohrt <monte at ohrt dot com> |
author | Rodney Rehm |
array
parameters
string
smarty_function_html_select_time(array $params, \Smarty_Internal_Template $template) : string
Type: function
Name: html_select_time
Purpose: Prints the dropdowns for time selection
link | {html_select_time} (Smarty online manual) |
---|---|
author | Roberto Berto |
author | Monte Ohrt <monte AT ohrt DOT com> |
uses | \global\smarty_make_timestamp() |
array
parameters
string
smarty_function_html_table(array $params, \Smarty_Internal_Template $template) : string
Type: function
Name: html_table
Date: Feb 17, 2003
Purpose: make an html table from an array of data
Params:
- loop - array to loop through - cols - number of columns, comma separated list of column names or array of column names - rows - number of rows - table_attr - table attributes - th_attr - table heading attributes (arrays are cycled) - tr_attr - table row attributes (arrays are cycled) - td_attr - table cell attributes (arrays are cycled) - trailpad - value to pad trailing cells with - caption - text for caption element - vdir - vertical direction (default: "down", means top-to-bottom) - hdir - horizontal direction (default: "right", means left-to-right) - inner - inner loop (default "cols": print $loop line by line, $loop will be printed column by column otherwise)
Examples:
{table loop=$data} {table loop=$data cols=4 tr_attr='"bgcolor=red"'} {table loop=$data cols="first,second,third" tr_attr=$colors}
array
parameters
string
smarty_function_html_table_cycle($name, $var, $no)
smarty_function_mailto(array $params, \Smarty_Internal_Template $template) : string
Type: function
Name: mailto
Date: May 21, 2002
Purpose: automate mailto address link creation, and optionally encode them.
Params:
- address - (required) - e-mail address - text - (optional) - text to display, default is address - encode - (optional) - can be one of: * none : no encoding (default) * javascript : encode with javascript * javascript_charcode : encode with javascript charcode * hex : encode with hexidecimal (no javascript) - cc - (optional) - address(es) to carbon copy - bcc - (optional) - address(es) to blind carbon copy - subject - (optional) - e-mail subject - newsgroups - (optional) - newsgroup(s) to post to - followupto - (optional) - address(es) to follow up to - extra - (optional) - extra tags for the href link
Examples:
{mailto address="me@domain.com"} {mailto address="me@domain.com" encode="javascript"} {mailto address="me@domain.com" encode="hex"} {mailto address="me@domain.com" subject="Hello to you!"} {mailto address="me@domain.com" cc="you@domain.com,they@domain.com"} {mailto address="me@domain.com" extra='class="mailto"'}
link | {mailto} (Smarty online manual) |
---|---|
version | 1.2 |
author | Monte Ohrt <monte at ohrt dot com> |
author | credits to Jason Sweat (added cc, bcc and subject functionality) |
array
parameters
string
smarty_function_math(array $params, \Smarty_Internal_Template $template) : string | null
Type: function
Name: math
Purpose: handle math computations in template
link | {math} (Smarty online manual) |
---|---|
author | Monte Ohrt <monte at ohrt dot com> |
array
parameters
string
null
smarty_literal_compiler_param(array $params, integer $index, mixed $default) : mixed
author | Rodney Rehm |
---|
array
parameter array as given to the compiler function
integer
array index of the parameter to convert
mixed
value to be returned if the parameter is not present
\SmartyException |
if parameter is not a literal (but an expression, variable, …) |
---|
mixed
evaluated value of parameter or $defaultsmarty_mb_from_unicode(integer | array $unicode, string $encoding) : string
link | for inspiration |
---|---|
author | Rodney Rehm |
integer
array
single unicode or list of unicodes to convert
string
encoding of returned string, if null mb_internal_encoding() is used
string
unicode as character sequence in given $encodingsmarty_mb_str_replace(string $search, string $replace, string $subject, int $count) : string
author | Rodney Rehm |
---|
string
the string to be searched
string
the replacement string
string
the source string
int
&$count number of matches found
string
replaced stringsmarty_mb_to_unicode(string $string, string $encoding) : array
link | for inspiration |
---|---|
author | Rodney Rehm |
string
characters to calculate unicode of
string
encoding of $string, if null mb_internal_encoding() is used
array
sequence of unicodessmarty_mb_wordwrap(string $str, int $width, string $break, boolean $cut) : string
link | for similarity |
---|---|
author | Rodney Rehm |
string
the string to wrap
int
the width of the output
string
the character used to break the line
boolean
ignored parameter, just for the sake of
string
wrapped stringsmarty_modifier_capitalize(string $string, boolean $uc_digits, boolean $lc_rest) : string
Type: modifier
Name: capitalize
Purpose: capitalize words in the string
author | Monte Ohrt <monte at ohrt dot com> |
---|---|
author | Rodney Rehm |
string
string to capitalize
boolean
also capitalize "x123" to "X123"
boolean
capitalize first letters, lowercase all following letters "aAa" to "Aaa"
string
capitalized stringsmarty_modifier_date_format(string $string, string $format, string $default_date, string $formatter) : string
Type: modifier
Name: date_format
Purpose: format datestamps via strftime
Input:
- string: input date string
- format: strftime format for output
- default_date: default date if $string is empty
link | date_format (Smarty online manual) |
---|---|
author | Monte Ohrt <monte at ohrt dot com> |
uses | \global\smarty_make_timestamp() |
string
input date string
string
strftime format for output
string
default date if $string is empty
string
either 'strftime' or 'auto'
string
|voidsmarty_modifier_debug_print_var(array | object $var, integer $depth, integer $length) : string
Type: modifier
Name: debug_print_var
Purpose: formats variable contents for display in the console
author | Monte Ohrt <monte at ohrt dot com> |
---|
array
object
variable to be formatted
integer
maximum recursion depth if $var is an array
integer
maximum string length if $var is a string
string
smarty_modifier_escape(string $string, string $esc_type, string $char_set, boolean $double_encode) : string
Type: modifier
Name: escape
Purpose: escape string for output
link | count_characters (Smarty online manual) |
---|---|
author | Monte Ohrt <monte at ohrt dot com> |
string
input string
string
escape type
string
character set, used for htmlspecialchars() or htmlentities()
boolean
encode already encoded entitites again, used for htmlspecialchars() or htmlentities()
string
escaped input stringsmarty_modifier_regex_replace(string $string, string | array $search, string | array $replace) : string
Type: modifier
Name: regex_replace
Purpose: regular expression search/replace
link | regex_replace (Smarty online manual) |
---|---|
author | Monte Ohrt <monte at ohrt dot com> |
string
input string
string
array
regular expression(s) to search for
string
array
string(s) that should be replaced
string
smarty_modifier_replace(string $string, string $search, string $replace) : string
Type: modifier
Name: replace
Purpose: simple search/replace
link | replace (Smarty online manual) |
---|---|
author | Monte Ohrt <monte at ohrt dot com> |
author | Uwe Tews |
string
input string
string
text to search for
string
replacement text
string
smarty_modifier_spacify(string $string, string $spacify_char) : string
Type: modifier
Name: spacify
Purpose: add spaces between characters in a string
link | spacify (Smarty online manual) |
---|---|
author | Monte Ohrt <monte at ohrt dot com> |
string
input string
string
string to insert between characters.
string
smarty_modifier_truncate(string $string, integer $length, string $etc, boolean $break_words, boolean $middle) : string
Type: modifier
Name: truncate
Purpose: Truncate a string to a certain length if necessary,
optionally splitting in the middle of a word, and
appending the $etc string or inserting $etc into the middle.
link | truncate (Smarty online manual) |
---|---|
author | Monte Ohrt <monte at ohrt dot com> |
string
input string
integer
length of truncated text
string
end string
boolean
truncate at word boundary
boolean
truncate in the middle of text
string
truncated stringsmarty_modifiercompiler_cat(array $params, $compiler) : string
Type: modifier
Name: cat
Date: Feb 24, 2003
Purpose: catenate a value to a variable
Input: string to catenate
Example: {$var|cat:"foo"}
link | cat (Smarty online manual) |
---|---|
author | Uwe Tews |
array
parameters
string
with compiled codesmarty_modifiercompiler_count_characters(array $params, $compiler) : string
Type: modifier
Name: count_characteres
Purpose: count the number of characters in a text
link | count_characters (Smarty online manual) |
---|---|
author | Uwe Tews |
array
parameters
string
with compiled codesmarty_modifiercompiler_count_paragraphs(array $params, $compiler) : string
Type: modifier
Name: count_paragraphs
Purpose: count the number of paragraphs in a text
link | count_paragraphs (Smarty online manual) |
---|---|
author | Uwe Tews |
array
parameters
string
with compiled codesmarty_modifiercompiler_count_sentences(array $params, $compiler) : string
Type: modifier
Name: count_sentences
Purpose: count the number of sentences in a text
link | count_sentences (Smarty online manual) |
---|---|
author | Uwe Tews |
array
parameters
string
with compiled codesmarty_modifiercompiler_count_words(array $params, $compiler) : string
Type: modifier
Name: count_words
Purpose: count the number of words in a text
link | count_words (Smarty online manual) |
---|---|
author | Uwe Tews |
array
parameters
string
with compiled codesmarty_modifiercompiler_default(array $params, $compiler) : string
Type: modifier
Name: default
Purpose: designate default value for empty variables
link | default (Smarty online manual) |
---|---|
author | Uwe Tews |
array
parameters
string
with compiled codesmarty_modifiercompiler_escape(array $params, $compiler) : string
Type: modifier
Name: escape
Purpose: escape string for output
link | count_characters (Smarty online manual) |
---|---|
author | Rodney Rehm |
array
parameters
string
with compiled codesmarty_modifiercompiler_from_charset(array $params, $compiler) : string
Type: modifier
Name: from_charset
Purpose: convert character encoding from $charset to internal encoding
author | Rodney Rehm |
---|
array
parameters
string
with compiled codesmarty_modifiercompiler_indent(array $params, $compiler) : string
Type: modifier
Name: indent
Purpose: indent lines of text
link | indent (Smarty online manual) |
---|---|
author | Uwe Tews |
array
parameters
string
with compiled codesmarty_modifiercompiler_lower(array $params, $compiler) : string
Type: modifier
Name: lower
Purpose: convert string to lowercase
link | lower (Smarty online manual) |
---|---|
author | Monte Ohrt <monte at ohrt dot com> |
author | Uwe Tews |
array
parameters
string
with compiled codesmarty_modifiercompiler_string_format(array $params, $compiler) : string
Type: modifier
Name: string_format
Purpose: format strings via sprintf
link | string_format (Smarty online manual) |
---|---|
author | Uwe Tews |
array
parameters
string
with compiled codesmarty_modifiercompiler_strip(array $params, $compiler) : string
Type: modifier
Name: strip
Purpose: Replace all repeated spaces, newlines, tabs
with a single space or supplied replacement string.
Example: {$var|strip} {$var|strip:" "}
Date: September 25th, 2002
link | strip (Smarty online manual) |
---|---|
author | Uwe Tews |
array
parameters
string
with compiled codesmarty_modifiercompiler_to_charset(array $params, $compiler) : string
Type: modifier
Name: to_charset
Purpose: convert character encoding from internal encoding to $charset
author | Rodney Rehm |
---|
array
parameters
string
with compiled codesmarty_modifiercompiler_unescape(array $params, $compiler) : string
Type: modifier
Name: unescape
Purpose: unescape html entities
author | Rodney Rehm |
---|
array
parameters
string
with compiled codesmarty_modifiercompiler_upper(array $params, $compiler) : string
Type: modifier
Name: lower
Purpose: convert string to uppercase
link | lower (Smarty online manual) |
---|---|
author | Uwe Tews |
array
parameters
string
with compiled codesmarty_modifiercompiler_wordwrap(array $params, $compiler) : string
Type: modifier
Name: wordwrap
Purpose: wrap a string of text at a given length
link | wordwrap (Smarty online manual) |
---|---|
author | Uwe Tews |
array
parameters
string
with compiled codesmarty_outputfilter_trimwhitespace(string $source, \Smarty_Internal_Template $smarty) : string
Trim unnecessary whitespace from HTML markup.
author | Rodney Rehm |
---|---|
todo | substr_replace() is not overloaded by mbstring.func_overload - so this function might fail! |
string
input string
string
filtered outputsmarty_php_tag(array $params, string $content, object $template, boolean $repeat) : string
array
parameter list
string
contents of the block
object
template object
boolean
&$repeat repeat flag
string
content re-formattedsmarty_variablefilter_htmlspecialchars(string $source, \Smarty_Internal_Template $smarty) : string
string
input string
string
filtered outputsort_pre_post($arr)
deprecated | 2012-04-26 This function is not longer supported, use strSortPrePost() instead |
---|
startTiming(string $function, array $parameters) : int
string
Name of the function
array
All parameters for the function to measure
int
uuid for this measure processstatCreateLocationString(int $idcat, string $seperator, string $cat_str) : void
Performs a recursive call, if parent category doesn't matches to 0
int
The category id
string
Separator for location string
string
The location string variable (reference)
statDisplayTopChooser(string $default) : string
string
string
Returns a drop down stringstatDisplayYearlyTopChooser(string $default) : string
string
string
Returns a drop down stringstatGetAvailableMonths(mixed $year, $client, $lang) : array
mixed
many
array
Array of strings with months.statGetAvailableYears(mixed $client, $lang) : array
mixed
many
array
Array of strings with years.statResetStatistic(int $client) : void
int
Id of client
statReturnCanonicalMonth(int $month) : string
Wrapper for function getCanonicalMonth()
deprecated | 2012-02-09 this function is not supported any longer |
---|
int
The digit representation of a month
string
Textual representation of a monthstatsArchive($yearmonth) : void
String with the desired archive date (YYYYMM)
statsDisplayInfo(int $id, string $type, int $x, int $y, int $w, int $h) : string
int
Either article or directory id
string
The type
int
Style top position
int
Style left position
int
Style width
int
Style height
string
Composed info layerstatsOverviewAll($yearmonth) : void
Specifies the year and month from which to retrieve the statistics, specify "current" to retrieve the current entries
statsOverviewTop($yearmonth, $top) : void
Specifies the year and month from which to retrieve the statistics, specify "current" to retrieve the current entries
Specifies the amount of pages to display
statsOverviewTopYear($year, $top) : void
Specifies the year from which to retrieve the statistics
Specifies the amount of pages to display
statsOverviewYear($year) : void
Specifies the year to retrieve the statistics for
strAssignTemplate(int $idcat, int $client, int $idTplCfg)
int
int
int
strBuildSqlValues(array | \?? $aCats, string $sInsertQuery, array $aAllCats, int $iLevel) : string
array
\??
Assoziative categories array or something else, but what?
string
The insert statement
array
Assoziative categories array holding the complete category structure
int
Category level
string
strCopyCategory(int $idcat, int $destidcat, bool $remakeTree, bool $bUseCopyLabel) : void
int
Id of category to copy
int
Id of destination category
bool
Flag to rebuild category tree
bool
Flag to add copy label to the new categories
strCopyTree(int $idcat, int $destcat, bool $remakeTree, bool $bUseCopyLabel)
int
Id of category to copy
int
Id of destination category
bool
Flag to rebuild category tree
bool
Flag to add copy label to the new categories
strDeeperCategoriesArray(int $startIdcat) : array
int
The start category
array
Contains all childs of $startIdcat and $startIdcat start itselfstrDeleteCategory(int $idcat) : void
Only categories having no child categories and having no articles will be deleted!
int
Id of category to delete
strHasArticles(int $idcat) : bool
int
ID of category
bool
strHasStartArticle(int $idcat, int $idlang) : bool
int
Id of category
int
The language id
bool
strMakePublic(int $idcat, int $lang, int $public) : void
int
Category id
int
Language id
int
Public status
strMakeVisible(int $idcat, int $lang, int $visible) : void
int
Category id
int
Language id
int
Visible status
strMoveCatTargetallowed(int $idcat, int $source) : bool
int
Id of category to move
int
Id of source category
bool
strMoveDownCategory(int $idcat) : void
int
Id of category to move downwards
strMoveSubtree(int $idcat, int $newParentId, int $newPreId, int $newPostId) : void
int
Id of category
int
Id of destination parent category
int
Id of new previous category
int
Id of new post category
strMoveUpCategory(int $idcat) : void
int
Id of category to move upwards
strNewCategory(int $parentid, string $catname, bool $remakeTree, string $catalias, int $visible, int $public, int $iIdtplcfg) : \(int | \void)
int
Id of parent category
string
The category name
bool
Flag to rebuild category tree structure
string
Alias of category
int
Flag about visible status
int
Flag about public status
int
Id of template configuration
\(int
\void)
Id of new generated category or nothing on failurestrNewTree(string $catname, string $catalias, int $visible, int $public, int $iIdtplcfg) : \(int | \void)
string
The category name
string
Alias of category
int
Flag about visible status
int
Flag about public status
int
Id of template configuration
\(int
\void)
Id of new generated category or nothing on failurestrNextBackwards(int $idcat) : int
int
ID of category
int
strNextDeeper(int $idcat, bool $ignoreLang) : int
global | int $lang |
---|
int
Category id to check next deeper item
bool
Flag to check for existing entry in category language table
int
strNextDeeperAll(int $idcat, bool $ignoreLang) : array
global | int $lang |
---|
int
bool
array
strNextPost(int $idcat) : int
int
ID of category
int
strOrderedPostTreeList(int $idcat, string $poststring) : string
int
string
string
strRemakeTreeTable() : void
It still uses manually build sql statements due to performance reasons.
strRenameCategory(int $idcat, int $lang, $newCategoryName, $newCategoryAlias) : void
int
Category id
int
Language id
strRenameCategoryAlias(int $idcat, int $lang, string $newcategoryalias) : void
int
Category id
int
Language id
string
New category alias
strShowTreeTable() : void
deprecated | 2012-03-04 This function is not longer supported. |
---|
strSortPrePost(array $arr) : array
todo | Check logic, move sorting to db layer, if possible! |
---|
array
array
strSyncCategory(int $idcatParam, int $sourcelang, int $targetlang, bool $bMultiple)
int
Id of category to synchronize
int
Id of source language
int
Id of target language
bool
Flag to synchronize child languages
str_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 |
---|
stripCount($singlewordcounter, $maxKeywords)
stripslashes_deep(mixed $value) : array
mixed
Either a string or a multi-dimensional array of values
array
systemHavePerm(int $client) : bool
int
client id
bool
Wether user has access or notsystem_have_perm($client)
deprecated | [2012-07-04] Use function systemHavePerm() instead |
---|
tplAutoFillModules($idtpl)
tplBrowseLayoutForContainers($idlay) : string
author | Jan Lengowski <Jan.Lengowski@4fb.de> |
---|---|
copyright | four for business AG |
string
&-seperated String of all containerstplDeleteTemplate(int $idtpl) : \$new_idtpl
author | Olaf Niemann <Olaf.Niemann@4fb.de> |
---|---|
author | Jan Lengowski <Jan.Lengowski@4fb.de> |
copyright | four for business AG |
int
ID of the template to duplicate
\$new_idtpl
ID of the duplicated templatetplDuplicateTemplate(int $idtpl) : \$new_idtpl
author | Jan Lengowski <Jan.Lengowski@4fb.de> |
---|---|
copyright | four for business AG |
int
ID of the template to duplicate
\$new_idtpl
ID of the duplicated templatetplEditTemplate($changelayout, $idtpl, $name, $description, $idlay, $c, $default)
author | Olaf Niemann <Olaf.Niemann@4fb.de> |
---|---|
author | Jan Lengowski <Jan.Lengowski@4fb.de> |
copyright | four for business AG |
tplGetContainerDefault($idlay, int $container) : array
int
Container number
array
Allowed container typestplGetContainerMode($idlay, int $container) : string
int
Container number
string
Container nametplGetContainerName($idlay, int $container) : string
int
Container number
string
Container nametplGetContainerTypes($idlay, int $container) : array
int
Container number
array
Allowed container typestplGetInUsedData(int $idtpl) : array
author | Munkh-Ulzii Balidar |
---|---|
copyright | four for business AG |
int
Template ID
array
- category name, article nametplIsTemplateInUse(int $idtpl) : bool
author | Jan Lengowski <Jan.Lengowski@4fb.de> |
---|---|
copyright | four for business AG |
int
Template ID
bool
is template in usetplPreparseLayout($idlay) : \none
\none
tplcfgDuplicate(int $idtplcfg) : int
int
Template Configuration ID
int
new template configuration IDtrans($string) : string
Usage: trans('Your text which has to be translated');
string The string to translate
string
Returns the translationtrim_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
updateFileInformation(int $iIdClient, string $sFilename, string $sType, string $sAuthor, string $sDescription, \DB_Contenido $oDb, string $sFilenameNew)
It creates new database record for file meta informations if database record does not exist. Otherwise, existing record will be updated
author | Timo Trautmann |
---|
int
string
string
string
string
\DB_Contenido
string
uplCreateFriendlyName($filename) : string
string
uplDirectoryListRecursive(string $sCurrentDir, string $sStartDir, array $aFiles, int $iDepth, string $sPathString) : array
Parses the directory recursively and collects informations about found subdirectories.
string
Directory to parse
string
Start directory. Will be used by recursion.
array
Files array structure. Will be used by recursion.
int
Nesting depth of found files. Will be used by recursion.
string
Path used to create full path to files. Will be used by recursion.
array
Indexed arraay containing assoziative directory informationsuplGetDirectoriesToExclude() : array
g. from directory listings.
array
uplGetFileExtension(string $sFile) : string
string
string
uplGetFileIcon(string $sFile) : string
string
Filename to retrieve the extension for
string
Icon for the file typeuplGetFileTypeDescription(string $sExtension) : string
string
Extension to use
string
Text for the file typeuplGetThumbnail(string $sFile, int $iMaxSize) : string
string
Filename to retrieve the thumbnail for
int
Thumb dimension (size of with and heigth)
string
uplHasFiles(string $sDir) : bool
todo | Function name is misleading, should be renamed to uplIsEmpty |
---|
string
bool
uplHasSubdirs(string $sDir) : bool
string
bool
uplRecursiveDBDirectoryList(string $directory, \TreeItem $oRootItem, int $level, $client)
string
Not used at te moment!
\TreeItem
int
Not used at te moment!
uplRecursiveDirectoryList(string $sDirectory, \TreeItem $oRootItem, int $iLevel, string $sParent, int $iRenameLevel) : array
string
\TreeItem
int
string
int
array
List of invalid directoriesuplRenameDirectory(string $sOldName, string $sNewName, string $sParent) : void
string
string
string
\cException |
if the upload path can not be renamed |
---|
uplSearch($searchfor)
uplSyncDirectory(string $sPath)
string
Specifies the path to scan
uplSyncDirectoryDBFS(string $sPath)
string
Specifies the path to scan
uplmkdir(string $sPath, string $sName)
string
Path to directory to create, either path from client upload directory or a dbfs path
string
Name of directory to create
url_is_image($sUrl)
url_is_uri($sUrl)
workflowInherit($idcat)
workflowSelect($listid, $default, $idcat)
writeSystemValuesOutput($usage)
deprecated | 2012-02-26 Moved directly to include.system_sysvalues.php |
---|
xmlFileToArray($filename, $aData, $aInformation)
xmldoc($str)
deprecated | 2011-09-02 this function is not supported any longer |
---|
xmldocfile($filename)
deprecated | 2011-09-02 this function is not supported any longer |
---|
xpath_eval($xpath_context, $eval_str, $contextnode)
deprecated | 2011-09-02 this function is not supported any longer |
---|
xpath_new_context($dom_document)
deprecated | 2011-09-02 this function is not supported any longer |
---|
xpath_register_ns($xpath_context, $prefix, $namespaceURI)
deprecated | 2011-09-02 this function is not supported any longer |
---|
An abstract means of reading and writing data in terms of characters as opposed to bytes.
« More »Interface for the EventDispatcher which handles the event dispatching layer.
« More »Listens for Messages being sent from within the Transport system.
« More »Listens for Exceptions thrown from within the Transport system.
« More »Provides an abstract way of specifying recipients for batch sending.
« More »Pop3Connection interface for connecting and disconnecting to a POP3 host.
« More »Static CEC Hook class, provides some public methods to process registered chains at CEC (CONTENIDO Extension Chainer).
« More »Project: CONTENIDO Content Management System Description: The XML reader class of CONTENIDO.
« More »Base class for Contenido_Category, Contenido_Categories, Contenido_Category_Language.
« More »Base class for Contenido_Category, Contenido_Categories, Contenido_Category_Language.
« More »Implementation of a CONTENIDO Category for a given CONTENIDO Language.
« More »This class contains the methods for the backend authentication in CONTENIDO.
« More »This class contains the methods for the frontend authentication in CONTENIDO.
« More »This class save the translations from a modul in a file and get it from file.
« More »This class search for modules (input, output,type,description, name )
« More »This class synchronized the contents of modul dir with the table $cfg['tab']['mod'].
« More »Class handels the view, creation, edit, delete of modul templates.
« More »Abstract controller for all concrete mod_rewrite controller implementations.
« More »Class ItemCollection Abstract class for database based item collections.
« More »Class ItemCollection Abstract class for database based item collections.
« More »SMTP is rfc 821 compliant and implements all the rfc 821 SMTP commands except TURN which will always return a not implemented error.
« More »Smarty Cache Handler Base for Key/Value Storage Implementations
« More »This class does contain all necessary methods for the HTML cache on file system
« More »Smarty Internal Plugin Compile Block Plugin Class
« More »Smarty Internal Plugin Compile Function Plugin Class
« More »Smarty Internal Plugin Compile Object Block Function Class
« More »Smarty Internal Plugin Compile Object Function Class
« More »Smarty Internal Plugin Compile Print Expression Class
« More »Smarty Internal Plugin Compile Registered Block Class
« More »Smarty Internal Plugin Compile Registered Function Class
« More »Smarty Internal Plugin Compile special Smarty Variable Class
« More »Smarty Internal Plugin Compile Setfilterclose Class
« More »This class does call function defined with the {function} tag
« More »Project: Smarty: the PHP compiling template engine File: smarty_internal_wrapper.php SVN: $Id: smarty_internal_wrapper.php 2755 2012-07-25 20:10:28Z xmurrix $
« More »Provides the base functionality for an InputStream supporting filters.
« More »Allows reading and writing of bytes to and from an array.
« More »Standard factory for creating CharacterReaders.
« More »Provides fixed-width byte sizes for reading fixed-width character sets.
« More »A CharacterStream implementation which stores characters in an internal array.
« More »A CharacterStream implementation which stores characters in an internal array.
« More »DependencyException thrown when a requested dependeny is missing.
« More »The EventDispatcher which handles the event dispatching layer.
« More »Generated when the state of a Transport is changed (i.e.
« More »Generated when a TransportException is thrown from the Transport system.
« More »Contains a list of redundant Transports so when one fails, the next is used.
« More »Redudantly and rotationally uses several Transport implementations when sending.
« More »Handles Base 64 Transfer Encoding in Swift Mailer.
« More »Handles binary/7/8-bit Transfer Encoding in Swift Mailer.
« More »Handles Quoted Printable (QP) Transfer Encoding in Swift Mailer.
« More »Defines the grammar to use for validation, implements the RFC 2822 (and friends) ABNF grammar definitions.
« More »Handles Base64 (B) Header Encoding in Swift Mailer.
« More »Handles Quoted Printable (Q) Header Encoding in Swift Mailer.
« More »An ID MIME Header for something like Message-ID or Content-ID.
« More »A Mailbox Address MIME Header for something like From or Sender.
« More »Reduces network flooding when sending large amounts of mail.
« More »Reduces network flooding when sending large amounts of mail.
« More »Makes sure a connection to a POP3 host has been established prior to connecting to SMTP.
« More »Pop3Exception thrown when an error occurs connecting to a POP3 host.
« More »A reporter which "collects" failures for the Reporter plugin.
« More »SendmailTransport for sending mail through a sendmail/postfix (etc.
« More »Processes bytes as they pass through a buffer and replaces sequences in it.
« More »Processes bytes as they pass through a buffer and replaces sequences in it.
« More »Creates filters for replacing needles in a string buffer.
« More »TransportException thrown when an error occurs in the Transport subsystem.
« More »Contains a list of redundant Transports so when one fails, the next is used.
« More »Redudantly and rotationally uses several Transports when sending.
« More »SendmailTransport for sending mail through a sendmail/postfix (etc.
« More »This is the implementation class for {@link Swift_Transport_MailInvoker}.
« More »A generic IoBuffer implementation supporting remote sockets and local processes.
« More »Utility Class allowing users to simply check expressions again Swift Grammar
« More »Class WorkflowArtAllocation Class for a single workflow allocation item
« More »Class WorkflowArtAllocations Class for workflow art allocation management
« More »Class WorkflowUserSequences Class for workflow user sequence management
« More »Project: CONTENIDO Content Management System Description: The XML reader class of CONTENIDO.
« More »Static CEC Hook class, provides some public methods to process registered chains at CEC (CONTENIDO Extension Chainer).
« More »class cApiClickableAction cApiClickableAction is a subclass of cApiAction.
« More »class cApiClickableAction cApiClickableAction is a subclass of cApiAction.
« More »Class ItemCollection Abstract class for database based item collections.
« More »Class ItemCollection Abstract class for database based item collections.
« More »Class ItemCollection Abstract class for database based item collections.
« More »This class contains the abstract methods for the authentication in CONTENIDO.
« More »This class contains the methods for the backend authentication in CONTENIDO.
« More »This class contains the methods for the frontend authentication in CONTENIDO.
« More »Exception thrown if a callback refers to an undefined function or if some arguments are missing.
« More »Exception thrown if a callback refers to an undefined method or if some arguments are missing.
« More »Abstract content type for content types which are edited in a tabbed popup.
« More »Content type CMS_DATE which allows the editor to select a date from a calendar and a date format.
« More »Content type CMS_FILELIST which lets the editor select some folders or files.
« More »Content type CMS_HTML which lets the editor enter HTML with the help of a WYSIWYG editor.
« More »Content type CMS_HTMLHEAD which lets the editor enter HTML with the help of a WYSIWYG editor.
« More »Content type CMS_IMGDESCR which displays the description of the selected image.
« More »This class contains functions for handling record sets and interaction with database in CONTENIDO.
« More »This class contains abstract method definitions for each database driver in CONTENIDO.
« More »This class contains functions for database interaction based on MySQL in CONTENIDO.
« More »This class contains functions for database interaction based on MySQLi in CONTENIDO.
« More »Exception thrown if a value does not adhere to a defined valid data domain.
« More »Select box with additional functions for category and article selection
« More »Exception thrown if an argument does not match with the expected value.
« More »This class contains the main functionalities for the logging writer in CONTENIDO.
« More »This class save the translations from a modul in a file and get it from file.
« More »This class contains the main functionalities for the module logging in CONTENIDO.
« More »This class synchronized the contents of modul dir with the table $cfg['tab']['mod'].
« More »This class contains functions for the output cache handler in CONTENIDO.
« More »Exception thrown when performing an invalid operation on an empty container, such as removing an element.
« More »Exception thrown if a value does not match with a set of values.
« More »Project: CONTENIDO Content Management System Description: The XML reader class of CONTENIDO.
« More »FrontendLogic: This is the base class for all frontend related logic.
« More »Todo addslashes to all string db inserts check if default language exists if new entry is added (otherwise)
« More »Todo addslashes to all string db inserts check if default language exists if new entry is added (otherwise)
« More »Todo addslashes to all string db inserts check if default language exists if new entry is added (otherwise)
« More »Todo addslashes to all string db inserts check if default language exists if new entry is added (otherwise)
« More »$constant
CMETAOBJECT_BASE
CMETAOBJECT_PLUGIN
CONTENIDO_ENVIRONMENT
CONTENIDO_STRIPSLASHES
CON_CHECK_AREASTRING
CON_CHECK_BELANG
CON_CHECK_HASH32
CON_CHECK_INTEGER
CON_CHECK_PATHSTRING
CON_CHECK_PRIMITIVESTRING
CON_CHECK_STRING
CON_ENVIRONMENT
CON_FRAMEWORK
CON_FRAMEWORK
CON_FRAMEWORK
CON_FRAMEWORK
CON_FRAMEWORK
CON_FRAMEWORK
CON_FRAMEWORK
CON_FRAMEWORK
CON_FRAMEWORK
CON_FRAMEWORK
CON_FRAMEWORK
CON_FRAMEWORK
CON_FRAMEWORK
CON_FRAMEWORK
CON_FRAMEWORK
CON_FRAMEWORK
CON_PHP54
CON_STRIPSLASHES
DOMXML_LOAD_DONT_KEEP_BLANKS
DOMXML_LOAD_PARSING
DOMXML_LOAD_RECOVERING
DOMXML_LOAD_SUBSTITUTE_ENTITIES
DOMXML_LOAD_VALIDATING
DS
NODE_TYPE_COMMENT
NODE_TYPE_DONE
NODE_TYPE_ELEMENT
NODE_TYPE_ENDELEMENT
NODE_TYPE_START
NODE_TYPE_TEXT
PC_CMD
PC_CRONLINE
PC_DOM
PC_DOW
PC_HOUR
PC_MINUTE
PC_MONTH
QUESTIONACTION_PROMPT
QUESTIONACTION_YESNO
SMARTY_DIR
SMARTY_DIR
SMARTY_MBSTRING
SMARTY_PLUGINS_DIR
SMARTY_RESOURCE_CHAR_SET
SMARTY_RESOURCE_DATE_FORMAT
SMARTY_SPL_AUTOLOAD
SMARTY_SYSPLUGINS_DIR
SWIFT_INIT_LOADED
SWIFT_REQUIRED_LOADED
SWIFT_REQUIRED_LOADED
TREEVIEW_BACKGROUND_NONE
TREEVIEW_BACKGROUND_SHADED
TREEVIEW_GRIDLINE_DASHED
TREEVIEW_GRIDLINE_DOTTED
TREEVIEW_GRIDLINE_NONE
TREEVIEW_GRIDLINE_SOLID
TREEVIEW_MOUSEOVER_MARK
TREEVIEW_MOUSEOVER_NONE
XPATH_NODESET
XPATH_UNDEFINED
cDatatypeCurrency_Left
cDatatypeCurrency_Right
cDateTime_Custom
cDateTime_Friday
cDateTime_ISO
cDateTime_Locale
cDateTime_Locale_DateOnly
cDateTime_Locale_TimeOnly
cDateTime_Monday
cDateTime_MySQL
cDateTime_Saturday
cDateTime_Sunday
cDateTime_Thursday
cDateTime_Tuesday
cDateTime_UNIX
cDateTime_Wednesday