PHP Class League\CommonMark\Environment

Afficher le fichier Open project: colinodell/commonmark-php Class Usage Examples

Protected Properties

Свойство Type Description
$blockParsers League\CommonMark\Block\Parser\BlockParserInterface[]
$blockRenderersByClass League\CommonMark\Block\Renderer\BlockRendererInterface[]
$config League\CommonMark\Util\Configuration
$documentProcessors League\CommonMark\DocumentProcessorInterface[]
$extensions League\CommonMark\Extension\ExtensionInterface[]
$extensionsInitialized boolean
$inlineParserCharacterRegex string
$inlineParsers League\CommonMark\Inline\Parser\InlineParserInterface[]
$inlineParsersByCharacter array
$inlineProcessors League\CommonMark\Inline\Processor\InlineProcessorInterface[]
$inlineRenderersByClass League\CommonMark\Inline\Renderer\InlineRendererInterface[]

Méthodes publiques

Méthode Description
__construct ( array $config = [] )
addBlockParser ( League\CommonMark\Block\Parser\BlockParserInterface $parser )
addBlockRenderer ( string $blockClass, League\CommonMark\Block\Renderer\BlockRendererInterface $blockRenderer )
addDocumentProcessor ( League\CommonMark\DocumentProcessorInterface $processor )
addExtension ( League\CommonMark\Extension\ExtensionInterface $extension ) Add a single extension
addInlineParser ( League\CommonMark\Inline\Parser\InlineParserInterface $parser )
addInlineProcessor ( League\CommonMark\Inline\Processor\InlineProcessorInterface $processor )
addInlineRenderer ( string $inlineClass, League\CommonMark\Inline\Renderer\InlineRendererInterface $renderer )
createCommonMarkEnvironment ( ) : Environment
createInlineParserEngine ( )
getBlockParsers ( ) : League\CommonMark\Block\Parser\BlockParserInterface[]
getBlockRendererForClass ( string $blockClass ) : League\CommonMark\Block\Renderer\BlockRendererInterface | null
getConfig ( string | null $key = null, mixed $default = null ) : mixed
getDocumentProcessors ( ) : League\CommonMark\DocumentProcessorInterface[]
getExtensions ( ) : League\CommonMark\Extension\ExtensionInterface[] Get all registered extensions
getInlineParser ( string $name ) : League\CommonMark\Inline\Parser\InlineParserInterface
getInlineParserCharacterRegex ( ) : string Regex which matches any character which doesn't indicate an inline element
getInlineParsers ( ) : League\CommonMark\Inline\Parser\InlineParserInterface[]
getInlineParsersForCharacter ( string $character ) : League\CommonMark\Inline\Parser\InlineParserInterface[] | null
getInlineProcessors ( ) : League\CommonMark\Inline\Processor\InlineProcessorInterface[]
getInlineRendererForClass ( string $inlineClass ) : League\CommonMark\Inline\Renderer\InlineRendererInterface | null
mergeConfig ( array $config = [] )
setConfig ( array $config = [] )

Méthodes protégées

Méthode Description
initializeExtension ( League\CommonMark\Extension\ExtensionInterface $extension )
initializeExtensions ( )

Private Methods

Méthode Description
assertUninitialized ( string $message )
buildInlineParserCharacterRegex ( )
getMiscExtension ( ) : MiscExtension
initalizeBlockParsers ( League\CommonMark\Block\Parser\BlockParserInterface[] $blockParsers )
initializeBlockRenderers ( League\CommonMark\Block\Renderer\BlockRendererInterface[] $blockRenderers )
initializeDocumentProcessors ( League\CommonMark\DocumentProcessorInterface[] $documentProcessors )
initializeInlineParsers ( League\CommonMark\Inline\Parser\InlineParserInterface[] $inlineParsers )
initializeInlineProcessors ( League\CommonMark\Inline\Processor\InlineProcessorInterface[] $inlineProcessors )
initializeInlineRenderers ( League\CommonMark\Inline\Renderer\InlineRendererInterface[] $inlineRenderers )

Method Details

__construct() public méthode

public __construct ( array $config = [] )
$config array

addBlockParser() public méthode

public addBlockParser ( League\CommonMark\Block\Parser\BlockParserInterface $parser )
$parser League\CommonMark\Block\Parser\BlockParserInterface

addBlockRenderer() public méthode

public addBlockRenderer ( string $blockClass, League\CommonMark\Block\Renderer\BlockRendererInterface $blockRenderer )
$blockClass string
$blockRenderer League\CommonMark\Block\Renderer\BlockRendererInterface

addDocumentProcessor() public méthode

public addDocumentProcessor ( League\CommonMark\DocumentProcessorInterface $processor )
$processor League\CommonMark\DocumentProcessorInterface

addExtension() public méthode

Add a single extension
public addExtension ( League\CommonMark\Extension\ExtensionInterface $extension )
$extension League\CommonMark\Extension\ExtensionInterface

addInlineParser() public méthode

public addInlineParser ( League\CommonMark\Inline\Parser\InlineParserInterface $parser )
$parser League\CommonMark\Inline\Parser\InlineParserInterface

addInlineProcessor() public méthode

public addInlineProcessor ( League\CommonMark\Inline\Processor\InlineProcessorInterface $processor )
$processor League\CommonMark\Inline\Processor\InlineProcessorInterface

addInlineRenderer() public méthode

public addInlineRenderer ( string $inlineClass, League\CommonMark\Inline\Renderer\InlineRendererInterface $renderer )
$inlineClass string
$renderer League\CommonMark\Inline\Renderer\InlineRendererInterface

createCommonMarkEnvironment() public static méthode

public static createCommonMarkEnvironment ( ) : Environment
Résultat Environment

createInlineParserEngine() public méthode

getBlockParsers() public méthode

public getBlockParsers ( ) : League\CommonMark\Block\Parser\BlockParserInterface[]
Résultat League\CommonMark\Block\Parser\BlockParserInterface[]

getBlockRendererForClass() public méthode

public getBlockRendererForClass ( string $blockClass ) : League\CommonMark\Block\Renderer\BlockRendererInterface | null
$blockClass string
Résultat League\CommonMark\Block\Renderer\BlockRendererInterface | null

getConfig() public méthode

public getConfig ( string | null $key = null, mixed $default = null ) : mixed
$key string | null
$default mixed
Résultat mixed

getDocumentProcessors() public méthode

public getDocumentProcessors ( ) : League\CommonMark\DocumentProcessorInterface[]
Résultat League\CommonMark\DocumentProcessorInterface[]

getExtensions() public méthode

Get all registered extensions
public getExtensions ( ) : League\CommonMark\Extension\ExtensionInterface[]
Résultat League\CommonMark\Extension\ExtensionInterface[]

getInlineParser() public méthode

public getInlineParser ( string $name ) : League\CommonMark\Inline\Parser\InlineParserInterface
$name string
Résultat League\CommonMark\Inline\Parser\InlineParserInterface

getInlineParserCharacterRegex() public méthode

This allows us to parse multiple non-special characters at once

getInlineParsers() public méthode

public getInlineParsers ( ) : League\CommonMark\Inline\Parser\InlineParserInterface[]
Résultat League\CommonMark\Inline\Parser\InlineParserInterface[]

getInlineParsersForCharacter() public méthode

public getInlineParsersForCharacter ( string $character ) : League\CommonMark\Inline\Parser\InlineParserInterface[] | null
$character string
Résultat League\CommonMark\Inline\Parser\InlineParserInterface[] | null

getInlineProcessors() public méthode

public getInlineProcessors ( ) : League\CommonMark\Inline\Processor\InlineProcessorInterface[]
Résultat League\CommonMark\Inline\Processor\InlineProcessorInterface[]

getInlineRendererForClass() public méthode

public getInlineRendererForClass ( string $inlineClass ) : League\CommonMark\Inline\Renderer\InlineRendererInterface | null
$inlineClass string
Résultat League\CommonMark\Inline\Renderer\InlineRendererInterface | null

initializeExtension() protected méthode

protected initializeExtension ( League\CommonMark\Extension\ExtensionInterface $extension )
$extension League\CommonMark\Extension\ExtensionInterface

initializeExtensions() protected méthode

protected initializeExtensions ( )

mergeConfig() public méthode

public mergeConfig ( array $config = [] )
$config array

setConfig() public méthode

public setConfig ( array $config = [] )
$config array

Property Details

$blockParsers protected_oe property

protected BlockParserInterface[],League\CommonMark\Block\Parser $blockParsers
Résultat League\CommonMark\Block\Parser\BlockParserInterface[]

$blockRenderersByClass protected_oe property

protected BlockRendererInterface[],League\CommonMark\Block\Renderer $blockRenderersByClass
Résultat League\CommonMark\Block\Renderer\BlockRendererInterface[]

$config protected_oe property

protected Configuration,League\CommonMark\Util $config
Résultat League\CommonMark\Util\Configuration

$documentProcessors protected_oe property

protected DocumentProcessorInterface[],League\CommonMark $documentProcessors
Résultat League\CommonMark\DocumentProcessorInterface[]

$extensions protected_oe property

protected ExtensionInterface[],League\CommonMark\Extension $extensions
Résultat League\CommonMark\Extension\ExtensionInterface[]

$extensionsInitialized protected_oe property

protected bool $extensionsInitialized
Résultat boolean

$inlineParserCharacterRegex protected_oe property

protected string $inlineParserCharacterRegex
Résultat string

$inlineParsers protected_oe property

protected InlineParserInterface[],League\CommonMark\Inline\Parser $inlineParsers
Résultat League\CommonMark\Inline\Parser\InlineParserInterface[]

$inlineParsersByCharacter protected_oe property

protected array $inlineParsersByCharacter
Résultat array

$inlineProcessors protected_oe property

protected InlineProcessorInterface[],League\CommonMark\Inline\Processor $inlineProcessors
Résultat League\CommonMark\Inline\Processor\InlineProcessorInterface[]

$inlineRenderersByClass protected_oe property

protected InlineRendererInterface[],League\CommonMark\Inline\Renderer $inlineRenderersByClass
Résultat League\CommonMark\Inline\Renderer\InlineRendererInterface[]