class FilterFormat
Same name in this branch
- main core/modules/filter/src/Entity/FilterFormat.php \Drupal\filter\Entity\FilterFormat
- main core/modules/filter/src/Plugin/migrate/source/d6/FilterFormat.php \Drupal\filter\Plugin\migrate\source\d6\FilterFormat
- main core/modules/filter/src/Plugin/migrate/source/d7/FilterFormat.php \Drupal\filter\Plugin\migrate\source\d7\FilterFormat
Same name and namespace in other branches
- 11.x core/modules/filter/src/Entity/FilterFormat.php \Drupal\filter\Entity\FilterFormat
- 11.x core/modules/filter/src/Plugin/DataType/FilterFormat.php \Drupal\filter\Plugin\DataType\FilterFormat
- 11.x core/modules/filter/src/Plugin/migrate/source/d6/FilterFormat.php \Drupal\filter\Plugin\migrate\source\d6\FilterFormat
- 11.x core/modules/filter/src/Plugin/migrate/source/d7/FilterFormat.php \Drupal\filter\Plugin\migrate\source\d7\FilterFormat
- 10 core/modules/filter/src/Entity/FilterFormat.php \Drupal\filter\Entity\FilterFormat
- 10 core/modules/filter/src/Plugin/DataType/FilterFormat.php \Drupal\filter\Plugin\DataType\FilterFormat
- 10 core/modules/filter/src/Plugin/migrate/source/d6/FilterFormat.php \Drupal\filter\Plugin\migrate\source\d6\FilterFormat
- 10 core/modules/filter/src/Plugin/migrate/source/d7/FilterFormat.php \Drupal\filter\Plugin\migrate\source\d7\FilterFormat
- 9 core/modules/filter/src/Entity/FilterFormat.php \Drupal\filter\Entity\FilterFormat
- 9 core/modules/filter/src/Plugin/DataType/FilterFormat.php \Drupal\filter\Plugin\DataType\FilterFormat
- 9 core/modules/filter/src/Plugin/migrate/source/d6/FilterFormat.php \Drupal\filter\Plugin\migrate\source\d6\FilterFormat
- 9 core/modules/filter/src/Plugin/migrate/source/d7/FilterFormat.php \Drupal\filter\Plugin\migrate\source\d7\FilterFormat
- 8.9.x core/modules/filter/src/Entity/FilterFormat.php \Drupal\filter\Entity\FilterFormat
- 8.9.x core/modules/filter/src/Plugin/DataType/FilterFormat.php \Drupal\filter\Plugin\DataType\FilterFormat
- 8.9.x core/modules/filter/src/Plugin/migrate/source/d6/FilterFormat.php \Drupal\filter\Plugin\migrate\source\d6\FilterFormat
- 8.9.x core/modules/filter/src/Plugin/migrate/source/d7/FilterFormat.php \Drupal\filter\Plugin\migrate\source\d7\FilterFormat
The filter format data type.
Attributes
Hierarchy
- class \Drupal\Core\TypedData\TypedData implements \Drupal\Core\TypedData\TypedDataInterface, \Drupal\Component\Plugin\PluginInspectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\TypedData\TypedDataTrait
- class \Drupal\Core\TypedData\PrimitiveBase implements \Drupal\Core\TypedData\PrimitiveInterface extends \Drupal\Core\TypedData\TypedData
- class \Drupal\Core\TypedData\Plugin\DataType\StringData implements \Drupal\Core\TypedData\Type\StringInterface extends \Drupal\Core\TypedData\PrimitiveBase
- class \Drupal\filter\Plugin\DataType\FilterFormat implements \Drupal\Core\TypedData\OptionsProviderInterface extends \Drupal\Core\TypedData\Plugin\DataType\StringData
- class \Drupal\Core\TypedData\Plugin\DataType\StringData implements \Drupal\Core\TypedData\Type\StringInterface extends \Drupal\Core\TypedData\PrimitiveBase
- class \Drupal\Core\TypedData\PrimitiveBase implements \Drupal\Core\TypedData\PrimitiveInterface extends \Drupal\Core\TypedData\TypedData
Expanded class hierarchy of FilterFormat
1 file declares its use of FilterFormat
- FilterAPITest.php in core/
modules/ filter/ tests/ src/ Kernel/ FilterAPITest.php
2 string references to 'FilterFormat'
- CKEditor5::createEphemeralPairedEditor in core/
modules/ ckeditor5/ src/ Plugin/ Editor/ CKEditor5.php - Creates an ephemeral pair of text editor + text format config entity.
- SmartDefaultSettings::computeSmartDefaultSettings in core/
modules/ ckeditor5/ src/ SmartDefaultSettings.php - Computes the closest equivalent settings for switching to CKEditor 5.
File
-
core/
modules/ filter/ src/ Plugin/ DataType/ FilterFormat.php, line 16
Namespace
Drupal\filter\Plugin\DataTypeView source
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 $this->getFormatsAsOptions($account);
}
/**
* {@inheritdoc}
*/
public function getSettableValues(?AccountInterface $account = NULL) {
return array_keys($this->getSettableOptions($account));
}
/**
* {@inheritdoc}
*/
public function getSettableOptions(?AccountInterface $account = NULL) {
return $this->getFormatsAsOptions($account);
}
/**
* Returns a list of filter format config entity labels keyed by their ID.
*
* @param \Drupal\Core\Session\AccountInterface|null $account
* (optional) The user account for which to filter the options. If omitted,
* all options are returned.
*
* @return array<string, \Drupal\filter\FilterFormatInterface>
* A list of filter format config entity labels keyed by their ID.
*/
protected function getFormatsAsOptions(?AccountInterface $account = NULL) : array {
$repository = \Drupal::service(FilterFormatRepositoryInterface::class);
return array_map(fn(FilterFormatInterface $format): string|\Stringable => $format->label(), $account ? $repository->getFormatsForAccount($account) : $repository->getAllFormats());
}
}
Members
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.