FilterFormat.php

Namespace

Drupal\filter\Plugin\DataType

File

core/modules/filter/src/Plugin/DataType/FilterFormat.php

View source
<?php

namespace Drupal\filter\Plugin\DataType;

use Drupal\Core\Session\AccountInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\Core\TypedData\Attribute\DataType;
use Drupal\Core\TypedData\OptionsProviderInterface;
use Drupal\Core\TypedData\Plugin\DataType\StringData;

/**
 * The filter format data type.
 */
class FilterFormat extends StringData implements OptionsProviderInterface {
  
  /**
   * {@inheritdoc}
   */
  public function getPossibleValues(?AccountInterface $account = NULL) {
    return array_keys($this->getPossibleOptions($account));
  }
  
  /**
   * {@inheritdoc}
   */
  public function getPossibleOptions(?AccountInterface $account = NULL) {
    return array_map(function ($format) {
      return $format->label();
    }, filter_formats());
  }
  
  /**
   * {@inheritdoc}
   */
  public function getSettableValues(?AccountInterface $account = NULL) {
    return array_keys($this->getSettableOptions($account));
  }
  
  /**
   * {@inheritdoc}
   */
  public function getSettableOptions(?AccountInterface $account = NULL) {
    // @todo Avoid calling functions but move to injected dependencies.
    return array_map(function ($format) {
      return $format->label();
    }, filter_formats($account));
  }

}

Classes

Title Deprecated Summary
FilterFormat The filter format data type.

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