Copied!

Result object for starting parsing of a block; see static methods for constructors

CloneableFinal
Methods
public static abort() : self
 

Signal that the block parsing process should be aborted (no other block starts should be checked)

  • internal
public at(League\CommonMark\Parser\Cursor $cursor) : self
 

Signal that we want to parse at the given cursor position

  • return $this
public getBlockParsers() : iterable
 
  • return \BlockContinueParserInterface[]
public getCursorState() : ?League\CommonMark\Parser\CursorState
public isAborting() : bool
 
  • internal
public isReplaceActiveBlockParser() : bool
public static none() : ?self
 

Signal that we cannot parse whatever is here

  • return null
public static of(League\CommonMark\Parser\Block\BlockContinueParserInterface $blockParsers) : self
 

Signal that we'd like to register the given parser(s) so they can parse the current block

public replaceActiveBlockParser() : self
 

Signal that we want to replace the active block parser with this one

  • return $this
Properties
private array $blockParsers
 
  • var \BlockContinueParserInterface[]
  • psalm-readonly
private ?League\CommonMark\Parser\CursorState $cursorState = NULL
 
  • psalm-readonly-allow-private-mutation
private bool $isAborting = false
private bool $replaceActiveBlockParser = false
 
  • psalm-readonly-allow-private-mutation
Methods
private __construct(League\CommonMark\Parser\Block\BlockContinueParserInterface $blockParsers)
Methods
public static abort() : self
 

Signal that the block parsing process should be aborted (no other block starts should be checked)

  • internal
public static none() : ?self
 

Signal that we cannot parse whatever is here

  • return null
public static of(League\CommonMark\Parser\Block\BlockContinueParserInterface $blockParsers) : self
 

Signal that we'd like to register the given parser(s) so they can parse the current block

© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration