PageLanguageInformation
final readonly class \
Data Transfer Object representing language availability information for a specific page.
Contains both existing translations and potential new translations.
This provides a single source of truth for:
- Which languages are configured and available
- Which languages have translations on this page
- Which languages can be created (permissions)
- Translation records with workspace overlay applied
- UI-ready language items for display
Internal
Table of Contents
Properties
- $availableLanguages : array
- $canUserCreateTranslations : bool
- $creatableLanguageIds : array
- $existingTranslations : array
- $languageItems : array
- $languageStatuses : array
- $pageId : int
Methods
- __construct() : mixed
- canCreateTranslation() : bool
- Check if a translation can be created for a specific language.
- getAllExistingLanguageIds() : int[]
- Get all language IDs including default (0) and all translations.
- getLanguageStatus() : LanguageStatus
- Get the status of a specific language.
- getTranslationRecord() : array|null
- Get the translation record for a specific language.
- hasTranslation() : bool
- Check if a translation exists for a specific language.
Properties
$availableLanguages
public
array
$availableLanguages
$canUserCreateTranslations
public
bool
$canUserCreateTranslations
$creatableLanguageIds
public
array
$creatableLanguageIds
$existingTranslations
public
array
$existingTranslations
$languageItems
public
array
$languageItems
$languageStatuses
public
array
$languageStatuses
$pageId
public
int
$pageId
Methods
__construct()
public
__construct(int $pageId, SiteLanguage[] $availableLanguages, array<int, LanguageStatus> $languageStatuses, array<int, array> $existingTranslations, int[] $creatableLanguageIds, bool $canUserCreateTranslations, LanguageItem[] $languageItems) : mixed
Parameters
- $pageId : int
-
Page ID this information belongs to
- $availableLanguages : SiteLanguage[]
-
All available languages
- $languageStatuses : array<int, LanguageStatus>
-
Status for each language (existing/creatable/unavailable)
- $existingTranslations : array<int, array>
-
Raw page translation records, keyed by language ID
- $creatableLanguageIds : int[]
-
IDs of languages that can be created
- $canUserCreateTranslations : bool
-
Whether user has permission to create translations
- $languageItems : LanguageItem[]
-
UI-ready language items
canCreateTranslation()
Check if a translation can be created for a specific language.
public
canCreateTranslation(int $languageId) : bool
Parameters
- $languageId : int
Return values
boolgetAllExistingLanguageIds()
Get all language IDs including default (0) and all translations.
public
getAllExistingLanguageIds() : int[]
Return values
int[]getLanguageStatus()
Get the status of a specific language.
public
getLanguageStatus(int $languageId) : LanguageStatus
Parameters
- $languageId : int
Return values
LanguageStatusgetTranslationRecord()
Get the translation record for a specific language.
public
getTranslationRecord(int $languageId) : array|null
Parameters
- $languageId : int
Return values
array|null —Translation record or null if not found
hasTranslation()
Check if a translation exists for a specific language.
public
hasTranslation(int $languageId) : bool
Parameters
- $languageId : int