function FundamentalCompatibilityConstraintValidator::getFiltersInFormatOfType

Same name in other branches
  1. 9 core/modules/ckeditor5/src/Plugin/Validation/Constraint/FundamentalCompatibilityConstraintValidator.php \Drupal\ckeditor5\Plugin\Validation\Constraint\FundamentalCompatibilityConstraintValidator::getFiltersInFormatOfType()
  2. 11.x core/modules/ckeditor5/src/Plugin/Validation/Constraint/FundamentalCompatibilityConstraintValidator.php \Drupal\ckeditor5\Plugin\Validation\Constraint\FundamentalCompatibilityConstraintValidator::getFiltersInFormatOfType()

Gets the filters of the given type in this text format.

Parameters

\Drupal\filter\FilterFormatInterface $text_format: A text format whose filters to get.

int $filter_type: One of FilterInterface::TYPE_*.

callable|null $extra_requirements: An optional callable that can check a filter of this type for additional conditions to be met. Must return TRUE when it meets the conditions, FALSE otherwise.

Return value

iterable|\Drupal\filter\Plugin\FilterInterface[] An iterable of matched filter plugins.

3 calls to FundamentalCompatibilityConstraintValidator::getFiltersInFormatOfType()
FundamentalCompatibilityConstraintValidator::checkHtmlRestrictionsMatch in core/modules/ckeditor5/src/Plugin/Validation/Constraint/FundamentalCompatibilityConstraintValidator.php
Checks the HTML restrictions match the enabled CKEditor 5 plugins' output.
FundamentalCompatibilityConstraintValidator::checkNoMarkupFilters in core/modules/ckeditor5/src/Plugin/Validation/Constraint/FundamentalCompatibilityConstraintValidator.php
Checks no TYPE_MARKUP_LANGUAGE filters are present.
FundamentalCompatibilityConstraintValidator::findHtmlRestrictorFilterNotAllowingTags in core/modules/ckeditor5/src/Plugin/Validation/Constraint/FundamentalCompatibilityConstraintValidator.php
Analyzes a text format to find the filter not allowing required tags.

File

core/modules/ckeditor5/src/Plugin/Validation/Constraint/FundamentalCompatibilityConstraintValidator.php, line 262

Class

FundamentalCompatibilityConstraintValidator
Validates fundamental compatibility of CKEditor 5 with the given text format.

Namespace

Drupal\ckeditor5\Plugin\Validation\Constraint

Code

private static function getFiltersInFormatOfType(FilterFormatInterface $text_format, int $filter_type, ?callable $extra_requirements = NULL) : iterable {
    assert(in_array($filter_type, [
        FilterInterface::TYPE_MARKUP_LANGUAGE,
        FilterInterface::TYPE_HTML_RESTRICTOR,
        FilterInterface::TYPE_TRANSFORM_REVERSIBLE,
        FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE,
    ]));
    foreach ($text_format->filters() as $id => $filter) {
        if ($filter->status && $filter->getType() === $filter_type && ($extra_requirements === NULL || $extra_requirements($filter))) {
            (yield $id => $filter);
        }
    }
}

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