CultureHelper
in package
Culture Helper - Provides current user culture for i18n queries.
Replaces hardcoded 'en' culture references throughout the framework.
Table of Contents
Methods
- clearOverride() : void
- Clear override culture.
- getAvailableCultures() : array<string|int, mixed>
- Get all available cultures from AtoM settings.
- getCulture() : string
- Get the current user's culture.
- getQueryCulture() : string
- Get culture for database queries with fallback.
- isValidCulture() : bool
- Check if a culture is valid/available.
- setDefaultCulture() : void
- Set default culture.
- setOverrideCulture() : void
- Set override culture (for API/testing).
Methods
clearOverride()
Clear override culture.
public
static clearOverride() : void
getAvailableCultures()
Get all available cultures from AtoM settings.
public
static getAvailableCultures() : array<string|int, mixed>
Return values
array<string|int, mixed>getCulture()
Get the current user's culture.
public
static getCulture() : string
Priority:
- Override culture (for testing/API)
- sfContext user culture (logged in user)
- sfContext default culture
- Default 'en'
Return values
stringgetQueryCulture()
Get culture for database queries with fallback.
public
static getQueryCulture([string|null $preferred = null ]) : string
Use this in queries to handle culture fallback properly.
Parameters
- $preferred : string|null = null
Return values
stringisValidCulture()
Check if a culture is valid/available.
public
static isValidCulture(string $culture) : bool
Parameters
- $culture : string
Return values
boolsetDefaultCulture()
Set default culture.
public
static setDefaultCulture(string $culture) : void
Parameters
- $culture : string
setOverrideCulture()
Set override culture (for API/testing).
public
static setOverrideCulture(string|null $culture) : void
Parameters
- $culture : string|null