Static Public Member Functions
static	path (array $elements, string $separator=DIRECTORY_SEPARATOR)

static	getUserCN (string $user_id, ?string $user_name, ?string $user_firstname, ?string $user_displayname)

static	cleanIds ($ids)

static	versionsCompare (string $current_version, string $required_version, string $operator='>=', bool $strict=true)

static	cssLoad (string $src, string $media='screen', ?string $version=null)

static	cssModuleLoad (string $src, string $media='screen', ?string $version=null)

static	jsLoad (string $src, ?string $version=null)

static	jsModuleLoad (string $src, ?string $version=null)

static	jsVars (array $vars)

static	jsVar (string $name, $value)

static	jsJson (string $id, $vars)

static	lexicalSort (array &$arr, string $namespace='', string $lang='en_US')

static	lexicalArraySort (array &$arr, string $namespace='', string $lang='en_US')

static	lexicalKeySort (array &$arr, string $namespace='', string $lang='en_US')

static	setLexicalLang (string $namespace='', string $lang='en_US')

static	removeDiacritics (string $str)

Static Protected Attributes
static	$defaultDiacriticsRemovalMap

Member Function Documentation

◆ path()

static path	(	array	$elements,
		string	$separator = `DIRECTORY_SEPARATOR`
	)

static

Make a path from a list of names

The .. (parent folder) names will be reduce if possible by removing their's previous item Ex: path(['main', 'sub', '..', 'inc']) will return 'main/inc'

Parameters

array	$elements	The elements
string	$separator	The separator

Returns: string

◆ getUserCN()

static getUserCN	(	string	$user_id,
		?string	$user_name,
		?string	$user_firstname,
		?string	$user_displayname
	)

static

Static function that returns user's common name given to his user_id, user_name, user_firstname and user_displayname.

Parameters

string	$user_id	The user identifier
string	$user_name	The user name
string	$user_firstname	The user firstname
string	$user_displayname	The user displayname

Returns: string The user cn.

Referenced by dcAuth\checkUser(), rsExtPost\getAuthorCN(), rsExtLog\getUserCN(), and dcAdminCombos\getUsersCombo().

◆ cleanIds()

static cleanIds ( $ids )

static

Cleanup a list of IDs

Parameters

mixed $ids The identifiers

Returns: array

Referenced by dcBlog\delComments(), dcBlog\delPosts(), dcBlog\firstPublicationEntries(), dcBlog\triggerComments(), dcBlog\updCommentsStatus(), dcBlog\updPostsCategory(), dcBlog\updPostsSelected(), and dcBlog\updPostsStatus().

◆ versionsCompare()

static versionsCompare	(	string	$current_version,
		string	$required_version,
		string	$operator = `'>='`,
		bool	$strict = `true`
	)

static

Compare two versions with option of using only main numbers.

Parameters

string	$current_version	Current version
string	$required_version	Required version
string	$operator	Comparison operand
bool	$strict	Use full version

Returns: bool True if comparison success

Referenced by dcStoreParser\_parse(), dcStore\check(), and dcModules\installPackage().

◆ cssLoad()

static cssLoad	(	string	$src,
		string	$media = `'screen'`,
		?string	$version = `null`
	)

static

Return a HTML CSS resource load (usually in HTML head)

Parameters

string	$src	The source
string	$media	The media
string	$version	The version

Returns: string

References $version, and html\escapeHTML().

Referenced by cssModuleLoad().

◆ cssModuleLoad()

static cssModuleLoad	(	string	$src,
		string	$media = `'screen'`,
		?string	$version = `null`
	)

static

Return a HTML CSS resource (from module) load (usually in HTML head)

Parameters

string	$src	The source
string	$media	The media
string	$version	The version

Returns: string

References $version, dcCore\app(), and cssLoad().

◆ jsLoad()

static jsLoad	(	string	$src,
		?string	$version = `null`
	)

static

Return a HTML JS resource load (usually in HTML head)

Parameters

string	$src	The source
string	$version	The version

Returns: string

References $version, and html\escapeHTML().

Referenced by jsModuleLoad().

◆ jsModuleLoad()

static jsModuleLoad	(	string	$src,
		?string	$version = `null`
	)

static

Return a HTML JS resource (from a module) load (usually in HTML head)

Parameters

string	$src	The source
string	$version	The version

Returns: string

References $version, dcCore\app(), and jsLoad().

◆ jsVars()

static jsVars ( array $vars )

static

Return a list of javascript variables définitions code

Deprecated:: 2.15 use dcUtils::jsJson() and dotclear.getData()/dotclear.mergeDeep() in javascript

Parameters

array $vars The variables

Returns: string javascript code (inside <script… ></script>)

References $ret, and html\escapeJS().

Referenced by jsVar().

◆ jsVar()

static jsVar	(	string	$name,
			$value
	)

static

Return a javascript variable definition line code

Deprecated:: 2.15 use dcUtils::jsJson() and dotclear.getData()/dotclear.mergeDeep() in javascript

Parameters

string	$name	variable name
mixed	$value	value

Returns: string javascript code

References jsVars().

◆ jsJson()

static jsJson	(	string	$id,
			$vars
	)

static

Return a list of variables into a HML script (application/json) container

Parameters

string	$id	The identifier
mixed	$vars	The variables

Returns: string

References html\escapeHTML().

Referenced by dcPage\jsJson(), dcPage\open(), and dcPage\openPopup().

◆ lexicalSort()

static lexicalSort	(	array &	$arr,
		string	$namespace = `''`,
		string	$lang = `'en_US'`
	)

static

Locale specific array sorting function

Parameters

array	$arr	single array of strings
string	$namespace	admin/public/lang
string	$lang	language to be used if $ns = 'lang'

Returns: bool

References setLexicalLang().

◆ lexicalArraySort()

static lexicalArraySort	(	array &	$arr,
		string	$namespace = `''`,
		string	$lang = `'en_US'`
	)

static

Locale specific array sorting function (preserving keys)

Parameters

array	$arr	single array of strings
string	$namespace	admin/public/lang
string	$lang	language to be used if $ns = 'lang'

Returns: bool

References setLexicalLang().

◆ lexicalKeySort()

static lexicalKeySort	(	array &	$arr,
		string	$namespace = `''`,
		string	$lang = `'en_US'`
	)

static

Locale specific array sorting function (sorting keys)

Parameters

array	$arr	single array of strings
string	$namespace	admin/public/lang
string	$lang	language to be used if $ns = 'lang'

Returns: bool

References setLexicalLang().

Referenced by dcMenu\draw(), and adminPostFilter\getPostUserFilter().

◆ setLexicalLang()

static setLexicalLang	(	string	$namespace = `''`,
		string	$lang = `'en_US'`
	)

static

Sets the lexical language.

Parameters

string	$namespace	The namespace (admin/public/lang)
string	$lang	The language

References dcCore\app().

Referenced by lexicalArraySort(), lexicalKeySort(), and lexicalSort().

◆ removeDiacritics()

static removeDiacritics ( string $str )

static

Removes diacritics from a string.

Removes diacritics from strings containing Latin-1 Supplement, Latin Extended-A, Latin Extended-B and Latin Extended Additional special characters.

see https://github.com/infralabs/DiacriticsRemovePHP

Parameters

string $str The string

Returns: string

References $defaultDiacriticsRemovalMap.

Referenced by dcMeta\computeMetaStats(), and dcWidgets\elements().

Field Documentation

◆ $defaultDiacriticsRemovalMap

$defaultDiacriticsRemovalMap

staticprotected

Referenced by removeDiacritics().

The documentation for this class was generated from the following file:

inc/core/class.dc.utils.php

Static Public Member Functions

Static Protected Attributes

Member Function Documentation

◆ path()

◆ getUserCN()

◆ cleanIds()

◆ versionsCompare()

◆ cssLoad()

◆ cssModuleLoad()

◆ jsLoad()

◆ jsModuleLoad()

◆ jsVars()

◆ jsVar()

◆ jsJson()

◆ lexicalSort()

◆ lexicalArraySort()

◆ lexicalKeySort()

◆ setLexicalLang()

◆ removeDiacritics()

Field Documentation

◆ $defaultDiacriticsRemovalMap