LanguageNegotiation.php

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

Namespace

Drupal\language\Plugin\migrate\process

File

core/modules/language/src/Plugin/migrate/process/LanguageNegotiation.php

View source
<?php

namespace Drupal\language\Plugin\migrate\process;

use Drupal\migrate\Attribute\MigrateProcess;
use Drupal\migrate\MigrateException;
use Drupal\migrate\MigrateExecutableInterface;
use Drupal\migrate\ProcessPluginBase;
use Drupal\migrate\Row;

/**
 * Processes the arrays for the language types' negotiation methods and weights.
 */
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;
        }
    }

}

Classes

Title Deprecated Summary
LanguageNegotiation Processes the arrays for the language types' negotiation methods and weights.

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