class Filter

Defines an filter annotation object.

Hierarchy

Expanded class hierarchy of Filter

9 files declare their use of Filter
FilterAutoP.php in drupal/core/modules/filter/lib/Drupal/filter/Plugin/Filter/FilterAutoP.php
Contains \Drupal\filter\Plugin\Filter\FilterAutoP.
FilterHtml.php in drupal/core/modules/filter/lib/Drupal/filter/Plugin/Filter/FilterHtml.php
Contains \Drupal\filter\Plugin\Filter\FilterHtml.
FilterHtmlCorrector.php in drupal/core/modules/filter/lib/Drupal/filter/Plugin/Filter/FilterHtmlCorrector.php
Contains \Drupal\filter\Plugin\Filter\FilterHtmlCorrector.
FilterHtmlEscape.php in drupal/core/modules/filter/lib/Drupal/filter/Plugin/Filter/FilterHtmlEscape.php
Contains \Drupal\filter\Plugin\Filter\FilterHtmlEscape.
FilterHtmlImageSecure.php in drupal/core/modules/filter/lib/Drupal/filter/Plugin/Filter/FilterHtmlImageSecure.php
Contains \Drupal\filter\Plugin\Filter\FilterHtmlImageSecure.

... See full list

42 string references to 'Filter'
DbLogTest::testFilter in drupal/core/modules/dblog/lib/Drupal/dblog/Tests/DbLogTest.php
Tests the database log filter functionality at admin/reports/dblog.
dblog_filter_form in drupal/core/modules/dblog/dblog.admin.inc
Form constructor for the database logging filter form.
dblog_filter_form_submit in drupal/core/modules/dblog/dblog.admin.inc
Form submission handler for dblog_filter_form().
dblog_filter_form_validate in drupal/core/modules/dblog/dblog.admin.inc
Form validation handler for dblog_filter_form().
design_test_form_details in drupal/core/modules/system/tests/modules/design_test/form/details.inc
Form constructor for testing theme_details().

... See full list

9 classes are annotated with Filter
FilterAutoP in drupal/core/modules/filter/lib/Drupal/filter/Plugin/Filter/FilterAutoP.php
Provides a filter to conver line breaks to HTML.
FilterHtml in drupal/core/modules/filter/lib/Drupal/filter/Plugin/Filter/FilterHtml.php
Provides a filter to limit allowed HTML tags.
FilterHtmlCorrector in drupal/core/modules/filter/lib/Drupal/filter/Plugin/Filter/FilterHtmlCorrector.php
Provides a filter to correct faulty and chopped off HTML.
FilterHtmlEscape in drupal/core/modules/filter/lib/Drupal/filter/Plugin/Filter/FilterHtmlEscape.php
Provides a filter to display any HTML as plain text.
FilterHtmlImageSecure in drupal/core/modules/filter/lib/Drupal/filter/Plugin/Filter/FilterHtmlImageSecure.php
Provides a filter to restrict images to site.

... See full list

File

drupal/core/modules/filter/lib/Drupal/filter/Annotation/Filter.php, line 17
Contains \Drupal\filter\Annotation\Filter.

Namespace

Drupal\filter\Annotation
View source
class Filter extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The name of the module providing the type.
   *
   * @var string
   */
  public $module;

  /**
   * The human-readable name of the filter.
   *
   * This is used as an administrative summary of what the filter does.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $title;

  /**
   * Additional administrative information about the filter's behavior.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation (optional)
   */
  public $description = '';

  /**
   * A default weight for the filter in new text formats.
   *
   * @var int (optional)
   */
  public $weight = 0;

  /**
   * Whether this filter is enabled or disabled by default.
   *
   * @var bool (optional)
   */
  public $status = FALSE;

  /**
   * Specifies whether the filtered text can be cached.
   *
   * Note that setting this to FALSE makes the entire text format not cacheable,
   * which may have an impact on the site's overall performance.
   *
   * @var bool (optional)
   */
  public $cache = TRUE;

  /**
   * The default settings for the filter.
   *
   * @var array (optional)
   */
  public $settings = array();

}

Members

Namesort descending Modifiers Type Description Overrides
Filter::$cache public property Specifies whether the filtered text can be cached.
Filter::$description public property Additional administrative information about the filter's behavior.
Filter::$id public property The plugin ID.
Filter::$module public property The name of the module providing the type.
Filter::$settings public property The default settings for the filter.
Filter::$status public property Whether this filter is enabled or disabled by default.
Filter::$title public property The human-readable name of the filter.
Filter::$weight public property A default weight for the filter in new text formats.
Plugin::$definition protected property The plugin definiton read from the class annotation.
Plugin::get public function Implements Drupal\Core\Annotation\AnnotationInterface::get(). Overrides AnnotationInterface::get
Plugin::parse protected function Parses an annotation into its definition.
Plugin::__construct public function Constructs a Plugin object.