PHP Class eZ\Publish\Core\Persistence\Legacy\Content\Language\MaskGenerator

Show file Open project: ezsystems/ezpublish-kernel Class Usage Examples

Protected Properties

Property Type Description
$languageHandler Handler Language lookup.

Public Methods

Method Description
__construct ( eZ\Publish\SPI\Persistence\Content\Language\Handler $languageHandler ) Creates a new Language MaskGenerator.
extractLanguageCodesFromMask ( integer $languageMask ) : array Extracts Language codes contained in given $languageMask.
extractLanguageIdsFromMask ( integer $languageMask ) : array Extracts every language Ids contained in $languageMask.
generateLanguageIndicator ( string $languageCode, boolean $alwaysAvailable ) : integer Generates a language indicator from $languageCode and $alwaysAvailable.
generateLanguageMask ( array $languages ) : integer Generates a language mask from the keys of $languages.
isAlwaysAvailable ( integer $languageMask ) : boolean Checks if $languageMask contains the alwaysAvailable bit field.
isLanguageAlwaysAvailable ( string $language, array $languages ) : boolean Checks if $language is always available in $languages;.
isLanguageMaskComposite ( integer $languageMask ) : boolean Checks if given $languageMask consists of multiple languages.
removeAlwaysAvailableFlag ( integer $languageId ) : integer Removes the alwaysAvailable flag from $languageId and returns cleaned up $languageId.

Method Details

__construct() public method

Creates a new Language MaskGenerator.
public __construct ( eZ\Publish\SPI\Persistence\Content\Language\Handler $languageHandler )
$languageHandler eZ\Publish\SPI\Persistence\Content\Language\Handler

extractLanguageCodesFromMask() public method

Extracts Language codes contained in given $languageMask.
public extractLanguageCodesFromMask ( integer $languageMask ) : array
$languageMask integer
return array

extractLanguageIdsFromMask() public method

Extracts every language Ids contained in $languageMask.
public extractLanguageIdsFromMask ( integer $languageMask ) : array
$languageMask integer
return array Array of language Id

generateLanguageIndicator() public method

Generates a language indicator from $languageCode and $alwaysAvailable.
public generateLanguageIndicator ( string $languageCode, boolean $alwaysAvailable ) : integer
$languageCode string
$alwaysAvailable boolean
return integer

generateLanguageMask() public method

Generates a language mask from the keys of $languages.
public generateLanguageMask ( array $languages ) : integer
$languages array
return integer

isAlwaysAvailable() public method

Checks if $languageMask contains the alwaysAvailable bit field.
public isAlwaysAvailable ( integer $languageMask ) : boolean
$languageMask integer
return boolean

isLanguageAlwaysAvailable() public method

Checks if $language is always available in $languages;.
public isLanguageAlwaysAvailable ( string $language, array $languages ) : boolean
$language string
$languages array
return boolean

isLanguageMaskComposite() public method

Checks if given $languageMask consists of multiple languages.
public isLanguageMaskComposite ( integer $languageMask ) : boolean
$languageMask integer
return boolean

removeAlwaysAvailableFlag() public method

Removes the alwaysAvailable flag from $languageId and returns cleaned up $languageId.
public removeAlwaysAvailableFlag ( integer $languageId ) : integer
$languageId integer
return integer

Property Details

$languageHandler protected property

Language lookup.
protected Handler,eZ\Publish\Core\Persistence\Legacy\Content\Language $languageHandler
return Handler