PHP Class eZ\Publish\Core\REST\Client\LanguageService

See also: eZ\Publish\API\Repository\LanguageService

Inheritance: implements eZ\Publish\API\Repository\LanguageService, implements eZ\Publish\Core\REST\Client\Sessionable

Show file Open project: ezsystems/ezpublish-kernel

Public Methods

Method	Description
__construct ( ContentService $contentService, $defaultLanguageCode, eZ\Publish\Core\REST\Client\HttpClient $client, Dispatcher $inputDispatcher, Visitor $outputVisitor, eZ\Publish\Core\REST\Common\RequestParser $requestParser )
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 )	Disables a language.
enableLanguage ( eZ\Publish\API\Repository\Values\Content\Language $language )	Enables a language.
getDefaultLanguageCode ( ) : string	Returns a configured default language code.
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.
setSession ( $id )	Set session ID.
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.

Method Details

__construct() public method

public __construct ( ContentService $contentService, $defaultLanguageCode, eZ\Publish\Core\REST\Client\HttpClient $client, Dispatcher $inputDispatcher, Visitor $outputVisitor, eZ\Publish\Core\REST\Common\RequestParser $requestParser )
$contentService	ContentService
$client	eZ\Publish\Core\REST\Client\HttpClient
$inputDispatcher	eZ\Publish\Core\REST\Common\Input\Dispatcher
$outputVisitor	eZ\Publish\Core\REST\Common\Output\Visitor
$requestParser	eZ\Publish\Core\REST\Common\RequestParser

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 )
$language	eZ\Publish\API\Repository\Values\Content\Language

enableLanguage() public method

Enables a language.

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

getDefaultLanguageCode() public method

Returns a configured default language code.

public getDefaultLanguageCode ( ) : 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

setSession() public method

Only for testing

public setSession ( $id )

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