class LanguageNegotiation

Same name in this branch
  1. 11.x core/modules/language/src/Attribute/LanguageNegotiation.php \Drupal\language\Attribute\LanguageNegotiation
  2. 11.x core/modules/language/src/Annotation/LanguageNegotiation.php \Drupal\language\Annotation\LanguageNegotiation
Same name in other branches
  1. 9 core/modules/language/src/Annotation/LanguageNegotiation.php \Drupal\language\Annotation\LanguageNegotiation
  2. 9 core/modules/language/src/Plugin/migrate/process/LanguageNegotiation.php \Drupal\language\Plugin\migrate\process\LanguageNegotiation
  3. 8.9.x core/modules/language/src/Annotation/LanguageNegotiation.php \Drupal\language\Annotation\LanguageNegotiation
  4. 8.9.x core/modules/language/src/Plugin/migrate/process/LanguageNegotiation.php \Drupal\language\Plugin\migrate\process\LanguageNegotiation
  5. 10 core/modules/language/src/Attribute/LanguageNegotiation.php \Drupal\language\Attribute\LanguageNegotiation
  6. 10 core/modules/language/src/Annotation/LanguageNegotiation.php \Drupal\language\Annotation\LanguageNegotiation
  7. 10 core/modules/language/src/Plugin/migrate/process/LanguageNegotiation.php \Drupal\language\Plugin\migrate\process\LanguageNegotiation

Processes the arrays for the language types' negotiation methods and weights.

Hierarchy

Expanded class hierarchy of LanguageNegotiation

1 file declares its use of LanguageNegotiation
LanguageNegotiationTest.php in core/modules/language/tests/src/Unit/process/LanguageNegotiationTest.php

File

core/modules/language/src/Plugin/migrate/process/LanguageNegotiation.php, line 14

Namespace

Drupal\language\Plugin\migrate\process
View source
class LanguageNegotiation extends ProcessPluginBase {
    
    /**
     * {@inheritdoc}
     */
    public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
        $new_value = [
            'enabled' => [],
            'method_weights' => [],
        ];
        if (!is_array($value)) {
            throw new MigrateException('The input should be an array');
        }
        // If no weights are provided, use the keys by flipping the array.
        if (empty($value[1])) {
            $new_value['enabled'] = array_flip(array_map([
                $this,
                'mapNewMethods',
            ], array_keys($value[0])));
            unset($new_value['method_weights']);
        }
        else {
            foreach ($value[1] as $method => $weight) {
                $new_method = $this->mapNewMethods($method);
                $new_value['method_weights'][$new_method] = $weight;
                if (in_array($method, array_keys($value[0]))) {
                    $new_value['enabled'][$new_method] = $weight;
                }
            }
        }
        return $new_value;
    }
    
    /**
     * Maps old negotiation method names to the new ones.
     *
     * @param string $value
     *   The old negotiation method name.
     *
     * @return string
     *   The new negotiation method name.
     */
    protected function mapNewMethods($value) {
        switch ($value) {
            case 'language-default':
                return 'language-selected';
            case 'locale-browser':
                return 'language-browser';
            case 'locale-interface':
                return 'language-interface';
            case 'locale-session':
                return 'language-session';
            case 'locale-url':
                return 'language-url';
            case 'locale-url-fallback':
                return 'language-url-fallback';
            case 'locale-user':
                return 'language-user';
            default:
                return $value;
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
LanguageNegotiation::mapNewMethods protected function Maps old negotiation method names to the new ones.
LanguageNegotiation::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
ProcessPluginBase::$stopPipeline protected property Determines if processing of the pipeline is stopped.
ProcessPluginBase::isPipelineStopped public function Determines if the pipeline should stop processing. Overrides MigrateProcessInterface::isPipelineStopped
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
ProcessPluginBase::reset public function Resets the internal data of a plugin. Overrides MigrateProcessInterface::reset
ProcessPluginBase::stopPipeline protected function Stops pipeline processing after this plugin finishes.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.