PHP Class eZ\Publish\Core\Repository\LanguageService

Inheritance: implements eZ\Publish\API\Repository\LanguageService

Show file Open project: ezsystems/ezpublish-kernel

Protected Properties

Property	Type	Description
$languageHandler	eZ\Publish\SPI\Persistence\Content\Language\Handler
$repository	eZ\Publish\API\Repository\Repository
$settings	array

Public Methods

Method	Description
__construct ( eZ\Publish\API\Repository\Repository $repository, eZ\Publish\SPI\Persistence\Content\Language\Handler $languageHandler, array $settings = [] )	Setups service with reference to repository object that created it & corresponding handler.
createLanguage ( eZ\Publish\API\Repository\Values\Content\LanguageCreateStruct $languageCreateStruct ) : eZ\Publish\API\Repository\Values\Content\Language	Creates the a new Language in the content repository.
deleteLanguage ( eZ\Publish\API\Repository\Values\Content\Language $language )	Deletes a language from content repository.
disableLanguage ( eZ\Publish\API\Repository\Values\Content\Language $language ) : eZ\Publish\API\Repository\Values\Content\Language	Disables a language.
enableLanguage ( eZ\Publish\API\Repository\Values\Content\Language $language ) : eZ\Publish\API\Repository\Values\Content\Language	Enables a language.
getDefaultLanguageCode ( ) : string	Returns a configured default language code.
getPrioritizedLanguageCodeList ( ) : string[]	Returns a configured list of prioritized languageCodes.
loadLanguage ( string $languageCode ) : eZ\Publish\API\Repository\Values\Content\Language	Loads a Language from its language code ($languageCode).
loadLanguageById ( mixed $languageId ) : eZ\Publish\API\Repository\Values\Content\Language	Loads a Language by its id ($languageId).
loadLanguages ( ) : eZ\Publish\API\Repository\Values\Content\Language[]	Loads all Languages.
newLanguageCreateStruct ( ) : eZ\Publish\API\Repository\Values\Content\LanguageCreateStruct	Instantiates an object to be used for creating languages.
updateLanguageName ( eZ\Publish\API\Repository\Values\Content\Language $language, string $newName ) : eZ\Publish\API\Repository\Values\Content\Language	Changes the name of the language in the content repository.

Protected Methods

Method	Description
buildDomainObject ( eZ\Publish\SPI\Persistence\Content\Language $spiLanguage ) : eZ\Publish\API\Repository\Values\Content\Language	Builds Language domain object from ValueObject returned by Persistence API.

Method Details

__construct() public method

Setups service with reference to repository object that created it & corresponding handler.

public __construct ( eZ\Publish\API\Repository\Repository $repository, eZ\Publish\SPI\Persistence\Content\Language\Handler $languageHandler, array $settings = [] )
$repository	eZ\Publish\API\Repository\Repository
$languageHandler	eZ\Publish\SPI\Persistence\Content\Language\Handler
$settings	array

buildDomainObject() protected method

Builds Language domain object from ValueObject returned by Persistence API.

protected buildDomainObject ( eZ\Publish\SPI\Persistence\Content\Language $spiLanguage ) : eZ\Publish\API\Repository\Values\Content\Language
$spiLanguage	eZ\Publish\SPI\Persistence\Content\Language
return	eZ\Publish\API\Repository\Values\Content\Language

createLanguage() public method

Creates the a new Language in the content repository.

public createLanguage ( eZ\Publish\API\Repository\Values\Content\LanguageCreateStruct $languageCreateStruct ) : eZ\Publish\API\Repository\Values\Content\Language
$languageCreateStruct	eZ\Publish\API\Repository\Values\Content\LanguageCreateStruct
return	eZ\Publish\API\Repository\Values\Content\Language

deleteLanguage() public method

Deletes a language from content repository.

public deleteLanguage ( eZ\Publish\API\Repository\Values\Content\Language $language )
$language	eZ\Publish\API\Repository\Values\Content\Language

disableLanguage() public method

Disables a language.

public disableLanguage ( eZ\Publish\API\Repository\Values\Content\Language $language ) : eZ\Publish\API\Repository\Values\Content\Language
$language	eZ\Publish\API\Repository\Values\Content\Language
return	eZ\Publish\API\Repository\Values\Content\Language

enableLanguage() public method

Enables a language.

public enableLanguage ( eZ\Publish\API\Repository\Values\Content\Language $language ) : eZ\Publish\API\Repository\Values\Content\Language
$language	eZ\Publish\API\Repository\Values\Content\Language
return	eZ\Publish\API\Repository\Values\Content\Language

getDefaultLanguageCode() public method

Returns a configured default language code.

public getDefaultLanguageCode ( ) : string
return	string

getPrioritizedLanguageCodeList() public method

Returns a configured list of prioritized languageCodes.

public getPrioritizedLanguageCodeList ( ) : string[]
return	string[]

loadLanguage() public method

Loads a Language from its language code ($languageCode).

public loadLanguage ( string $languageCode ) : eZ\Publish\API\Repository\Values\Content\Language
$languageCode	string
return	eZ\Publish\API\Repository\Values\Content\Language

loadLanguageById() public method

Loads a Language by its id ($languageId).

public loadLanguageById ( mixed $languageId ) : eZ\Publish\API\Repository\Values\Content\Language
$languageId	mixed
return	eZ\Publish\API\Repository\Values\Content\Language

loadLanguages() public method

Loads all Languages.

public loadLanguages ( ) : eZ\Publish\API\Repository\Values\Content\Language[]
return	eZ\Publish\API\Repository\Values\Content\Language[]

newLanguageCreateStruct() public method

Instantiates an object to be used for creating languages.

public newLanguageCreateStruct ( ) : eZ\Publish\API\Repository\Values\Content\LanguageCreateStruct
return	eZ\Publish\API\Repository\Values\Content\LanguageCreateStruct

updateLanguageName() public method

Changes the name of the language in the content repository.

public updateLanguageName ( eZ\Publish\API\Repository\Values\Content\Language $language, string $newName ) : eZ\Publish\API\Repository\Values\Content\Language
$language	eZ\Publish\API\Repository\Values\Content\Language
$newName	string
return	eZ\Publish\API\Repository\Values\Content\Language

Property Details

$languageHandler protected property

protected Handler,eZ\Publish\SPI\Persistence\Content\Language $languageHandler
return	eZ\Publish\SPI\Persistence\Content\Language\Handler

$repository protected property

protected Repository,eZ\Publish\API\Repository $repository
return	eZ\Publish\API\Repository\Repository

$settings protected property

protected array $settings
return	array