eZPublish  4.7
eZSerializedObjectNameList Class Reference
+ 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'
 

Member Function Documentation

eZSerializedObjectNameList::__clone ( )
eZSerializedObjectNameList::alwaysAvailableLanguage ( )
eZSerializedObjectNameList::alwaysAvailableLanguageID ( )
eZSerializedObjectNameList::alwaysAvailableLanguageLocale ( )
eZSerializedObjectNameList::alwaysAvailableName ( )
eZSerializedObjectNameList::appendGroupName (   $appendString)

Appends $appendString string to each name in NameList.

eZSerializedObjectNameList::cleanNameList ( )

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

eZSerializedObjectNameList::copy (   $serializedObjectNameListObject)
eZSerializedObjectNameList::create (   $serializedNamesString = false)
eZSerializedObjectNameList::defaultLanguage ( )

Referenced by copy(), and defaultLanguageLocale().

eZSerializedObjectNameList::defaultLanguageLocale ( )

Referenced by initFromString().

eZSerializedObjectNameList::eZSerializedObjectNameList (   $serializedNamesString = false)
eZSerializedObjectNameList::hasDirtyData ( )
Returns
true if the data is considered dirty(e.g. names were changed)

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

eZSerializedObjectNameList::hasNameInLocale (   $languageLocale)
eZSerializedObjectNameList::initDefault ( )
eZSerializedObjectNameList::initFromSerializedList (   $serializedNamesString)
eZSerializedObjectNameList::initFromString (   $nameString,
  $languageLocale = false 
)

Referenced by initDefault().

eZSerializedObjectNameList::isEmpty ( )
eZSerializedObjectNameList::languageLocaleList ( )
eZSerializedObjectNameList::languageMask ( )
eZSerializedObjectNameList::languages ( )

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

Returns
array of language objects.
eZSerializedObjectNameList::mergeNameList (   $inNameList)

Referenced by normalize().

eZSerializedObjectNameList::name (   $languageLocale = false)

Referenced by setName().

eZSerializedObjectNameList::nameByLanguageLocale (   $languageLocale)
eZSerializedObjectNameList::nameByPrioritizedLanguages ( )

Referenced by name().

static eZSerializedObjectNameList::nameFromSerializedString (   $serializedNames,
  $languageLocale = false 
)
static
eZSerializedObjectNameList::nameList ( )
eZSerializedObjectNameList::nameListCount ( )
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.

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.

Referenced by prioritizedLanguagesJsArray(), and untranslatedLanguages().

eZSerializedObjectNameList::prioritizedLanguagesJsArray ( )
eZSerializedObjectNameList::removeName (   $languageLocale)

Referenced by validate().

eZSerializedObjectNameList::resetNameList ( )

Referenced by normalize().

eZSerializedObjectNameList::serializeNames ( )
eZSerializedObjectNameList::setAlwaysAvailableLanguage (   $languageLocale)

Referenced by updateAlwaysAvailable().

eZSerializedObjectNameList::setDefaultLanguage (   $language)
eZSerializedObjectNameList::setDefaultLanguageByLocale (   $languageLocale,
  $createIfNotExist = true 
)
eZSerializedObjectNameList::setHasDirtyData (   $hasDirtyData = true)
eZSerializedObjectNameList::setName (   $name,
  $languageLocale = false 
)

Referenced by validate().

eZSerializedObjectNameList::setNameByLanguageLocale (   $name,
  $languageLocale 
)

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

eZSerializedObjectNameList::setNameList (   $nameListArray)

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.

Referenced by topPriorityLanguageLocale().

eZSerializedObjectNameList::topPriorityLanguageLocale ( )

The same as 'topPriorityLanguage' but returns language locale.

Returns
language locale.

Referenced by setName().

eZSerializedObjectNameList::unserializeNames (   $serializedNamesString)

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'.
eZSerializedObjectNameList::updateAlwaysAvailable (   $alwaysAvailableLocale = false)

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.

Member Data Documentation

eZSerializedObjectNameList::$DefaultLanguage

Referenced by defaultLanguage().

eZSerializedObjectNameList::$HasDirtyData

Referenced by hasDirtyData().

eZSerializedObjectNameList::$NameList

Referenced by nameList().


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