Version 1
[yaffs-website] / web / core / modules / filter / src / Annotation / Filter.php
diff --git a/web/core/modules/filter/src/Annotation/Filter.php b/web/core/modules/filter/src/Annotation/Filter.php
new file mode 100644 (file)
index 0000000..4d90c58
--- /dev/null
@@ -0,0 +1,78 @@
+<?php
+
+namespace Drupal\filter\Annotation;
+
+use Drupal\Component\Annotation\Plugin;
+
+/**
+ * Defines an filter annotation object.
+ *
+ * Plugin Namespace: Plugin\Filter
+ *
+ * For a working example, see \Drupal\filter\Plugin\Filter\FilterHtml
+ *
+ * @see \Drupal\filter\FilterPluginManager
+ * @see \Drupal\filter\Plugin\FilterInterface
+ * @see \Drupal\filter\Plugin\FilterBase
+ * @see plugin_api
+ *
+ * @Annotation
+ */
+class Filter extends Plugin {
+
+  /**
+   * The plugin ID.
+   *
+   * @var string
+   */
+  public $id;
+
+  /**
+   * The name of the provider that owns the filter.
+   *
+   * @var string
+   */
+  public $provider;
+
+  /**
+   * 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;
+
+  /**
+   * The default settings for the filter.
+   *
+   * @var array (optional)
+   */
+  public $settings = [];
+
+}