interface LanguageNegotiationMethodInterface
Same name in other branches
- 9 core/modules/language/src/LanguageNegotiationMethodInterface.php \Drupal\language\LanguageNegotiationMethodInterface
- 8.9.x core/modules/language/src/LanguageNegotiationMethodInterface.php \Drupal\language\LanguageNegotiationMethodInterface
- 11.x core/modules/language/src/LanguageNegotiationMethodInterface.php \Drupal\language\LanguageNegotiationMethodInterface
Interface for language negotiation classes.
Hierarchy
- interface \Drupal\language\LanguageNegotiationMethodInterface
Expanded class hierarchy of LanguageNegotiationMethodInterface
All classes that implement LanguageNegotiationMethodInterface
File
-
core/
modules/ language/ src/ LanguageNegotiationMethodInterface.php, line 13
Namespace
Drupal\languageView source
interface LanguageNegotiationMethodInterface {
/**
* Injects the language manager.
*
* @param \Drupal\language\ConfigurableLanguageManagerInterface $language_manager
* The language manager to be used to retrieve the language list and the
* already negotiated languages.
*/
public function setLanguageManager(ConfigurableLanguageManagerInterface $language_manager);
/**
* Injects the configuration factory.
*
* @param \Drupal\Core\Config\ConfigFactoryInterface $config
* The configuration factory.
*/
public function setConfig(ConfigFactoryInterface $config);
/**
* Injects the current user.
*
* @param \Drupal\Core\Session\AccountInterface $current_user
* The current active user.
*/
public function setCurrentUser(AccountInterface $current_user);
/**
* Performs language negotiation.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* (optional) The current request. Defaults to NULL if it has not been
* initialized yet.
*
* @return string|null|false
* A valid language code if the negotiation was successful and either NULL
* or FALSE otherwise.
*
* @todo Determine whether string|false or string|null should be the
* normalized result across all implementations and update the @return and
* its comment accordingly.
*
* @see https://www.drupal.org/node/3329952
*/
public function getLangcode(?Request $request = NULL);
/**
* Notifies the plugin that the language code it returned has been accepted.
*
* @param \Drupal\Core\Language\LanguageInterface $language
* The accepted language.
*/
public function persist(LanguageInterface $language);
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
LanguageNegotiationMethodInterface::getLangcode | public | function | Performs language negotiation. | 10 |
LanguageNegotiationMethodInterface::persist | public | function | Notifies the plugin that the language code it returned has been accepted. | 1 |
LanguageNegotiationMethodInterface::setConfig | public | function | Injects the configuration factory. | 1 |
LanguageNegotiationMethodInterface::setCurrentUser | public | function | Injects the current user. | 1 |
LanguageNegotiationMethodInterface::setLanguageManager | public | function | Injects the language manager. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.