interface MarkdownFilterInterface in Markdown 3.0.x

Interface MarkdownFilterInterface.

Hierarchy

• interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\filter\Plugin\FilterInterface
    • interface \Drupal\markdown\Plugin\Filter\MarkdownFilterInterface

6 files declare their use of MarkdownFilterInterface

AtAutolinker.php in src/Plugin/Markdown/Extension/AtAutolinker.php

BaseExtension.php in src/Plugin/Markdown/Extension/BaseExtension.php

HashAutolinker.php in src/Plugin/Markdown/Extension/HashAutolinker.php

LinkRenderer.php in src/Plugin/Markdown/Extension/LinkRenderer.php

MarkdownExtensionInterface.php in src/Plugin/Markdown/Extension/MarkdownExtensionInterface.php

... See full list

File

src/Plugin/Filter/MarkdownFilterInterface.php, line 10

Namespace

Drupal\markdown\Plugin\Filter

interface MarkdownFilterInterface extends FilterInterface {

  /**
   * Retrieves the MarkdownParser plugin for this filter.
   *
   * @return \Drupal\markdown\Plugin\Markdown\MarkdownParserInterface
   *   The MarkdownParser plugin.
   */
  public function getParser();

  /**
   * Retrieves a specific parser setting.
   *
   * @param string $name
   *   The name of the setting to retrieve.
   * @param mixed $default
   *   Optional. The default value to return if not set.
   *
   * @return mixed
   *   The parser setting value.
   */
  public function getParserSetting($name, $default = NULL);

  /**
   * Retrieves all parser specific settings.
   *
   * @return array
   *   The parser settings.
   */
  public function getParserSettings();

  /**
   * Retrieves a specific setting.
   *
   * @param string $name
   *   The name of the setting to retrieve.
   * @param mixed $default
   *   Optional. The default value to return if not set.
   *
   * @return mixed
   *   The setting value.
   */
  public function getSetting($name, $default = NULL);

  /**
   * Retrieves all settings.
   *
   * @return array
   *   The settings.
   */
  public function getSettings();

  /**
   * Indicates whether the filter is enabled or not.
   *
   * @return bool
   *   TRUE or FALSE
   */
  public function isEnabled();

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	14
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	15
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	15
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	20
FilterInterface::getDescription	public	function	Returns the administrative description for this filter plugin.	1
FilterInterface::getHTMLRestrictions	public	function	Returns HTML allowed by this filter's configuration.	1
FilterInterface::getLabel	public	function	Returns the administrative label for this filter plugin.	1
FilterInterface::getType	public	function	Returns the processing type of this filter plugin.	1
FilterInterface::prepare	public	function	Prepares the text for processing.	1
FilterInterface::process	public	function	Performs the filter processing.	21
FilterInterface::settingsForm	public	function	Generates a filter's settings form.	1
FilterInterface::tips	public	function	Generates a filter's tip.	1
FilterInterface::TYPE_HTML_RESTRICTOR		constant	HTML tag and attribute restricting filters to prevent XSS attacks.
FilterInterface::TYPE_MARKUP_LANGUAGE		constant	Non-HTML markup language filters that generate HTML.
FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE		constant	Irreversible transformation filters.
FilterInterface::TYPE_TRANSFORM_REVERSIBLE		constant	Reversible transformation filters.
MarkdownFilterInterface::getParser	public	function	Retrieves the MarkdownParser plugin for this filter.	1
MarkdownFilterInterface::getParserSetting	public	function	Retrieves a specific parser setting.	1
MarkdownFilterInterface::getParserSettings	public	function	Retrieves all parser specific settings.	1
MarkdownFilterInterface::getSetting	public	function	Retrieves a specific setting.	1
MarkdownFilterInterface::getSettings	public	function	Retrieves all settings.	1
MarkdownFilterInterface::isEnabled	public	function	Indicates whether the filter is enabled or not.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2