LanguageArgument.php

Same filename and directory in other branches
  1. 9 core/modules/views/src/Plugin/views/argument/LanguageArgument.php
  2. 8.9.x core/modules/views/src/Plugin/views/argument/LanguageArgument.php
  3. 11.x core/modules/views/src/Plugin/views/argument/LanguageArgument.php

Namespace

Drupal\views\Plugin\views\argument

File

core/modules/views/src/Plugin/views/argument/LanguageArgument.php

View source
<?php

namespace Drupal\views\Plugin\views\argument;


/**
 * Defines an argument handler to accept a language.
 *
 * @ingroup views_argument_handlers
 *
 * @ViewsArgument("language")
 */
class LanguageArgument extends ArgumentPluginBase {
    
    /**
     * Overrides \Drupal\views\Plugin\views\argument\ArgumentPluginBase::summaryName().
     *
     * Gets the user-friendly version of the language name.
     */
    public function summaryName($data) {
        return $this->language($data->{$this->name_alias});
    }
    
    /**
     * Overrides \Drupal\views\Plugin\views\argument\ArgumentPluginBase::title().
     *
     * Gets the user friendly version of the language name for display as a
     * title placeholder.
     */
    public function title() {
        return $this->language($this->argument);
    }
    
    /**
     * Returns the language name for a given langcode.
     *
     * @param string $langcode
     *   The language code.
     *
     * @return string
     *   The translated name for the language, or "Unknown language" if the
     *   language was not found.
     */
    public function language($langcode) {
        $languages = $this->listLanguages();
        return $languages[$langcode] ?? $this->t('Unknown language');
    }

}

Classes

Title Deprecated Summary
LanguageArgument Defines an argument handler to accept a language.

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