1. interface
  2. Drupal
  3. \
  4. language
  5. \
  6. ConfigurableLanguageManagerInterface

ConfigurableLanguageManagerInterface

interface ConfigurableLanguageManagerInterface implements LanguageManagerInterface (View source)

Common interface for language negotiation services.

Methods

bool
isMultilingual()

Returns whether or not the site has more than one language added.

from  LanguageManagerInterface
array
getLanguageTypes()

Returns an array of the available language types.

from  LanguageManagerInterface
array
getDefinedLanguageTypesInfo()

Returns information about all defined language types.

from  LanguageManagerInterface
LanguageInterface
getCurrentLanguage(string $type = LanguageInterface::TYPE_INTERFACE)

Returns the current language for the given type.

from  LanguageManagerInterface
$this
reset(string|null $type = NULL)

Resets the given language type or all types if none specified.

from  LanguageManagerInterface
LanguageInterface
getDefaultLanguage()

Returns a language object representing the site's default language.

from  LanguageManagerInterface
LanguageInterface[]
getLanguages(int $flags = LanguageInterface::STATE_CONFIGURABLE)

Returns a list of languages set up on the site.

from  LanguageManagerInterface
LanguageInterface[]
getNativeLanguages()

Returns a list of languages set up on the site in their native form.

from  LanguageManagerInterface
LanguageInterface|null
getLanguage(string $langcode)

Returns a language object from the given language code.

from  LanguageManagerInterface
string
getLanguageName(string $langcode)

Produced the printed name for a language for display.

from  LanguageManagerInterface
LanguageInterface[]
getDefaultLockedLanguages(int $weight = 0)

Returns a list of the default locked languages.

from  LanguageManagerInterface
bool
isLanguageLocked(string $langcode)

Checks whether a language is locked.

from  LanguageManagerInterface
array
getFallbackCandidates(array $context = [])

Returns the language fallback candidates for a given context.

from  LanguageManagerInterface
array
getLanguageSwitchLinks(string $type, Url $url)

Returns the language switch links for the given language type.

from  LanguageManagerInterface
$this
setConfigOverrideLanguage(LanguageInterface $language = NULL)

Sets the configuration override language.

from  LanguageManagerInterface
LanguageInterface
getConfigOverrideLanguage()

Gets the current configuration override language.

from  LanguageManagerInterface
static array
getStandardLanguageList()

Some common languages with their English and native names.

from  LanguageManagerInterface
static 
rebuildServices()

Rebuild the container to register services needed on multilingual sites.

LanguageNegotiatorInterface
getNegotiator()

Returns the language negotiator.

setNegotiator(LanguageNegotiatorInterface $negotiator)

Injects the language negotiator.

array
getDefinedLanguageTypes()

Returns all the defined language types including fixed ones.

saveLanguageTypesConfiguration(array $config)

Stores language types configuration.

updateLockedLanguageWeights()

Updates locked system language weights.

LanguageConfigOverride
getLanguageConfigOverride(string $langcode, string $name)

Gets a language config override object.

StorageInterface
getLanguageConfigOverrideStorage(string $langcode)

Gets a language configuration override storage object.

array
getStandardLanguageListWithoutConfigured()

Returns the standard language list excluding already configured languages.

string|null
getNegotiatedLanguageMethod(string $type = LanguageInterface::TYPE_INTERFACE)

Gets the negotiated language method ID.

Details

in LanguageManagerInterface at line 18
bool isMultilingual()

Returns whether or not the site has more than one language added.

Return Value

bool

TRUE if more than one language is added, FALSE otherwise.

in LanguageManagerInterface at line 26
array getLanguageTypes()

Returns an array of the available language types.

Return Value

array

An array of language type machine names.

in LanguageManagerInterface at line 38
array getDefinedLanguageTypesInfo()

Returns information about all defined language types.

Return Value

array

An associative array of language type information arrays keyed by language type machine name, in the format of hook_language_types_info(). In some implementing classes, this is based on information from hook_language_types_info() and hook_language_types_info_alter().

in LanguageManagerInterface at line 51
LanguageInterface getCurrentLanguage(string $type = LanguageInterface::TYPE_INTERFACE)

Returns the current language for the given type.

Parameters

string $type

(optional) The language type; e.g., the interface or the content language. Defaults to \Drupal\Core\Language\LanguageInterface::TYPE_INTERFACE.

Return Value

LanguageInterface

The current language object for the given type of language.

in LanguageManagerInterface at line 64
$this reset(string|null $type = NULL)

Resets the given language type or all types if none specified.

Parameters

string|null $type

(optional) The language type to reset as a string, e.g., LanguageInterface::TYPE_INTERFACE, or NULL to reset all language types. Defaults to NULL.

Return Value

$this

The language manager that has been reset.

in LanguageManagerInterface at line 72
LanguageInterface getDefaultLanguage()

Returns a language object representing the site's default language.

Return Value

LanguageInterface

A language object.

in LanguageManagerInterface at line 85
LanguageInterface[] getLanguages(int $flags = LanguageInterface::STATE_CONFIGURABLE)

Returns a list of languages set up on the site.

Parameters

int $flags

(optional) Specifies the state of the languages that have to be returned. It can be: LanguageInterface::STATE_CONFIGURABLE, LanguageInterface::STATE_LOCKED, or LanguageInterface::STATE_ALL.

Return Value

LanguageInterface[]

An associative array of languages, keyed by the language code.

in LanguageManagerInterface at line 94
LanguageInterface[] getNativeLanguages()

Returns a list of languages set up on the site in their native form.

Return Value

LanguageInterface[]

An associative array of languages, keyed by the language code, ordered by weight ascending and name ascending.

in LanguageManagerInterface at line 105
LanguageInterface|null getLanguage(string $langcode)

Returns a language object from the given language code.

Parameters

string $langcode

The language code.

Return Value

LanguageInterface|null

A fully-populated language object or NULL.

in LanguageManagerInterface at line 116
string getLanguageName(string $langcode)

Produced the printed name for a language for display.

Parameters

string $langcode

The language code.

Return Value

string

The printed name of the language.

in LanguageManagerInterface at line 128
LanguageInterface[] getDefaultLockedLanguages(int $weight = 0)

Returns a list of the default locked languages.

Parameters

int $weight

(optional) An integer value that is used as the start value for the weights of the locked languages.

Return Value

LanguageInterface[]

An array of language objects.

in LanguageManagerInterface at line 139
bool isLanguageLocked(string $langcode)

Checks whether a language is locked.

Parameters

string $langcode

The language code.

Return Value

bool

Returns whether the language is locked.

in LanguageManagerInterface at line 164
array getFallbackCandidates(array $context = [])

Returns the language fallback candidates for a given context.

Parameters

array $context

(optional) An associative array of data that can be useful to determine the fallback sequence. The following keys are used in core:

  • langcode: Language code of the desired language.
  • operation: The name of the operation indicating the context where language fallback is being applied. The following operations are defined in core, but more may be defined in contributed modules:
    • entity_view: Invoked when an entity is about to be displayed. The data key contains the loaded entity.
    • views_query: Invoked when a field based views query is performed. The data key contains a reference to the field object.
    • locale_lookup: Invoked when a string translation was not found. The data key contains the source string.
  • data: A data structure that makes sense in the provided context, see above.

Return Value

array

An array of language codes sorted by priority: first values should be tried first.

Returns the language switch links for the given language type.

Parameters

string $type

The language type.
Url $url

The URL the switch links will be relative to.

Return Value

array

A keyed array of links ready to be themed.

in LanguageManagerInterface at line 187
$this setConfigOverrideLanguage(LanguageInterface $language = NULL)

Sets the configuration override language.

Parameters

LanguageInterface $language

The language to override configuration with.

Return Value

$this

in LanguageManagerInterface at line 195
LanguageInterface getConfigOverrideLanguage()

Gets the current configuration override language.

Return Value

LanguageInterface

The current configuration override language.

in LanguageManagerInterface at line 210
static array getStandardLanguageList()

Some common languages with their English and native names.

Language codes are defined by the W3C language tags document for interoperability. Language codes typically have a language and, optionally, a script or regional variant name. See: http://www.w3.org/International/articles/language-tags/ for more information.

Return Value

array

An array of language code to language name information. Language name information itself is an array of English and native names.

at line 16
static rebuildServices()

Rebuild the container to register services needed on multilingual sites.

at line 24
LanguageNegotiatorInterface getNegotiator()

Returns the language negotiator.

Return Value

LanguageNegotiatorInterface

The language negotiator.

at line 32
setNegotiator(LanguageNegotiatorInterface $negotiator)

Injects the language negotiator.

Parameters

LanguageNegotiatorInterface $negotiator

The language negotiator.

at line 44
array getDefinedLanguageTypes()

Returns all the defined language types including fixed ones.

A language type maybe configurable or fixed. A fixed language type is a type whose language negotiation methods are module-defined and not altered through the user interface.

Return Value

array

An array of language type machine names.

at line 54
saveLanguageTypesConfiguration(array $config)

Stores language types configuration.

Parameters

array $config

An indexed array with the following keys_

  • configurable: an array of configurable language type names.
  • all: an array of all the defined language type names.

at line 59
updateLockedLanguageWeights()

Updates locked system language weights.

at line 72
LanguageConfigOverride getLanguageConfigOverride(string $langcode, string $name)

Gets a language config override object.

Parameters

string $langcode

The language code for the override.
string $name

The language configuration object name.

Return Value

LanguageConfigOverride

The language config override object.

at line 84
StorageInterface getLanguageConfigOverrideStorage(string $langcode)

Gets a language configuration override storage object.

Parameters

string $langcode

The language code for the override.

Return Value

StorageInterface

A storage object to use for reading and writing the configuration override.

at line 92
array getStandardLanguageListWithoutConfigured()

Returns the standard language list excluding already configured languages.

Return Value

array

A list of standard language names keyed by langcode.

at line 104
string|null getNegotiatedLanguageMethod(string $type = LanguageInterface::TYPE_INTERFACE)

Gets the negotiated language method ID.

Parameters

string $type

(optional) The language type; e.g., the interface or the content language.

Return Value

string|null

The negotiated language method ID.