class LanguageNegotiation

Same name in this branch

11.1.x core/modules/language/src/Annotation/LanguageNegotiation.php \Drupal\language\Annotation\LanguageNegotiation
11.1.x core/modules/language/src/Attribute/LanguageNegotiation.php \Drupal\language\Attribute\LanguageNegotiation

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

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
  - class \Drupal\migrate\ProcessPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate\Plugin\MigrateProcessInterface
    - class \Drupal\language\Plugin\migrate\process\LanguageNegotiation extends \Drupal\migrate\ProcessPluginBase

Expanded class hierarchy of LanguageNegotiation

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.		5
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.