LanguageNegotiation.php

Same filename in this branch
  1. 10 core/modules/language/src/Annotation/LanguageNegotiation.php
  2. 10 core/modules/language/src/Plugin/migrate/process/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. 11.x core/modules/language/src/Attribute/LanguageNegotiation.php
  6. 11.x core/modules/language/src/Annotation/LanguageNegotiation.php
  7. 11.x core/modules/language/src/Plugin/migrate/process/LanguageNegotiation.php

Namespace

Drupal\language\Attribute

File

core/modules/language/src/Attribute/LanguageNegotiation.php

View source
<?php

namespace Drupal\language\Attribute;

use Drupal\Component\Plugin\Attribute\Plugin;
use Drupal\Core\StringTranslation\TranslatableMarkup;

/**
 * Defines a language negotiation attribute object.
 *
 * Plugin Namespace: Plugin\LanguageNegotiation
 *
 * For a working example, see
 * \Drupal\language\Plugin\LanguageNegotiation\LanguageNegotiationBrowser.
 *
 * @see \Drupal\language\LanguageNegotiator
 * @see \Drupal\language\LanguageNegotiationMethodManager
 * @see \Drupal\language\LanguageNegotiationMethodInterface
 * @see hook_language_negotiation_info_alter()
 * @see plugin_api
 */
class LanguageNegotiation extends Plugin {
    
    /**
     * Constructs an LanguageNegotiation attribute.
     *
     * @param string $id
     *   The language negotiation plugin ID.
     * @param \Drupal\Core\StringTranslation\TranslatableMarkup $name
     *   The human-readable name of the language negotiation plugin.
     * @param string[]|null $types
     *   An array of language types, such as the
     *    \Drupal\Core\Language\LanguageInterface::TYPE_* constants.
     *   If a language negotiation plugin does not specify which language types it
     *   should be used with, it will be available for all the configurable
     *   language types.
     * @param int $weight
     *   The default weight of the language negotiation plugin.
     * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $description
     *   The description of the language negotiation plugin.
     * @param string|null $config_route_name
     *   (optional) The route pointing to the plugin's configuration page.
     */
    public function __construct(string $id, TranslatableMarkup $name, ?array $types = NULL, int $weight = 0, ?TranslatableMarkup $description = NULL, ?string $config_route_name = NULL) {
    }

}

Classes

Title Deprecated Summary
LanguageNegotiation Defines a language negotiation attribute object.

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