class FilterFormat in Zircon Profile 8.0
Same name in this branch
- 8.0 core/modules/filter/src/Entity/FilterFormat.php \Drupal\filter\Entity\FilterFormat
- 8.0 core/modules/filter/src/Plugin/DataType/FilterFormat.php \Drupal\filter\Plugin\DataType\FilterFormat
- 8.0 core/modules/filter/src/Plugin/migrate/source/d6/FilterFormat.php \Drupal\filter\Plugin\migrate\source\d6\FilterFormat
- 8.0 core/modules/filter/src/Plugin/migrate/source/d7/FilterFormat.php \Drupal\filter\Plugin\migrate\source\d7\FilterFormat
Same name and namespace in other branches
- 8 core/modules/filter/src/Plugin/DataType/FilterFormat.php \Drupal\filter\Plugin\DataType\FilterFormat
The filter format data type.
Plugin annotation
@DataType(
id = "filter_format",
label = @Translation("Filter format")
)
Hierarchy
- class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\TypedData\PrimitiveBase implements PrimitiveInterface
- class \Drupal\Core\TypedData\Plugin\DataType\StringData implements StringInterface
- class \Drupal\filter\Plugin\DataType\FilterFormat implements OptionsProviderInterface
- class \Drupal\Core\TypedData\Plugin\DataType\StringData implements StringInterface
- class \Drupal\Core\TypedData\PrimitiveBase implements PrimitiveInterface
Expanded class hierarchy of FilterFormat
1 file declares its use of FilterFormat
- FilterAPITest.php in core/
modules/ filter/ src/ Tests/ FilterAPITest.php - Contains \Drupal\filter\Tests\FilterAPITest.
File
- core/
modules/ filter/ src/ Plugin/ DataType/ FilterFormat.php, line 22 - Contains \Drupal\filter\Plugin\DataType\FilterFormat.
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 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));
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
FilterFormat:: |
public | function |
Returns an array of possible values with labels for display. Overrides OptionsProviderInterface:: |
|
FilterFormat:: |
public | function |
Returns an array of possible values. Overrides OptionsProviderInterface:: |
|
FilterFormat:: |
public | function |
Returns an array of settable values with labels for display. Overrides OptionsProviderInterface:: |
|
FilterFormat:: |
public | function |
Returns an array of settable values. Overrides OptionsProviderInterface:: |
|
PrimitiveBase:: |
protected | property | The data value. | 1 |
PrimitiveBase:: |
public | function |
Gets the data value. Overrides TypedData:: |
1 |
PrimitiveBase:: |
public | function |
Sets the data value. Overrides TypedData:: |
1 |
StringData:: |
public | function |
Gets the primitive data value casted to the correct PHP type. Overrides PrimitiveInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TypedData:: |
protected | property | The data definition. | 1 |
TypedData:: |
protected | property | The property name. | |
TypedData:: |
protected | property | The parent typed data object. | |
TypedData:: |
public | function |
Applies the default value. Overrides TypedDataInterface:: |
3 |
TypedData:: |
public static | function |
Constructs a TypedData object given its definition and context. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Gets a list of validation constraints. Overrides TypedDataInterface:: |
8 |
TypedData:: |
public | function |
Gets the data definition. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the name of a property or item. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
TypedData:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
TypedData:: |
public | function |
Returns the property path of the data. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the root of the typed data tree. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns a string representation of the data. Overrides TypedDataInterface:: |
6 |
TypedData:: |
public | function |
Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Validates the currently set data value. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function | Constructs a TypedData object given its definition and context. | 3 |
TypedDataTrait:: |
protected | property | The typed data manager used for creating the data types. | |
TypedDataTrait:: |
public | function | Gets the typed data manager. | 1 |
TypedDataTrait:: |
public | function | Sets the typed data manager. | 1 |