contenido\includes\functions.general.php

Show:

inherited

Constants
Functions

Table of Contents

Project: Contenido Content Management System

Description: Defines the general contenido functions

Requirements:

Author: Jan Lengowski
Con_php_req: 5.0
Copyright: four for business AG
License: http://www.contenido.org/license/LIZENZ.txt
Link: http://www.4fb.de
Link: http://www.contenido.org
Package: Contenido Backend includes
Since: file available since contenido release <= 4.6 {@internal created unknown modified 2008-06-26, Frederic Schneider, add security fix modified 2008-07-03, Dominik Ziegler, fixed bug CON-143 modified 2009-02-15, Murat Purc, fixed bug CON-238 modified 2010-09-29, Ortwin Pinke, fixed bug CON-349 modified 2010-12-16, Dominik Ziegler, display error message on database connection failure [#CON-376] $Id: functions.general.php 1246 2010-12-16 13:13:04Z dominik.ziegler $: }}
Version: 1.3.4

Constants

 
                $constant
                = $value

 
                PHP_EOL
                = "\r\n"

 
                PHP_EOL
                = "\n"

Functions

SaveKeywordsforart( $keycode, $idart, $place, $lang) : void

Parameters

Name	Type	Description
$keycode
$idart
$place
$lang

Details

Deprecated: since 22.08.2005 This function is called everytime when the code of an article is generated. In this case indexing can cause performance problems. Indexing an article is treated now in function conSaveContentEntry.

addArtspec(string $artspectext, $online) : void

add new article specification

Parameters

Name	Type	Description
$artspectext	string	article specification text
$online

array_combine( $keys, $values) : void

Parameters

Name	Type	Description
$keys
$values

array_csort() : void

array_search_recursive( $search, $array, $partial = false, $strict = false) : void

Parameters

Name	Type	Description
$search
$array
$partial
$strict

backToMainArea(bool $send) : void

Redirect to main area

Parameters

Name	Type	Description
$send	bool	Redirect Yes/No

Details

Author: Jan Lengowski
Copyright: four for business AG

buildArticleSelect(String $sName, String $iIdCat, $sValue) : String

Build a Article select Box

Parameters

Name	Type	Description
$sName	String	Name of the SelectBox
$iIdCat	String	Value of the SelectBox
$sValue

Returns

Type	Description
String	HTML

buildCategorySelect(String $sName, String $sValue, Integer $sLevel = 0, String $sStyle = "") : String

Build a Category / Article select Box

Parameters

Name	Type	Description
$sName	String	Name of the SelectBox
$sValue	String	Value of the SelectBox
$sLevel	Integer	Value of highest level that should be shown
$sStyle	String	Optional style informations for select

Returns

Type	Description
String	HTML

cDie( $file, $line, $message) : void

cDie: Contenido die-alternative

Parameters

Name	Type	Description
$file		File name (use FILE)
$line		Line number (use LINE)
$message		Message to display

cError( $file, $line, $message) : void

cError: Contenido error

Parameters

Name	Type	Description
$file		File name (use FILE)
$line		Line number (use LINE)
$message		Message to display

cIDNADecode( $targetEncoding, $string) : void

Parameters

Name	Type	Description
$targetEncoding
$string

cIDNAEncode( $sourceEncoding, $string) : void

Parameters

Name	Type	Description
$sourceEncoding
$string

cInitializeArrayKey( $aArray, $sKey, $mDefault = "") : void

Parameters

Name	Type	Description
$aArray
$sKey
$mDefault

cWarning( $file, $line, $message) : void

cWarning: Contenido warning

Parameters

Name	Type	Description
$file		File name (use FILE)
$line		Line number (use LINE)
$message		Message to display

callPluginStore( $entity) : void

callPluginStore: Calls the plugin's store methods

Example: callPluginStore("frontendusers");

Parameters

Name	Type	Description
$entity		Name of the directory to scan

checkMySQLConnectivity() : void

cleanupSessions() : void

createRandomName( $nameLength) : string

createRandomName: Creates a random name (example: Passwords)

Example: echo createRandomName(8);

Parameters

Name	Type	Description
$nameLength		Length of the generated string

Returns

Type	Description
string	random name

define_if( $constant, $value) : void

Parameters

Name	Type	Description
$constant
$value

deleteArtspec(integer $idartspec) : void

delete specified article specification

Parameters

Name	Type	Description
$idartspec	integer	article specification id

deleteSystemProperty(string $type, string $name) : void

Remove a system property entry

Parameters

Name	Type	Description
$type	string	The type of the item
$name	string	The name of the item

displayPlugin( $entity, $form) : void

Parameters

Name	Type	Description
$entity
$form

endAndLogTiming(\uuid $uuid) : void

endAndLogTiming: Ends the timing process and logs it to the timings file

Parameters

Name	Type	Description
$uuid	\uuid	int UUID which has been used for timing

fakeheader( $time) : void

Parameters

Name	Type	Description
$time

file_get_contents( $filename, $use_include_path = 0) : void

Parameters

Name	Type	Description
$filename
$use_include_path

file_put_contents( $filename, $content) : void

Parameters

Name	Type	Description
$filename
$content

getArtspec() : array

retrieve list of article specifications for current client and language

Returns

Type	Description
array	list of article specifications

getAvailableContentTypes(int $idartlang) : void

Extracts the available content- types from the database

Creates an array $a_content[type][number] = content string f.e. $a_content['CMS_HTML'][1] = content string Same for array $a_description

Parameters

Name	Type	Description
$idartlang	int	Language specific ID of the arcticle

Details

Author: Jan Lengowski
Copyright: four for business AG

getCanonicalDay(integer $iDay) : string

Get multi-language day

Parameters

Name	Type	Description
$iDay	integer	the day number of date(w)

Returns

Type	Description
string	Dayname of current language

getCanonicalMonth( $month) : void

Parameters

Name	Type	Description
$month

getClientName( $idclient) : string

getClientName: Returns the client name for a given ID

Parameters

Name	Type	Description
$idclient

Returns

Type	Description
string	client name

getEffectiveSetting(string $type, string $name, string $default = "") : mixed

Returns the current effective setting for a property.

The order is: System => Client => Group => User

System properties can be overridden by the group, and group properties can be overridden by the user.

Parameters

Name	Type	Description
$type	string	The type of the item
$name	string	The name of the item
$default	string	Optional default value

Returns

Type	Description
mixed	boolean false if nothing was found

getEffectiveSettingsByType( $sType) : array

Returns the current effective settings for a type of properties.

The order is: System => Client => Group => User

System properties can be overridden by the group, and group properties can be overridden by the user.

Parameters

Name	Type	Description
$sType

Returns

Type	Description
array	Value

getFileExtension(string $filename) : \extension

getFileExtension Returns the file extension of a given file

Parameters

Name	Type	Description
$filename	string	Name of the file

Returns

Type	Description
\extension	on success, false if no extension could be extracted.

getGroupOrUserName( $uid) : void

Parameters

Name	Type	Description
$uid

getIDForArea( $area) : void

Parameters

Name	Type	Description
$area

getLanguageNamesByClient( $client) : void

Parameters

Name	Type	Description
$client

getLanguagesByClient( $client) : void

Parameters

Name	Type	Description
$client

getNamedFrame( $frame) : string

getNamedFrame: Returns the name of the numeric frame given

Parameters

Name	Type	Description
$frame		Frame number

Returns

Type	Description
string	Canonical name of the frame

getParentAreaId( $area) : void

Parameters

Name	Type	Description
$area

getPhpModuleInfo( $moduleName) : array

getPhpModuleInfo - parses phpinfo() output

parses phpinfo() output (1) get informations for a specific module (parameter $modulname) (2) get informations for all modules (no parameter for $modulname needed)

if a specified extension doesn't exists or isn't activated an array will be returned: Array ( [error] => extension is not available )

to get specified information on one module use (1): getPhpModuleInfo($moduleName = 'gd');

to get all informations use (2): getPhpModuleInfo($moduleName);

EXAMPLE OUTPUT (1): Array ( [GD Support] => Array ( [0] => enabled ) ... )

EXAMPLE OUTPUT (2): Array ( [yp] => Array ( [YP Support] => Array ( [0] => enabled )

... }

foreach ($moduleSettings as $setting => $value) $setting contains the modul settings $value contains the settings as an array ($value[0] => Local Value && $value[1] => Master Value)

Parameters

Name	Type	Description
$moduleName

Returns

Type	Description
array	see above for example

Details

Author: Marco Jahn

getSystemProperties(boolean $bGetPropId = 0) : array

Retrieves all available system properties.

Array format:

$array[$type][$name] = $value;

Parameters

Name	Type	Description
$bGetPropId	boolean	bGetPropId - if true special mode is activated which generates for each property a third array, which also contains idsystemprop value

Returns

Type	Description
array

Details

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;

getSystemPropertiesByType( $sType) : array

Gets system property entries

Parameters

Name	Type	Description
$sType

Returns

Type	Description
array	Value

getSystemProperty(string $type, string $name) : mixed

Gets a system property entry

Parameters

Name	Type	Description
$type	string	The type of the item
$name	string	The name of the item

Returns

Type	Description
mixed	boolean false if nothing was found, or

get_include_path() : void

getmicrotime() : void

htmldecode( $string) : void

Parameters

Name	Type	Description
$string

human_readable_size( $number) : void

Parameters

Name	Type	Description
$number

includePlugins( $entity) : void

includePlugins: Includes plugins for a given entity

Example: includePlugins("frontendusers");

Parameters

Name	Type	Description
$entity		Name of the directory to scan

isGroup( $uid) : void

Parameters

Name	Type	Description
$uid

isImageMagickAvailable() : boolean

isImageMagickAvailable - checks if ImageMagick is available

Returns

Type	Description
boolean	true if ImageMagick is available

isRunningFromWeb() : boolean

isRunningFromWeb - checks if the script is being runned from the web

Returns

Type	Description
boolean	true if the script is running from the web

isValidMail( $sEMail, $bStrict = false) : void

Parameters

Name	Type	Description
$sEMail
$bStrict

is_a( $object, $className) : void

Parameters

Name	Type	Description
$object
$className

is_alphanumeric(Mixed $test, Bool $umlauts = true) : Bool

Checks if a value is alphanumeric

Parameters

Name	Type	Description
$test	Mixed	Value to test
$umlauts	Bool	[Use german Umlaute] Optional

Returns

Type	Description
Bool	Value is alphanumeric

is_dbfs( $file) : void

Parameters

Name	Type	Description
$file

locale_arsort( $locale, $array) : void

Parameters

Name	Type	Description
$locale
$array

markSubMenuItem(int $menuitem, bool $return = false) : void

Write JavaScript to mark

Parameters

Name	Type	Description
$menuitem	int	Which menuitem to mark
$return	bool	Return or echo script

Details

Author: Jan Lengowski
Copyright: four for business AG

mime_content_type( $file) : void

Parameters

Name	Type	Description
$file

notifyOnError( $errortitle, $errormessage) : void

Parameters

Name	Type	Description
$errortitle
$errormessage

recursive_copy( $from_path, $to_path) : void

Parameters

Name	Type	Description
$from_path
$to_path

rereadClients() : void

restore_include_path() : void

scanDirectory( $sDirectory, $bRecursive = false) : void

Parameters

Name	Type	Description
$sDirectory
$bRecursive

scanPlugins( $entity) : string

scanPlugins: Scans a given plugin directory and places the found plugins into the array $cfg['plugins']

Example: scanPlugins("frontendusers");

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!

Parameters

Name	Type	Description
$entity		Name of the directory to scan

Returns

Type	Description
string	client name

sendEncodingHeader(\DB_Contenido $db, array $cfg, int $lang) : void

Function checks current language and client settings by HTTP-Params and DB settings.

Based on this informations it will send an HTTP header for right encoding.

Parameters

Name	Type	Description
$db	\DB_Contenido
$cfg	array	global cfg-array
$lang	int	global language id

Details

Author: Holger Librenz
Since: 4.6.18
Version: 1.0.0

sendPostRequest( $host, $path, $data, $referer = "", $port = 80) : void

sendPostRequest: Sents a HTTP POST request

Example: sendPostRequest("hostname", "serverpath/test.php", $data);

Parameters

Name	Type	Description
$host		Hostname or domain
$path
$data		Data to send
$referer		Referer (optional)
$port		Port (default: 80)

setArtspecDefault(integer $idartspec) : void

set a default article specification

while creating a new article this defined article specification will be default setting

Parameters

Name	Type	Description
$idartspec	integer	article specification id

setArtspecOnline(integer $idartspec, integer $online) : void

set article specifications online

flag to switch if an article specification should be shown the frontend or not

Parameters

Name	Type	Description
$idartspec	integer	article specification id
$online	integer	0/1 switch the status between on an offline

setHelpContext( $area) : void

Parameters

Name	Type	Description
$area

setSystemProperty(string $type, string $name, string $value, int $idsystemprop = 0) : void

Sets a system property entry

Parameters

Name	Type	Description
$type	string	The type of the item
$name	string	The name of the item
$value	string	The value of the item
$idsystemprop	int	The sysprop id, use optional. If set it allows to modify type name and value

Details

Modified: Timo Trautmann 22.02.2008 Support for editing name and type

set_include_path( $path) : void

Parameters

Name	Type	Description
$path

set_magic_quotes_gpc( $code) : void

Parameters

Name	Type	Description
$code

showLocation( $area) : void

Parameters

Name	Type	Description
$area

showTable( $tablename) : void

Parameters

Name	Type	Description
$tablename

startTiming(\function $function, \parameters $parameters = array()) : int

startTiming: Starts the timing for a specific function

Parameters

Name	Type	Description
$function	\function	string Name of the function
$parameters	\parameters	array All parameters for the function to measure

Returns

Type	Description
int	uuid for this measure process

str_ireplace( $find, $replace, $string) : void

Parameters

Name	Type	Description
$find
$replace
$string

str_ireplace_once( $find, $replace, $subject) : string

str_ireplace_once - Replaces a string only once

Caution: This function only takes strings as parameters, not arrays!

Parameters

Name	Type	Description
$find		string String to find
$replace		string String to replace
$subject		string String to process

Returns

Type	Description
string	Processed string

str_ireplace_once_reverse( $find, $replace, $subject) : string

str_ireplace_once_reverse - Replaces a string only once, in reverse direction

Caution: This function only takes strings as parameters, not arrays!

Parameters

Name	Type	Description
$find		string String to find
$replace		string String to replace
$subject		string String to process

Returns

Type	Description
string	Processed string

str_rpos( $haystack, $needle, $start = 0) : string

str_rpos - Finds a string position in reverse direction

NOTE: The original strrpos-Function of PHP4 only finds a single character as needle.

Parameters

Name	Type	Description
$haystack		string String to search in
$needle		string String to search for
$start		integer Offset

Returns

Type	Description
string	Processed string

stripos( $haystack, $needle, $offset = 0) : void

Parameters

Name	Type	Description
$haystack
$needle
$offset

trim_array(array $array) : array

Trims an array

Parameters

Name	Type	Description
$array	array	Array to trim

Returns

Type	Description
array	Trimmed array