class CommonMarkGfm in Markdown 8.2

Support for CommonMark GFM by The League of Extraordinary Packages.

Plugin annotation

@MarkdownParser(
  id = "commonmark-gfm",
  label = @Translation("CommonMark GFM"),
  description = @Translation("A robust, highly-extensible Markdown parser for PHP based on the Github-Flavored Markdown specification."),
  extensionInterfaces = {
    "\Drupal\markdown\Plugin\Markdown\CommonMark\ExtensionInterface",
  },
  bundledExtensions = {
    "commonmark-autolink",
    "commonmark-disallowed-raw-html",
    "commonmark-strikethrough",
    "commonmark-table",
    "commonmark-task-list",
  },
  libraries = {
    @ComposerPackage(
      id = "league/commonmark",
      object = "\League\CommonMark\GithubFlavoredMarkdownConverter",
      customLabel = "commonmark-gfm",
      url = "https://commonmark.thephpleague.com/extensions/github-flavored-markdown/",
      requirements = {
        @InstallableRequirement(
          constraints = {"Version" = "^1.3 || ^2.0"}
        ),
      },
    ),
  },
)

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\BaseExtensibleParser implements ExtensibleParserInterface
            • class \Drupal\markdown\Plugin\Markdown\CommonMark\CommonMark implements AllowedHtmlInterface uses ParserAllowedHtmlTrait
              • class \Drupal\markdown\Plugin\Markdown\CommonMark\CommonMarkGfm

File

src/Plugin/Markdown/CommonMark/CommonMarkGfm.php, line 37

Namespace

Drupal\markdown\Plugin\Markdown\CommonMark

class CommonMarkGfm extends CommonMark {

  /**
   * {@inheritdoc}
   */
  public static function converterClass() {
    if (!isset(static::$converterClass)) {
      static::$converterClass = '\\League\\CommonMark\\GithubFlavoredMarkdownConverter';
    }
    return static::$converterClass;
  }

  /**
   * {@inheritdoc}
   */
  protected function createEnvironment() {

    /** @var \League\CommonMark\Environment|\League\CommonMark\Environment\Environment $environment */
    $environment = static::environmentClass();
    return $environment::createGFMEnvironment();
  }

}

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
BaseExtensibleParser::$extensionCollection	protected	property	A collection of MarkdownExtension plugins specific to the parser.
BaseExtensibleParser::$extensions	protected	property	The extension configuration.
BaseExtensibleParser::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides InstallablePluginBase::defaultConfiguration
BaseExtensibleParser::extension	public	function	Retrieves a specific extension plugin instance. Overrides ExtensibleParserInterface::extension
BaseExtensibleParser::extensions	public	function	Returns the ordered collection of extension plugin instances. Overrides ExtensibleParserInterface::extensions
BaseExtensibleParser::getBundledExtensionIds	public	function	Retrieves plugin identifiers of extensions bundled with the parser. Overrides ExtensibleParserInterface::getBundledExtensionIds
BaseExtensibleParser::getConfigurationSortOrder	protected	function	Determines the configuration sort order by weight. Overrides BaseParser::getConfigurationSortOrder
BaseExtensibleParser::getPluginCollections	public	function	Gets the plugin collections used by this object. Overrides ObjectWithPluginCollectionInterface::getPluginCollections
BaseExtensibleParser::getPluginDependencies	protected	function	Overrides InstallablePluginBase::getPluginDependencies
BaseExtensibleParser::isExtensionRequired	protected	function	Indicates whether an extension is "required" by another extension.
BaseExtensibleParser::setExtensionConfig	public	function	Sets the configuration for an extension plugin instance.
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::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.
CommonMark::$converter	protected	property	A CommonMark converter instance.
CommonMark::$converterClass	protected static	property	The converter class.	1
CommonMark::$environment	protected	property	A CommonMark environment instance.
CommonMark::$environmentClass	protected static	property	The environment class.
CommonMark::$version	protected static	property	The installed version.
CommonMark::addcslashes	public static	function	Wrapper method to assist with setting values in form.
CommonMark::buildConfigurationForm	public	function	Form constructor. Overrides BaseParser::buildConfigurationForm
CommonMark::converter	public	function	Retrieves a CommonMark converter instance.
CommonMark::convertToHtml	protected	function	Converts Markdown into HTML. Overrides BaseParser::convertToHtml
CommonMark::defaultSettings	public static	function	Overrides SettingsTrait::defaultSettings
CommonMark::environmentClass	public static	function	Retrieves the environment class to be used.
CommonMark::extensionInterfaces	public	function	An array of extension interfaces that the parser supports. Overrides BaseExtensibleParser::extensionInterfaces
CommonMark::getConfiguration	public	function	Gets this plugin's configuration. Overrides BaseExtensibleParser::getConfiguration
CommonMark::getEnvironment	protected	function	Retrieves a CommonMark environment, creating it if necessary.
CommonMark::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides InstallablePluginBase::setConfiguration
CommonMark::validateConfigurationForm	public	function	Overrides SettingsTrait::validateConfigurationForm
CommonMark::__sleep	public	function	Overrides DependencySerializationTrait::__sleep
CommonMarkGfm::converterClass	public static	function	Retrieves the converter class to be used. Overrides CommonMark::converterClass
CommonMarkGfm::createEnvironment	protected	function	Creates an environment. Overrides CommonMark::createEnvironment
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::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::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::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.
ParserAllowedHtmlTrait::allowedHtmlTags	public	function		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::settingExists	public	function		2
SettingsTrait::settingsKey	public	function		6
SettingsTrait::submitConfigurationForm	public	function
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.