Chris@0: <?php
Chris@0: 
Chris@0: /**
Chris@0:  * @file
Chris@0:  * Hooks provided by the Language module.
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * @addtogroup hooks
Chris@0:  * @{
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * Define language types.
Chris@0:  *
Chris@0:  * @return array
Chris@0:  *   An associative array of language type definitions. The keys are the
Chris@0:  *   identifiers, which are also used as names for global variables representing
Chris@0:  *   the types in the bootstrap phase. The values are associative arrays that
Chris@0:  *   may contain the following elements:
Chris@0:  *   - name: The human-readable language type identifier.
Chris@0:  *   - description: A description of the language type.
Chris@0:  *   - locked: A boolean indicating if the user can choose whether to configure
Chris@0:  *     the language type or not using the UI.
Chris@0:  *   - fixed: A fixed array of language negotiation method identifiers to use to
Chris@0:  *     initialize this language. If locked is set to TRUE and fixed is set, it
Chris@0:  *     will always use the specified methods in the given priority order. If not
Chris@0:  *     present and locked is TRUE then language-interface will be
Chris@0:  *     used.
Chris@0:  *
Chris@0:  *  @todo Rename the 'fixed' key to something more meaningful, for instance
Chris@0:  *     'negotiation settings'. See https://www.drupal.org/node/2166879.
Chris@0:  *
Chris@0:  * @see hook_language_types_info_alter()
Chris@0:  * @ingroup language_negotiation
Chris@0:  */
Chris@0: function hook_language_types_info() {
Chris@0:   return [
Chris@0:     'custom_language_type' => [
Chris@0:       'name' => t('Custom language'),
Chris@0:       'description' => t('A custom language type.'),
Chris@0:       'locked' => FALSE,
Chris@0:     ],
Chris@0:     'fixed_custom_language_type' => [
Chris@0:       'locked' => TRUE,
Chris@0:       'fixed' => ['custom_language_negotiation_method'],
Chris@0:     ],
Chris@0:   ];
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Perform alterations on language types.
Chris@0:  *
Chris@0:  * @param array $language_types
Chris@0:  *   Array of language type definitions.
Chris@0:  *
Chris@0:  * @see hook_language_types_info()
Chris@0:  * @ingroup language_negotiation
Chris@0:  */
Chris@0: function hook_language_types_info_alter(array &$language_types) {
Chris@0:   if (isset($language_types['custom_language_type'])) {
Chris@0:     $language_types['custom_language_type_custom']['description'] = t('A far better description.');
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Perform alterations on language negotiation methods.
Chris@0:  *
Chris@0:  * @param array $negotiation_info
Chris@0:  *   Array of language negotiation method definitions.
Chris@0:  *
Chris@0:  * @ingroup language_negotiation
Chris@0:  */
Chris@0: function hook_language_negotiation_info_alter(array &$negotiation_info) {
Chris@0:   if (isset($negotiation_info['custom_language_method'])) {
Chris@0:     $negotiation_info['custom_language_method']['config'] = 'admin/config/regional/language/detection/custom-language-method';
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Allow modules to alter the language fallback candidates.
Chris@0:  *
Chris@0:  * @param array $candidates
Chris@0:  *   An array of language codes whose order will determine the language fallback
Chris@0:  *   order.
Chris@0:  * @param array $context
Chris@0:  *   A language fallback context.
Chris@0:  *
Chris@0:  * @see \Drupal\Core\Language\LanguageManagerInterface::getFallbackCandidates()
Chris@0:  */
Chris@0: function hook_language_fallback_candidates_alter(array &$candidates, array $context) {
Chris@0:   $candidates = array_reverse($candidates);
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Allow modules to alter the fallback candidates for specific operations.
Chris@0:  *
Chris@0:  * @param array $candidates
Chris@0:  *   An array of language codes whose order will determine the language fallback
Chris@0:  *   order.
Chris@0:  * @param array $context
Chris@0:  *   A language fallback context.
Chris@0:  *
Chris@0:  * @see \Drupal\Core\Language\LanguageManagerInterface::getFallbackCandidates()
Chris@0:  */
Chris@0: function hook_language_fallback_candidates_OPERATION_alter(array &$candidates, array $context) {
Chris@0:   // We know that the current OPERATION deals with entities so no need to check
Chris@0:   // here.
Chris@0:   if ($context['data']->getEntityTypeId() == 'node') {
Chris@0:     $candidates = array_reverse($candidates);
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * @} End of "addtogroup hooks".
Chris@0:  */