1<?php
2
3namespace Drupal\filter\Annotation;
4
5use Drupal\Component\Annotation\Plugin;
6
7/**
8 * Defines an filter annotation object.
9 *
10 * Plugin Namespace: Plugin\Filter
11 *
12 * For a working example, see \Drupal\filter\Plugin\Filter\FilterHtml
13 *
14 * @see \Drupal\filter\FilterPluginManager
15 * @see \Drupal\filter\Plugin\FilterInterface
16 * @see \Drupal\filter\Plugin\FilterBase
17 * @see plugin_api
18 *
19 * @Annotation
20 */
21class Filter extends Plugin {
22
23  /**
24   * The plugin ID.
25   *
26   * @var string
27   */
28  public $id;
29
30  /**
31   * The name of the provider that owns the filter.
32   *
33   * @var string
34   */
35  public $provider;
36
37  /**
38   * The human-readable name of the filter.
39   *
40   * This is used as an administrative summary of what the filter does.
41   *
42   * @ingroup plugin_translatable
43   *
44   * @var \Drupal\Core\Annotation\Translation
45   */
46  public $title;
47
48  /**
49   * Additional administrative information about the filter's behavior.
50   *
51   * @ingroup plugin_translatable
52   *
53   * @var \Drupal\Core\Annotation\Translation (optional)
54   */
55  public $description = '';
56
57  /**
58   * A default weight for the filter in new text formats.
59   *
60   * @var int (optional)
61   */
62  public $weight = 0;
63
64  /**
65   * Whether this filter is enabled or disabled by default.
66   *
67   * @var bool (optional)
68   */
69  public $status = FALSE;
70
71  /**
72   * The default settings for the filter.
73   *
74   * @var array (optional)
75   */
76  public $settings = [];
77
78}
79