This class contains the abstract methods for the authentication in CONTENIDO.
« More »mailLogBulkEditingFunctions()
mailLogDecodeAddresses(array $addresses) : string
arrayassociative array containing the mail addresses as keys and the mailer names as values
stringHTML code showing the given mail addresses and namesconChangeTemplateForCat(int $idcat, int $idtpl)
intCategory Id
intTemplate 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
boolconCopyContainerConf(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
intID of the starting category
stringSeperation string
stringCategory location string (by reference)
boolCreate location string with links
stringStylesheet class for the links
intFirst navigation Level location string should be printed out (first level = 0!!)
intId of language
bool
bool
stringLocation stringconDeeperCategoriesArray(int $idcat) : array
intId of category
arrayArray with all deeper categoriesconDeleteart(int $idart)
intArticle 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
mixedmany
conEditFirstTime(mixed $idcat, $idcatnew, $idart, $isstart, $idtpl, $idartlang, $idlang, $title, $summary, $artspec, $created, $lastmodified, $author, $online, $datestart, $dateend, $artsort, $keyart, $searchable, $sitemapprio, $changefreq) : int
mixedmany
intId of the new articleconFetchCategoryTree(int $client, int $lang) : array
intUses global set client if not set
intUses global set language if not set
arrayconFlagOnOffline()
conGenerateCodeForAllArts()
conGenerateCodeForAllArtsInCategory(int $idcat)
intCategory ID
conGenerateCodeForAllArtsUsingTemplate(int $idtpl)
intTemplate-Id
conGenerateCodeForAllartsUsingLayout(int $idlay)
intLayout-ID
conGenerateCodeForAllartsUsingMod(int $idmod)
intModule id
conGenerateCodeForArtInAllCategories(int $idart)
intArticle ID
conGenerateCodeForClient()
conGetCategoryAssignments(int $idart, \cDb | null $db) : array
intArticle ID
arrayFlat array which contains all category id'sconGetTopmostCat(int $idcat, int $minLevel) : int
| todo | Returns something.... |
|---|---|
| global | array $cfg |
| global | int $client |
| global | int $lang |
int
int
intconIsLocked(int $idart, int $lang) : bool
intArticle Id
intLanguage Id
boolconLock(int $idart, \ing $lang)
intArticle Id
\ingLanguage Id
conLockBulkEditing(array $idarts, int $idlang, bool $lock)
arrayAll 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)
intId of the category
intId of the language
intStatus of the category
conMakeOnline(int $idart, \ing $lang)
intArticle Id
\ingLanguage Id
conMakeOnlineBulkEditing(array $idarts, int $idlang, bool $online)
arrayAll articles
int
bool
conMakePublic(int | int $idcat, $lang, bool $public)
Almost the same function as strMakePublic in functions.str.php (conDeeperCategoriesArray instead of strDeeperCategoriesArray)
intintCategory Id
boolPublic status of the Article
conMakeStart(int $idcatart, bool $isstart)
| fixme | Do we still need the isstart. The old start compatibility has already been removed... |
|---|
intIdcatart of the article
boolStart article flag
conMoveArticles()
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
intidartlang of the article
stringType of content element
intSerial number of the content element
stringContent
boolNot used: Was a flag to use existing db instance in global scope
conSetCodeFlag(int $idcatart)
intCategory article id
conSetCodeFlagBulkEditing(array $idcatarts)
arrayList of category article ids
conSyncArticle(int $idart, int $srclang, int $dstlang) : void
intArticle id
intSource language id
intDestination language id
extractNumber(string $string)
stringString var by reference
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 »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 »IP_match($network, $mask, $ip)
| deprecated | [2012-08-02] Use ipMatch() instead |
|---|
addArtspec(string $artspectext, int $online) : void
stringspecification text
intOnline status (1 or 0)
array_csort()
| deprecated | [2012-08-02] Use cArray::csort() instead |
|---|
array_search_recursive($search, $array, $partial, $strict)
| deprecated | [2012-08-02] Use cArray::searchRecursive() instead |
|---|
backToMainArea(bool $send)
boolRedirect Yes/No
buildArticleSelect(string $sName, string $iIdCat, string $sValue) : string
stringName of the SelectBox
stringcategory id
stringValue of the SelectBox
stringHTMLbuildCategorySelect(string $sName, string $sValue, int $sLevel, string $sStyle) : string
stringName of the SelectBox
stringValue of the SelectBox
intValue of highest level that should be shown
stringOptional style informations for select
stringHTMLbuildStackString(int $startlevel) : string
"\tfunction1() called in file $filename($line)" "\tfunction2() called in file $filename($line)" ...
intThe startlevel. Note that 0 is always buildStackString and 1 is the function called buildStackString (e.g. cWarning)
stringcDeprecated($message) : void
cDie(string $file, int $line, string $message)
Logs the message and calls die().
stringFile name (use FILE)
intLine number (use LINE)
stringMessage to display
cError(\Multiple $file, $line, $message)
Examples:
// New version
cWarning('Some error message');
// Old version
cWarning(__FILE__, __LINE__, 'Some error message');
\Multipleparameters
cIDNADecode($targetEncoding, $string)
| deprecated | [2011-08-24] This function is not supported any longer |
|---|
cIDNAEncode($sourceEncoding, $string)
| deprecated | [2011-08-24] This function is not supported any longer |
|---|
cInitializeArrayKey($aArray, $sKey, $mDefault)
| deprecated | 2012-09-05 use function located in cArray instead of this function |
|---|
cWarning()
Examples:
// New version
cWarning('Some warning message');
// Old version
cWarning(__FILE__, __LINE__, 'Some warning message');
callPluginStore(string $entity)
stringName of the directory to scan
checkMySQLConnectivity()
| deprecated | [2012-01-18] cDb performs the check for itself. This method is no longer needed |
|---|
cleanupSessions()
As we are probably soon rewriting the session management, this hack is OK.
| deprecated | [2012-07-??] PHP will handle cleaning up sessions |
|---|
createRandomName(int $nameLength) : string
intLength of the generated string
stringRandom namedefineIfNotDefined(string $constant, mixed $value)
stringName of constant to define
mixedIt's value
define_if($constant, $value)
| deprecated | [2012-08-02] Use defineIfNotDefined() instead |
|---|
deleteArtspec(int $idartspec) : void
intarticle specification id
deleteSystemProperty(string $type, string $name) : bool
stringThe type of the item
stringThe name of the item
booldisplayDatetime(mixed $timestamp, bool $date, bool $time) : string
mixeda timestamp. If no value is given the current time will be used.
boolif true the date will be included in the string
boolif true the time will be included in the string
stringthe formatted timestring.displayPlugin($entity, $form)
| deprecated | [2012-02-26] Function does not work and is not longer supported |
|---|
endAndLogTiming($uuid)
int UUID which has been used for timing
fakeheader($time)
| deprecated | [2012-03-05] This function is not longer supported. |
|---|
getAllClientsAndLanguages() : array
arrayIndexed array where the value is an assoziative array as
follows:
- $arr[0]['idlang']
- $arr[0]['langname']
- $arr[0]['idclient']
- $arr[0]['clientname']
getArtspec() : array
arraylist 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
intLanguage specific ID of the arcticle
getCanonicalDay(int $iDay) : string
intThe day number of date(w)
stringDayname of current languagegetCanonicalMonth(int $month) : string
int
stringgetClientName($idclient)
| deprecated | [2012-06-21] Use cApiClientCollection->getClientname() |
|---|
getEffectiveSetting(string $type, string $name, string $default) : mixed
The order is: System => Client => Group => User
System properties can be overridden by the group, and group properties can be overridden by the user.
stringThe type of the item
stringThe name of the item
stringOptional default value
mixedboolean 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.
stringThe type of the item
arrayValuegetFileExtension($filename)
| deprecated | [2012-06-20] Use getFileType() from functions.file.php |
|---|
getGroupOrUserName($uid)
getIDForArea(int | string $area) : int
intstringArea name or id
intstringgetLanguageNamesByClient(int $client) : array
int
arrayList of languages where the key is the language id and value
the language namegetLanguagesByClient(int $client) : array
int
arraygetNamedFrame(int $frame) : string
intFrame number
stringCanonical name of the framegetParentAreaId(mixed $area) : int
mixed
intgetPhpModuleInfo($moduleName)
| deprecated | [2012-03-10] This function is not longer supported. |
|---|
getSystemProperties(bool $bGetPropId) : array
Array format:
$array[$type][$name] = $value;
| modified | Timo Trautmann 22.02.2008 Support for editing name and type editing by primaray key idsystemprop if bGetPropId is set: $array[$type][$name][value] = $value; $array[$type][$name][idsystemprop] = $idsystemprop; |
|---|
boolIf true special mode is activated which generates for each property a third array, which also contains idsystemprop value
arraygetSystemPropertiesByType(string $type) : array
stringThe type of the properties
arrayAssoziative array like $arr[name] = valuegetSystemProperty(string $type, string $name) : string
stringThe type of the item
stringThe name of the item
stringbool property value or false if nothing was foundgetmicrotime()
htmldecode($string)
humanReadableSize($number)
human_readable_size($number)
| deprecated | [2012-08-02] Use humanReadableSize() instead |
|---|
includePlugins($entity)
Name of the directory to scan
ipMatch(string $network, string $mask, string $ip) : boolean
string
string
string
booleanisAlphanumeric(mixed $test, bool $umlauts) : bool
mixedValue to test
bool[Use german Umlaute] Optional
boolValue is alphanumericisArtInMultipleUse(int $idart) : bool
intArticle-Id
boolArticle assigned to multiple categoriesisGroup($uid)
isImageMagickAvailable()
| deprecated | [2012-06-21] Use capiIsImageMagickAvailable() from functions.api.images.php |
|---|
isRunningFromWeb() : bool
boolTrue if the script is running from the webisUtf8(string $input) : bool
string
boolisValidMail(string $email, bool $strict)
string
boolNo more used!
is_alphanumeric($test, $umlauts)
| deprecated | [2012-08-02] Use isAlphanumeric() instead |
|---|
is_dbfs($file)
| deprecated | [2012-06-20] Use cApiDbfs::isDbfs() |
|---|
is_utf8($input)
| deprecated | [2012-08-02] Use isUtf8() instead |
|---|
locale_arsort($locale, $array)
| deprecated | [2012-08-02] Use cArray::sortWithLocale() instead |
|---|
markSubMenuItem(int $menuitem, bool $return)
intWhich menuitem to mark
boolReturn or echo script
notifyOnError($errortitle, $errormessage)
| deprecated | 2012-09-04 Use cWarning or the like. |
|---|
recursive_copy($from_path, $to_path)
| deprecated | [2012-06-20] Use getFileType() from functions.file.php |
|---|
rereadClients()
| deprecated | no longer needed |
|---|
scanPlugins(string $entity) : void
Result: $cfg['plugins']['frontendusers'] => array with all found plugins
Note: Plugins are only "found" if the following directory structure if found:
entity/ plugin1/plugin1.php plugin2/plugin2.php
The plugin's directory and file name have to be the same, otherwise the function won't find them!
stringName of the directory to scan
sendEncodingHeader(\cDb $db, array $cfg, int $lang, string $contentType)
Based on this informations it will send an HTTP header for right encoding.
arrayGlobal cfg-array
intGlobal language id
stringMime 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
intArticle specification id
setArtspecOnline(int $idartspec, int $online) : void
Flag to switch if an article specification should be shown the frontend or not
intarticle specification id
int0/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 |
|---|
stringThe type of the item
stringThe name of the item
stringThe value of the item
intThe sysprop id, use optional. If set it allows to modify type name and value
set_magic_quotes_gpc(string $code)
stringString by reference
showLocation($area)
| deprecated | [2011-09-02] This function is not supported any longer |
|---|
showTable($tablename)
| deprecated | [2011-08-23] This function is not supported any longer |
|---|
startTiming(string $function, array $parameters) : int
stringName of the function
arrayAll parameters for the function to measure
intuuid for this measure processstr_ireplace_once($find, $replace, $subject)
| deprecated | [2012-08-02] Use cString::iReplaceOnce() instead |
|---|
str_ireplace_once_reverse($find, $replace, $subject)
| deprecated | [2012-08-02] Use cString::iReplaceOnceReverse() instead |
|---|
str_rpos($haystack, $needle, $start)
| deprecated | [2012-08-02] Use cString::posReverse() instead |
|---|
trim_array($array)
| deprecated | [2012-08-02] Use cArray::trim() instead |
|---|
updateClientCache(\number $idclient, string $htmlpath, string $frontendpath)
Reinitializes the $cfgClient array and fills it wih updated information if provided.
\numberclient id which will be updated
stringnew HTML path. Starting with "http://"
stringpath the to the frontend
$constant