interface MarkdownInterface in Markdown 3.0.x
Same name and namespace in other branches
- 8.2 src/MarkdownInterface.php \Drupal\markdown\MarkdownInterface
Interface MarkdownInterface.
Hierarchy
- interface \Drupal\Core\DependencyInjection\ContainerInjectionInterface
- interface \Drupal\markdown\MarkdownInterface extends \Symfony\Component\DependencyInjection\ContainerAwareInterface
Expanded class hierarchy of MarkdownInterface
All classes that implement MarkdownInterface
2 files declare their use of MarkdownInterface
- Extension.php in src/
Twig/ Markdown/ Extension.php - TokenParser.php in src/
Twig/ Markdown/ TokenParser.php
File
- src/
MarkdownInterface.php, line 13
Namespace
Drupal\markdownView source
interface MarkdownInterface extends ContainerAwareInterface, ContainerInjectionInterface {
/**
* Loads a cached ParsedMarkdown object.
*
* @param string $id
* A unique identifier that will be used to cache the parsed markdown.
* @param string $markdown
* Optional. The fallback markdown to parse if the cached ParsedMarkdown
* object doesn't yet exist. If provided, it will be parsed
* and its identifier set to the provided $id and then cached.
* @param string $parser
* Optional. The plugin identifier of the MarkdownParser to retrieve. If
* not provided, the first enabled Markdown filter in a text formatter
* available to the current user is used.
* @param string|\Drupal\filter\Plugin\FilterInterface|\Drupal\filter\FilterFormatInterface $filter
* Optional. A specific filter plugin to use, a string representing a filter
* format or a FilterFormatInterface object containing a "markdown" filter.
* @param \Drupal\Core\Session\AccountInterface $account
* Optional. An account used to retrieve filters available filters if one
* wasn't already specified.
* @param \Drupal\Core\Language\LanguageInterface $language
* Optional. The language of the text that is being converted.
*
* @return \Drupal\markdown\ParsedMarkdownInterface|null
* A ParsedMarkdown object or NULL if it doesn't exist and $markdown was
* not provided as a fallback.
*/
public static function load($id, $markdown = NULL, $parser = NULL, $filter = NULL, AccountInterface $account = NULL, LanguageInterface $language = NULL);
/**
* Loads a cached ParsedMarkdown object.
*
* @param string $id
* A unique identifier that will be used to cache the parsed markdown.
* @param string $path
* The local file system path of a markdown file to parse if the cached
* ParsedMarkdown object doesn't yet exist. Once parsed, its identifier
* will be set to the provided $id and then cached.
* @param string $parser
* Optional. The plugin identifier of the MarkdownParser to retrieve. If
* not provided, the first enabled Markdown filter in a text formatter
* available to the current user is used.
* @param string|\Drupal\filter\Plugin\FilterInterface|\Drupal\filter\FilterFormatInterface $filter
* Optional A specific filter plugin to use, a string representing a filter
* format or a FilterFormatInterface object containing a "markdown" filter.
* @param \Drupal\Core\Session\AccountInterface $account
* Optional. An account used to retrieve filters available filters if one
* wasn't already specified.
* @param \Drupal\Core\Language\LanguageInterface $language
* Optional. The language of the text that is being converted.
*
* @return \Drupal\markdown\ParsedMarkdownInterface
* A ParsedMarkdown object.
*
* @throws \Symfony\Component\HttpFoundation\File\Exception\FileNotFoundException
* When the provided $path does not exist in the local file system.
*/
public static function loadPath($id, $path, $parser = NULL, $filter = NULL, AccountInterface $account = NULL, LanguageInterface $language = NULL);
/**
* Loads a cached ParsedMarkdown object.
*
* @param string $id
* A unique identifier that will be used to cache the parsed markdown.
* @param string $url
* The external URL of a markdown file to parse if the cached
* ParsedMarkdown object doesn't yet exist. Once parsed, its identifier
* will be set to the provided $id and then cached.
* @param string $parser
* Optional. The plugin identifier of the MarkdownParser to retrieve. If
* not provided, the first enabled Markdown filter in a text formatter
* available to the current user is used.
* @param string|\Drupal\filter\Plugin\FilterInterface|\Drupal\filter\FilterFormatInterface $filter
* Optional A specific filter plugin to use, a string representing a filter
* format or a FilterFormatInterface object containing a "markdown" filter.
* @param \Drupal\Core\Session\AccountInterface $account
* Optional. An account used to retrieve filters available filters if one
* wasn't already specified.
* @param \Drupal\Core\Language\LanguageInterface $language
* Optional. The language of the text that is being converted.
*
* @return \Drupal\markdown\ParsedMarkdownInterface
* A ParsedMarkdown object.
*
* @throws \Symfony\Component\HttpFoundation\File\Exception\FileNotFoundException
* When the provided $url does not exist or is not reachable.
*/
public static function loadUrl($id, $url, $parser = NULL, $filter = NULL, AccountInterface $account = NULL, LanguageInterface $language = NULL);
/**
* Parses markdown into HTML.
*
* @param string $markdown
* The markdown string to parse.
* @param string $parser
* The plugin identifier of the MarkdownParser to retrieve. If not provided,
* the first enabled Markdown filter in a text formatter available to the
* current user is used.
* @param string|\Drupal\filter\Plugin\FilterInterface|\Drupal\filter\FilterFormatInterface $filter
* Optional A specific filter plugin to use, a string representing a filter
* format or a FilterFormatInterface object containing a "markdown" filter.
* @param \Drupal\Core\Session\AccountInterface $account
* Optional. An account used to retrieve filters available filters if one
* wasn't already specified.
* @param \Drupal\Core\Language\LanguageInterface $language
* Optional. The language of the text that is being converted.
*
* @return \Drupal\markdown\ParsedMarkdownInterface
* A ParsedMarkdown object.
*/
public static function parse($markdown, $parser = NULL, $filter = NULL, AccountInterface $account = NULL, LanguageInterface $language = NULL);
/**
* Parses the file contents of a markdown file into HTML.
*
* @param string $path
* The local file system path of a markdown file to parse.
* @param string $parser
* The plugin identifier of the MarkdownParser to retrieve. If not provided,
* the first enabled Markdown filter in a text formatter available to the
* current user is used.
* @param string|\Drupal\filter\Plugin\FilterInterface|\Drupal\filter\FilterFormatInterface $filter
* Optional A specific filter plugin to use, a string representing a filter
* format or a FilterFormatInterface object containing a "markdown" filter.
* @param \Drupal\Core\Session\AccountInterface $account
* Optional. An account used to retrieve filters available filters if one
* wasn't already specified.
* @param \Drupal\Core\Language\LanguageInterface $language
* Optional. The language of the text that is being converted.
*
* @return \Drupal\markdown\ParsedMarkdownInterface
* A ParsedMarkdown object.
*
* @throws \Symfony\Component\HttpFoundation\File\Exception\FileNotFoundException
* When the provided $path does not exist in the local file system.
*/
public static function parsePath($path, $parser = NULL, $filter = NULL, AccountInterface $account = NULL, LanguageInterface $language = NULL);
/**
* Parses the contents of a URL containing markdown into HTML.
*
* @param string|\Drupal\Core\Url|\Psr\Http\Message\UriInterface $url
* The external URL of a markdown file to parse.
* @param string $parser
* The plugin identifier of the MarkdownParser to retrieve. If not provided,
* the first enabled Markdown filter in a text formatter available to the
* current user is used.
* @param string|\Drupal\filter\Plugin\FilterInterface|\Drupal\filter\FilterFormatInterface $filter
* Optional A specific filter plugin to use, a string representing a filter
* format or a FilterFormatInterface object containing a "markdown" filter.
* @param \Drupal\Core\Session\AccountInterface $account
* Optional. An account used to retrieve filters available filters if one
* wasn't already specified.
* @param \Drupal\Core\Language\LanguageInterface $language
* Optional. The language of the text that is being converted.
*
* @return \Drupal\markdown\ParsedMarkdownInterface
* A ParsedMarkdown object.
*
* @throws \Symfony\Component\HttpFoundation\File\Exception\FileNotFoundException
* When the provided $url does not exist or is not reachable.
*/
public static function parseUrl($url, $parser = NULL, $filter = NULL, AccountInterface $account = NULL, LanguageInterface $language = NULL);
/**
* Retrieves a specific MarkdownParser.
*
* @param string $parser
* The plugin identifier of the MarkdownParser to retrieve. If not provided,
* the first enabled Markdown filter in a text formatter available to the
* current user is used.
* @param string|\Drupal\filter\Plugin\FilterInterface|\Drupal\filter\FilterFormatInterface $filter
* Optional A specific filter plugin to use, a string representing a filter
* format or a FilterFormatInterface object containing a "markdown" filter.
* @param \Drupal\Core\Session\AccountInterface $account
* Optional. An account used to retrieve filters available filters if one
* wasn't already specified.
*
* @return \Drupal\markdown\Plugin\Markdown\MarkdownParserInterface
* A MarkdownParser plugin.
*/
public function getParser($parser = NULL, $filter = NULL, AccountInterface $account = NULL);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContainerInjectionInterface:: |
public static | function | Instantiates a new instance of this class. | 75 |
MarkdownInterface:: |
public | function | Retrieves a specific MarkdownParser. | 1 |
MarkdownInterface:: |
public static | function | Loads a cached ParsedMarkdown object. | 1 |
MarkdownInterface:: |
public static | function | Loads a cached ParsedMarkdown object. | 1 |
MarkdownInterface:: |
public static | function | Loads a cached ParsedMarkdown object. | 1 |
MarkdownInterface:: |
public static | function | Parses markdown into HTML. | 1 |
MarkdownInterface:: |
public static | function | Parses the file contents of a markdown file into HTML. | 1 |
MarkdownInterface:: |
public static | function | Parses the contents of a URL containing markdown into HTML. | 1 |