Inheritance diagram for eZSerializedObjectNameList:

Public Member Functions
	__clone ()
	alwaysAvailableLanguage ()
	alwaysAvailableLanguageID ()
	alwaysAvailableLanguageLocale ()
	alwaysAvailableName ()
	appendGroupName ($appendString)
	cleanNameList ()
	copy ($serializedObjectNameListObject)
	create ($serializedNamesString=false)
	defaultLanguage ()
	defaultLanguageLocale ()
	eZSerializedObjectNameList ($serializedNamesString=false)
	hasDirtyData ()
	hasNameInLocale ($languageLocale)
	initDefault ()
	initFromSerializedList ($serializedNamesString)
	initFromString ($nameString, $languageLocale=false)
	isEmpty ()
	languageLocaleList ()
	languageMask ()
	languages ()
	mergeNameList ($inNameList)
	name ($languageLocale=false)
	nameByLanguageLocale ($languageLocale)
	nameByPrioritizedLanguages ()
	nameList ()
	nameListCount ()
	normalize ($languageInfo)
	prioritizedLanguages ()
	prioritizedLanguagesJsArray ()
	removeName ($languageLocale)
	resetNameList ()
	serializeNames ()
	setAlwaysAvailableLanguage ($languageLocale)
	setDefaultLanguage ($language)
	setDefaultLanguageByLocale ($languageLocale, $createIfNotExist=true)
	setHasDirtyData ($hasDirtyData=true)
	setName ($name, $languageLocale=false)
	setNameByLanguageLocale ($name, $languageLocale)
	setNameList ($nameListArray)
	topPriorityLanguage ()
	topPriorityLanguageLocale ()
	unserializeNames ($serializedNamesString)
	untranslatedLanguages ()
	updateAlwaysAvailable ($alwaysAvailableLocale=false)
	validate ($param=true)
Static Public Member Functions
static	nameFromSerializedString ($serializedNames, $languageLocale=false)
Public Attributes
	$DefaultLanguage
	$HasDirtyData
	$NameList
const	ALWAYS_AVAILABLE_STR = 'always-available'

Detailed Description

Definition at line 29 of file ezserializedobjectnamelist.php.

Member Function Documentation

eZSerializedObjectNameList::__clone ( )

Definition at line 68 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::alwaysAvailableLanguage ( )

Definition at line 124 of file ezserializedobjectnamelist.php.

Referenced by prioritizedLanguages(), and topPriorityLanguage().

eZSerializedObjectNameList::alwaysAvailableLanguageID ( )

Definition at line 110 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::alwaysAvailableLanguageLocale ( )

Definition at line 118 of file ezserializedobjectnamelist.php.

Referenced by alwaysAvailableLanguageID(), and updateAlwaysAvailable().

eZSerializedObjectNameList::alwaysAvailableName ( )

Definition at line 182 of file ezserializedobjectnamelist.php.

Referenced by nameByPrioritizedLanguages().

eZSerializedObjectNameList::appendGroupName ( $ appendString )

Appends $appendString string to each name in NameList.

Definition at line 270 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::cleanNameList ( )

Same as 'nameList()' but without 'always-available' entry.

Definition at line 314 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::copy ( $ serializedObjectNameListObject )

Definition at line 72 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::create ( $ serializedNamesString = false )

Reimplemented in eZContentClassAttributeNameList, and eZContentClassNameList.

Definition at line 62 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::defaultLanguage ( )

Definition at line 356 of file ezserializedobjectnamelist.php.

Referenced by copy(), and defaultLanguageLocale().

eZSerializedObjectNameList::defaultLanguageLocale ( )

Definition at line 345 of file ezserializedobjectnamelist.php.

Referenced by initFromString().

eZSerializedObjectNameList::eZSerializedObjectNameList ( $ serializedNamesString = false )

Definition at line 33 of file ezserializedobjectnamelist.php.

Referenced by create(), eZContentClassAttributeNameList\eZContentClassAttributeNameList(), eZContentClassNameList\eZContentClassNameList(), and nameFromSerializedString().

eZSerializedObjectNameList::hasDirtyData ( )

Returns:: true if the data is considered dirty(e.g. names were changed)

Definition at line 292 of file ezserializedobjectnamelist.php.

Referenced by copy(), and eZContentClassNameList\store().

eZSerializedObjectNameList::hasNameInLocale ( $ languageLocale )

Definition at line 221 of file ezserializedobjectnamelist.php.

Referenced by nameByLanguageLocale(), nameByPrioritizedLanguages(), and updateAlwaysAvailable().

eZSerializedObjectNameList::initDefault ( )

Definition at line 57 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::initFromSerializedList ( $ serializedNamesString )

Definition at line 41 of file ezserializedobjectnamelist.php.

Referenced by eZSerializedObjectNameList(), and initFromString().

eZSerializedObjectNameList::initFromString	(	$	nameString,
		$	languageLocale = `false`
	)

Definition at line 47 of file ezserializedobjectnamelist.php.

Referenced by initDefault().

eZSerializedObjectNameList::isEmpty ( )

Definition at line 92 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::languageLocaleList ( )

Definition at line 471 of file ezserializedobjectnamelist.php.

Referenced by languages(), prioritizedLanguages(), and topPriorityLanguage().

eZSerializedObjectNameList::languageMask ( )

Definition at line 133 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::languages ( )

The same as 'languageLocaleList' but returns a list of 'eZContentLanguage' objects.

Returns:: array of language objects.

Definition at line 492 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::mergeNameList ( $ inNameList )

Definition at line 79 of file ezserializedobjectnamelist.php.

Referenced by normalize().

eZSerializedObjectNameList::name ( $ languageLocale = false )

Definition at line 152 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::nameByLanguageLocale ( $ languageLocale )

Definition at line 173 of file ezserializedobjectnamelist.php.

Referenced by alwaysAvailableName(), name(), nameByPrioritizedLanguages(), and eZContentClassNameList\store().

eZSerializedObjectNameList::nameByPrioritizedLanguages ( )

Definition at line 157 of file ezserializedobjectnamelist.php.

Referenced by name().

static eZSerializedObjectNameList::nameFromSerializedString	(	$	serializedNames,
		$	languageLocale = `false`
	)		`[static]`

Definition at line 282 of file ezserializedobjectnamelist.php.

Referenced by eZInformationCollectionAttribute\contentClassAttributeName().

eZSerializedObjectNameList::nameList ( )

Definition at line 306 of file ezserializedobjectnamelist.php.

Referenced by cleanNameList(), copy(), nameListCount(), updateAlwaysAvailable(), and validate().

eZSerializedObjectNameList::nameListCount ( )

Definition at line 321 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::normalize ( $ languageInfo )

Parameters:

$languageInfo. languageInfo = array( 'map_table' => array( [<lang> => <to_lang>], [<lang> => 'skip_language'], .... ) );

Note: it's probably needed to call 'validate' after 'normalize'. 'normialize' doesnt' check whether language exist or not, cause you can have names in languages which are not in 'map_table', so you need to call 'validate' anyway.

Definition at line 535 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::prioritizedLanguages ( )

Returns an array of languages in which contentclass has translations. However, if there is a name in language which is not listed as 'available' for siteaccess, that langugese will not be returned (except of 'always available' language).

Returns:: an array of language's locales.

Definition at line 433 of file ezserializedobjectnamelist.php.

Referenced by nameByPrioritizedLanguages(), prioritizedLanguagesJsArray(), and untranslatedLanguages().

eZSerializedObjectNameList::prioritizedLanguagesJsArray ( )

Definition at line 451 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::removeName ( $ languageLocale )

Definition at line 336 of file ezserializedobjectnamelist.php.

Referenced by validate().

eZSerializedObjectNameList::resetNameList ( )

Definition at line 331 of file ezserializedobjectnamelist.php.

Referenced by normalize().

eZSerializedObjectNameList::serializeNames ( )

Definition at line 87 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::setAlwaysAvailableLanguage ( $ languageLocale )

Definition at line 193 of file ezserializedobjectnamelist.php.

Referenced by updateAlwaysAvailable().

eZSerializedObjectNameList::setDefaultLanguage ( $ language )

Definition at line 366 of file ezserializedobjectnamelist.php.

Referenced by setDefaultLanguageByLocale().

eZSerializedObjectNameList::setDefaultLanguageByLocale	(	$	languageLocale,
		$	createIfNotExist = `true`
	)

Definition at line 371 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::setHasDirtyData ( $ hasDirtyData = true )

Sets whether the object has dirty data or not.

See also:: hasDirtyData, sync

Definition at line 301 of file ezserializedobjectnamelist.php.

Referenced by mergeNameList(), removeName(), setAlwaysAvailableLanguage(), setNameByLanguageLocale(), eZContentClassNameList\store(), and unserializeNames().

eZSerializedObjectNameList::setName	(	$	name,
		$	languageLocale = `false`
	)

Definition at line 239 of file ezserializedobjectnamelist.php.

Referenced by validate().

eZSerializedObjectNameList::setNameByLanguageLocale	(	$	name,
		$	languageLocale
	)

Definition at line 247 of file ezserializedobjectnamelist.php.

Referenced by mergeNameList(), normalize(), and setName().

eZSerializedObjectNameList::setNameList ( $ nameListArray )

Definition at line 326 of file ezserializedobjectnamelist.php.

Referenced by resetNameList().

eZSerializedObjectNameList::topPriorityLanguage ( )

Returns top prioriry language for which there is translation according to siteaccess's available language list. If there is no translations for languages listed in siteaccess's available language list it returns 'always available' language.

Returns:: language object.

Definition at line 411 of file ezserializedobjectnamelist.php.

Referenced by defaultLanguage(), and topPriorityLanguageLocale().

eZSerializedObjectNameList::topPriorityLanguageLocale ( )

The same as 'topPriorityLanguage' but returns language locale.

Returns:: language locale.

Definition at line 392 of file ezserializedobjectnamelist.php.

Referenced by setName().

eZSerializedObjectNameList::unserializeNames ( $ serializedNamesString )

Definition at line 97 of file ezserializedobjectnamelist.php.

Referenced by initFromSerializedList().

eZSerializedObjectNameList::untranslatedLanguages ( )

Returns an array of languages for which translations don't exist.

Returns:: an array of languages. Each key in this array is 'language locale'.

Definition at line 508 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::updateAlwaysAvailable ( $ alwaysAvailableLocale = false )

Definition at line 207 of file ezserializedobjectnamelist.php.

Referenced by normalize(), and validate().

eZSerializedObjectNameList::validate ( $ param = true )

Make sure that languages namelist corresponds to languages in the system.

Parameters:

$param. TRUE - create languages if they don't exist in the system. FALSE - remove names form namelist if corresponding language doesn't exist in the system. array - language map. The name will be removed if its language is not in the map. Ex: array( 'language_locale_1' => 'map_to_language_locale', 'language_locale_2' => 'skip' ); will map name in 'language_locale_1' language to 'map_to_language_locale' and remove name in 'language_locale_2'. 'map_to_language_locale' language will be created If it doesn't exist in the system.

Definition at line 587 of file ezserializedobjectnamelist.php.

Member Data Documentation

eZSerializedObjectNameList::$DefaultLanguage

Definition at line 643 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::$HasDirtyData

Definition at line 642 of file ezserializedobjectnamelist.php.

eZSerializedObjectNameList::$NameList

Definition at line 641 of file ezserializedobjectnamelist.php.

const eZSerializedObjectNameList::ALWAYS_AVAILABLE_STR = 'always-available'

Definition at line 31 of file ezserializedobjectnamelist.php.

Referenced by alwaysAvailableLanguage(), alwaysAvailableLanguageLocale(), alwaysAvailableName(), appendGroupName(), cleanNameList(), initFromString(), languageLocaleList(), languageMask(), setAlwaysAvailableLanguage(), and validate().

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

ezserializedobjectnamelist.php

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation