class Parsedown in Markdown 8.2

Support for Parsedown by Emanuil Rusev.

Plugin annotation


@MarkdownAllowedHtml(
  id = "parsedown",
)
@MarkdownParser(
  id = "parsedown",
  label = @Translation("Parsedown"),
  description = @Translation("Parser for Markdown."),
  weight = 21,
  libraries = {
    @ComposerPackage(
      id = "erusev/parsedown",
      object = "\Parsedown",
      url = "https://parsedown.org",
    ),
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\markdown\Plugin\Markdown\AnnotatedPluginBase implements AnnotatedPluginInterface uses \Symfony\Component\DependencyInjection\ContainerAwareTrait
    class \Drupal\markdown\Plugin\Markdown\InstallablePluginBase implements InstallablePluginInterface uses PluginDependencyTrait, MoreInfoTrait
    class \Drupal\markdown\Plugin\Markdown\BaseParser implements PluginFormInterface, ParserInterface, FilterAwareInterface uses RefinableCacheableDependencyTrait, EnabledPluginTrait, FilterAwareTrait, SettingsTrait
    class \Drupal\markdown\Plugin\Markdown\Parsedown\Parsedown implements AllowedHtmlInterface, SettingsInterface uses ParserAllowedHtmlTrait

Expanded class hierarchy of Parsedown

File

src/Plugin/Markdown/Parsedown/Parsedown.php, line 36

Namespace

Drupal\markdown\Plugin\Markdown\Parsedown

View source

class Parsedown extends BaseParser implements AllowedHtmlInterface, SettingsInterface {
  use ParserAllowedHtmlTrait {
    allowedHtmlTags as allowedHtmlTagsTrait;
  }

  /**
   * The Parsedown class to use.
   *
   * @var string
   */
  protected static $parsedownClass = '\\Parsedown';

  /**
   * The parser version.
   *
   * @var string
   */
  protected static $version;

  /**
   * The Parsedown instance.
   *
   * @var \Parsedown
   */
  protected $parsedown;

  /**
   * {@inheritdoc}
   */
  public function __sleep() {
    unset($this->parsedown);
    return parent::__sleep();
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings($pluginDefinition) {

    /* @var \Drupal\markdown\Annotation\InstallablePlugin $pluginDefinition */
    return [
      'breaks_enabled' => FALSE,
      'markup_escaped' => FALSE,
      'safe_mode' => FALSE,
      'strict_mode' => FALSE,
      'urls_linked' => TRUE,
    ] + parent::defaultSettings($pluginDefinition);
  }

  /**
   * {@inheritdoc}
   */
  public function allowedHtmlTags(ParserInterface $parser, ActiveTheme $activeTheme = NULL) {
    return FilterHtml::mergeAllowedTags($this
      ->allowedHtmlTagsTrait($parser, $activeTheme), [
      'caption' => [],
      'col' => [
        'span' => TRUE,
      ],
      'colgroup' => [
        'span' => TRUE,
      ],
      'del' => [],
      'table' => [],
      'tbody' => [],
      'td' => [
        'colspan' => TRUE,
        'headers' => TRUE,
        'rowspan' => TRUE,
      ],
      'tfoot' => [],
      'th' => [
        'abbr' => TRUE,
        'colspan' => TRUE,
        'headers' => TRUE,
        'rowspan' => TRUE,
        'scope' => TRUE,
      ],
      'thead' => [],
      'tr' => [],
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $element, FormStateInterface $form_state) {

    /** @var \Drupal\markdown\Form\SubformStateInterface $form_state */
    $element = parent::buildConfigurationForm($element, $form_state);
    $element += $this
      ->createSettingElement('breaks_enabled', [
      '#access' => !!$this
        ->getSettingMethod('breaks_enabled'),
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Automatic line breaks'),
      '#description' => $this
        ->t('Enabling this will use line breaks (<code>&lt;br&gt;</code>) when a new line is detected instead of creating separate paragraphs (<code>&lt;p&gt;</code>).'),
    ], $form_state);
    $element += $this
      ->createSettingElement('markup_escaped', [
      '#access' => !!$this
        ->getSettingMethod('markup_escaped'),
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Markup Escaped'),
      '#description' => $this
        ->t('Enabling this will escape HTML markup.'),
    ], $form_state);
    $this
      ->renderStrategyDisabledSettingState($form_state, $element['markup_escaped']);
    $element += $this
      ->createSettingElement('safe_mode', [
      '#access' => !!$this
        ->getSettingMethod('safe_mode'),
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Safe Mode'),
      '#description' => $this
        ->t('Enabling this will apply sanitization to additional scripting vectors (such as scripting link destinations) that are introduced by the markdown syntax itself.'),
    ], $form_state);
    $this
      ->renderStrategyDisabledSettingState($form_state, $element['safe_mode']);

    // Always disable safe_mode and markup_escaped when using a render strategy.
    if ($this
      ->getRenderStrategy() !== static::NONE) {
      $element['markup_escaped']['#value'] = FALSE;
      $element['safe_mode']['#value'] = FALSE;
    }
    $element += $this
      ->createSettingElement('strict_mode', [
      '#access' => !!$this
        ->getSettingMethod('strict_mode'),
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Strict Mode'),
      '#description' => $this
        ->t('Enables strict CommonMark compliance.'),
    ], $form_state);
    $element += $this
      ->createSettingElement('urls_linked', [
      '#access' => !!$this
        ->getSettingMethod('urls_linked'),
      '#type' => 'checkbox',
      '#title' => $this
        ->t('URLs linked'),
      '#description' => $this
        ->t('Enabling this will automatically create links for URLs.'),
    ], $form_state);
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  protected function convertToHtml($markdown, LanguageInterface $language = NULL) {
    return $this
      ->getParsedown()
      ->text($markdown);
  }

  /**
   * Retrieves the Parsedown instance.
   *
   * @return \Parsedown
   *   A PHP Markdown parser.
   */
  public function getParsedown() {
    if (!$this->parsedown) {
      $this->parsedown = new static::$parsedownClass();
      $settings = $this
        ->getSettings();

      // Unless the render strategy is set to "none", force the
      // following settings to be disabled.
      if ($this
        ->getRenderStrategy() !== static::NONE) {
        $settings['markup_escaped'] = FALSE;
        $settings['safe_mode'] = FALSE;
      }
      foreach ($settings as $name => $value) {
        if ($method = $this
          ->getSettingMethod($name)) {
          $this->parsedown
            ->{$method}($value);
        }
      }
    }
    return $this->parsedown;
  }

  /**
   * {@inheritdoc}
   */
  public function settingExists($name) {
    return !!$this
      ->getSettingMethod($name);
  }

  /**
   * Retrieves the method used to configure a specific setting.
   *
   * @param string $name
   *   The name of the setting.
   *
   * @return string|null
   *   The method name or NULL if method does not exist.
   */
  protected function getSettingMethod($name) {
    $map = static::settingMethodMap();
    return isset($map[$name]) && method_exists(static::$parsedownClass, $map[$name]) ? $map[$name] : NULL;
  }

  /**
   * A map of setting <-> method.
   *
   * @return array
   *   An associative array containing key/value pairs, where the key is the
   *   setting and the value is the method.
   */
  protected static function settingMethodMap() {
    return [
      'breaks_enabled' => 'setBreaksEnabled',
      'markup_escaped' => 'setMarkupEscaped',
      'safe_mode' => 'setSafeMode',
      'strict_mode' => 'setStrictMode',
      'urls_linked' => 'setUrlsLinked',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AnnotatedPluginBase::$originalPluginId	protected	property	The original plugin_id that was called, not a fallback identifier.
AnnotatedPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
AnnotatedPluginBase::getConfigurationOverrides	public	function	Retrieves the configuration overrides for the plugin. Overrides AnnotatedPluginInterface::getConfigurationOverrides
AnnotatedPluginBase::getDescription	public	function	Retrieves the description of the plugin, if set. Overrides AnnotatedPluginInterface::getDescription
AnnotatedPluginBase::getOriginalPluginId	public	function	Retrieves the original plugin identifier. Overrides AnnotatedPluginInterface::getOriginalPluginId
AnnotatedPluginBase::getProvider	public	function	Returns the provider (extension name) of the plugin. Overrides AnnotatedPluginInterface::getProvider
AnnotatedPluginBase::getWeight	public	function	Returns the weight of the plugin (used for sorting). Overrides AnnotatedPluginInterface::getWeight
AnnotatedPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
AnnotatedPluginBase::__toString	public	function
BaseParser::$enabled	protected	property
BaseParser::getAllowedHtml Deprecated	public	function	Overrides RenderStrategyInterface::getAllowedHtml
BaseParser::getAllowedHtmlPlugins	public	function	Retrieves the allowed HTML plugins relevant to the object. Overrides RenderStrategyInterface::getAllowedHtmlPlugins
BaseParser::getConfiguration	public	function	Gets this plugin's configuration. Overrides InstallablePluginBase::getConfiguration	2
BaseParser::getConfigurationSortOrder	protected	function	Determines the configuration sort order by weight. Overrides InstallablePluginBase::getConfigurationSortOrder	1
BaseParser::getContext	protected	function	Builds context around a markdown parser's hierarchy filter format chain.
BaseParser::getCustomAllowedHtml	public	function	Retrieves the custom (user provided) allowed HTML. Overrides RenderStrategyInterface::getCustomAllowedHtml
BaseParser::getRenderStrategy	public	function	Retrieves the render strategy to use. Overrides RenderStrategyInterface::getRenderStrategy
BaseParser::parse	public	function	Parses markdown into HTML. Overrides ParserInterface::parse
BaseParser::renderStrategyDisabledSetting	protected	function	A description explaining why a setting is disabled due to render strategy.
BaseParser::renderStrategyDisabledSettingState	protected	function	Adds a conditional state for a setting element based on render strategy.
BaseParser::validateSettings	public static	function	Validates parser settings.
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::getCacheContexts	public	function		3
CacheableDependencyTrait::getCacheMaxAge	public	function		3
CacheableDependencyTrait::getCacheTags	public	function		3
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
EnabledPluginTrait::enabledByDefault	public	function		1
EnabledPluginTrait::isEnabled	public	function
FilterAwareTrait::$filter	protected	property	A Filter plugin.
FilterAwareTrait::getFilter	public	function
FilterAwareTrait::setFilter	public	function
InstallablePluginBase::$config	protected	property	The config for this plugin.
InstallablePluginBase::buildLibrary	public	function	Builds a display for a library. Overrides InstallablePluginInterface::buildLibrary
InstallablePluginBase::buildStatus	public	function	Builds a display status based on the current state of the plugin. Overrides InstallablePluginInterface::buildStatus
InstallablePluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
InstallablePluginBase::config	public	function	Retrieves the config instance for this plugin. Overrides InstallablePluginInterface::config
InstallablePluginBase::createConfig	protected static	function
InstallablePluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides AnnotatedPluginBase::defaultConfiguration	1
InstallablePluginBase::getAvailableInstalls	public	function	Retrieves available installs.
InstallablePluginBase::getConfigurationName	protected	function	Returns the configuration name for the plugin.
InstallablePluginBase::getContainer	public	function	Retrieves the container.
InstallablePluginBase::getDeprecated	public	function	Retrieves the deprecation message, if any. Overrides InstallablePluginInterface::getDeprecated
InstallablePluginBase::getExperimental	public	function	Retrieves the experimental message. Overrides InstallablePluginInterface::getExperimental
InstallablePluginBase::getInstalledId	public	function	Retrieves the composer package name of the installable library, if any. Overrides InstallablePluginInterface::getInstalledId
InstallablePluginBase::getInstalledLibrary	public	function	Retrieves the installed library used by the plugin. Overrides InstallablePluginInterface::getInstalledLibrary
InstallablePluginBase::getLabel	public	function	Displays the human-readable label of the plugin. Overrides AnnotatedPluginBase::getLabel
InstallablePluginBase::getLink	public	function	Retrieves the plugin as a link using its label and URL. Overrides InstallablePluginInterface::getLink
InstallablePluginBase::getObject	public	function	@TODO: Refactor to use variadic parameters. Overrides InstallablePluginInterface::getObject
InstallablePluginBase::getObjectClass	public	function	Retrieves the class name of the object defined by the installed library. Overrides InstallablePluginInterface::getObjectClass
InstallablePluginBase::getPluginDependencies	protected	function		1
InstallablePluginBase::getPreferredLibrary	public	function	Retrieves the preferred library of the plugin. Overrides InstallablePluginInterface::getPreferredLibrary
InstallablePluginBase::getSortedConfiguration	public	function	Retrieves the configuration for the plugin, but sorted. Overrides InstallablePluginInterface::getSortedConfiguration
InstallablePluginBase::getUrl	public	function	Retrieves the URL of the plugin, if set. Overrides InstallablePluginInterface::getUrl
InstallablePluginBase::getVersion	public	function	The current version of the plugin. Overrides InstallablePluginInterface::getVersion
InstallablePluginBase::getVersionConstraint	public	function
InstallablePluginBase::hasMultipleLibraries	public	function	Indicates whether plugin has multiple installs to check. Overrides InstallablePluginInterface::hasMultipleLibraries
InstallablePluginBase::isInstalled	public	function	Indicates whether the plugin is installed. Overrides InstallablePluginInterface::isInstalled
InstallablePluginBase::isPreferred	public	function	Indicates whether the plugin is using the preferred library. Overrides InstallablePluginInterface::isPreferred
InstallablePluginBase::isPreferredLibraryInstalled	public	function	Indicates whether the preferred library is installed. Overrides InstallablePluginInterface::isPreferredLibraryInstalled
InstallablePluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides AnnotatedPluginBase::setConfiguration	3
InstallablePluginBase::showInUi	public	function	Indicates whether the plugin should be shown in the UI. Overrides InstallablePluginInterface::showInUi
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
MoreInfoTrait::moreInfo	protected	function	Appends existing content with a "More Info" link.
Parsedown::$parsedown	protected	property	The Parsedown instance.
Parsedown::$parsedownClass	protected static	property	The Parsedown class to use.	1
Parsedown::$version	protected static	property	The parser version.
Parsedown::allowedHtmlTags	public	function	Retrieves the allowed HTML tags. Overrides AllowedHtmlInterface::allowedHtmlTags	1
Parsedown::buildConfigurationForm	public	function	Form constructor. Overrides BaseParser::buildConfigurationForm
Parsedown::convertToHtml	protected	function	Converts Markdown into HTML. Overrides BaseParser::convertToHtml
Parsedown::defaultSettings	public static	function	Provides the default settings for the plugin. Overrides SettingsTrait::defaultSettings
Parsedown::getParsedown	public	function	Retrieves the Parsedown instance.
Parsedown::getSettingMethod	protected	function	Retrieves the method used to configure a specific setting.
Parsedown::settingExists	public	function	Flag indicating whether a setting exists. Overrides SettingsTrait::settingExists
Parsedown::settingMethodMap	protected static	function	A map of setting <-> method.
Parsedown::__sleep	public	function	Overrides DependencySerializationTrait::__sleep
ParserAllowedHtmlTrait::allowedHtmlTags	public	function	Aliased as: allowedHtmlTagsTrait	1
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance. Aliased as: getPluginDependenciesTrait
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler.
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler.
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
RendererTrait::$renderer	protected static	property	The Renderer service.
RendererTrait::renderer	protected	function	Retrieves the Renderer service.
RenderStrategyInterface::DOCUMENTATION_URL		constant	The documentation URL for further explaining render strategies.
RenderStrategyInterface::ESCAPE_INPUT		constant	Strategy used to escape HTML input prior to parsing markdown.
RenderStrategyInterface::FILTER_OUTPUT		constant	Strategy used to filter the output of parsed markdown.
RenderStrategyInterface::MARKDOWN_XSS_URL Deprecated		constant	The URL for explaining Markdown and XSS; render strategies.
RenderStrategyInterface::NONE		constant	No render strategy.
RenderStrategyInterface::STRIP_INPUT		constant	Strategy used to remove HTML input prior to parsing markdown.
SettingsTrait::createSettingElement	protected	function	Creates a setting element.
SettingsTrait::getDefaultSetting	public	function
SettingsTrait::getSetting	public	function
SettingsTrait::getSettingOverrides	public	function
SettingsTrait::getSettings	public	function
SettingsTrait::settingsKey	public	function		6
SettingsTrait::submitConfigurationForm	public	function
SettingsTrait::validateConfigurationForm	public	function		2
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class Parsedown in Markdown 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation