class StringListField in Drupal 10

Argument handler for list field to show the human readable name in summary.

Plugin annotation

@ViewsArgument("string_list_field");

Hierarchy

• class \Drupal\options\Plugin\views\argument\StringListField extends \Drupal\views\Plugin\views\argument\StringArgument uses FieldAPIHandlerTrait

File

core/modules/options/src/Plugin/views/argument/StringListField.php, line 19

Namespace

Drupal\options\Plugin\views\argument

class StringListField extends StringArgument {
  use FieldAPIHandlerTrait;

  /**
   * Stores the allowed values of this field.
   *
   * @var array
   */
  protected $allowedValues = NULL;

  /**
   * {@inheritdoc}
   */
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
    parent::init($view, $display, $options);
    $field_storage = $this
      ->getFieldStorageDefinition();
    $this->allowedValues = options_allowed_values($field_storage);
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['summary']['contains']['human'] = [
      'default' => FALSE,
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['summary']['human'] = [
      '#title' => $this
        ->t('Display list value as human readable'),
      '#type' => 'checkbox',
      '#default_value' => $this->options['summary']['human'],
      '#states' => [
        'visible' => [
          ':input[name="options[default_action]"]' => [
            'value' => 'summary',
          ],
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function summaryName($data) {
    $value = $data->{$this->name_alias};

    // If the list element has a human readable name show it.
    if (isset($this->allowedValues[$value]) && !empty($this->options['summary']['human'])) {
      $value = $this->allowedValues[$value];
    }
    return FieldFilteredMarkup::create($this
      ->caseTransform($value, $this->options['case']));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FieldAPIHandlerTrait::$entityFieldManager	protected	property	The entity field manager.
FieldAPIHandlerTrait::$fieldDefinition	protected	property	The field definition.
FieldAPIHandlerTrait::$fieldStorageDefinition	protected	property	The field storage definition.
FieldAPIHandlerTrait::getEntityFieldManager	protected	function	Returns the entity field manager.
FieldAPIHandlerTrait::getFieldDefinition	protected	function	Gets the field definition.
FieldAPIHandlerTrait::getFieldStorageDefinition	protected	function	Gets the field storage configuration.
StringListField::$allowedValues	protected	property	Stores the allowed values of this field.
StringListField::buildOptionsForm	public	function
StringListField::defineOptions	protected	function
StringListField::init	public	function
StringListField::summaryName	public	function