PHP Класс League\CommonMark\Block\Element\AbstractBlock

Наследование: extends League\CommonMark\Node\Node
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$data array Used for storage of arbitrary data.

Защищенные свойства (Protected)

Свойство Тип Описание
$endLine integer
$finalStringContents string
$lastLineBlank boolean
$open boolean
$startLine integer
$strings League\CommonMark\Util\ArrayCollection | string[]

Открытые методы

Метод Описание
__construct ( ) Constructor
acceptsLines ( ) : boolean Returns true if block type can accept lines of text
addLine ( string $line )
canContain ( AbstractBlock $block ) : boolean Returns true if this block can contain the given block as a child node
endsWithBlankLine ( ) : boolean Whether the block ends with a blank line
finalize ( League\CommonMark\ContextInterface $context, integer $endLineNumber ) Finalize the block; mark it closed for modification
getData ( string $key, mixed $default = null ) : mixed
getEndLine ( ) : integer
getStartLine ( ) : integer
getStringContent ( ) : string
getStrings ( ) : string[]
handleRemainingContents ( League\CommonMark\ContextInterface $context, Cursor $cursor )
hasChildren ( ) : boolean
isCode ( ) : boolean Whether this is a code block
isContainer ( ) : boolean
isOpen ( ) : boolean Whether the block is open for modifications
matchesNextLine ( Cursor $cursor ) : boolean
setEndLine ( $endLine )
setLastLineBlank ( boolean $blank )
setStartLine ( integer $startLine )
shouldLastLineBeBlank ( Cursor $cursor, integer $currentLineNumber ) : boolean Determines whether the last line should be marked as blank

Защищенные методы

Метод Описание
setParent ( League\CommonMark\Node\Node $node = null )

Описание методов

__construct() публичный Метод

Constructor
public __construct ( )

acceptsLines() абстрактный публичный Метод

Returns true if block type can accept lines of text
abstract public acceptsLines ( ) : boolean
Результат boolean

addLine() публичный Метод

public addLine ( string $line )
$line string

canContain() абстрактный публичный Метод

Returns true if this block can contain the given block as a child node
abstract public canContain ( AbstractBlock $block ) : boolean
$block AbstractBlock
Результат boolean

endsWithBlankLine() публичный Метод

Whether the block ends with a blank line
public endsWithBlankLine ( ) : boolean
Результат boolean

finalize() публичный Метод

Finalize the block; mark it closed for modification
public finalize ( League\CommonMark\ContextInterface $context, integer $endLineNumber )
$context League\CommonMark\ContextInterface
$endLineNumber integer

getData() публичный Метод

public getData ( string $key, mixed $default = null ) : mixed
$key string
$default mixed
Результат mixed

getEndLine() публичный Метод

public getEndLine ( ) : integer
Результат integer

getStartLine() публичный Метод

public getStartLine ( ) : integer
Результат integer

getStringContent() публичный Метод

public getStringContent ( ) : string
Результат string

getStrings() публичный Метод

public getStrings ( ) : string[]
Результат string[]

handleRemainingContents() публичный Метод

public handleRemainingContents ( League\CommonMark\ContextInterface $context, Cursor $cursor )
$context League\CommonMark\ContextInterface
$cursor League\CommonMark\Cursor

hasChildren() публичный Метод

public hasChildren ( ) : boolean
Результат boolean

isCode() абстрактный публичный Метод

Whether this is a code block
abstract public isCode ( ) : boolean
Результат boolean

isContainer() публичный Метод

public isContainer ( ) : boolean
Результат boolean

isOpen() публичный Метод

Whether the block is open for modifications
public isOpen ( ) : boolean
Результат boolean

matchesNextLine() абстрактный публичный Метод

abstract public matchesNextLine ( Cursor $cursor ) : boolean
$cursor League\CommonMark\Cursor
Результат boolean

setEndLine() публичный Метод

public setEndLine ( $endLine )

setLastLineBlank() публичный Метод

public setLastLineBlank ( boolean $blank )
$blank boolean

setParent() защищенный Метод

protected setParent ( League\CommonMark\Node\Node $node = null )
$node League\CommonMark\Node\Node

setStartLine() публичный Метод

public setStartLine ( integer $startLine )
$startLine integer

shouldLastLineBeBlank() публичный Метод

Determines whether the last line should be marked as blank
public shouldLastLineBeBlank ( Cursor $cursor, integer $currentLineNumber ) : boolean
$cursor League\CommonMark\Cursor
$currentLineNumber integer
Результат boolean

Описание свойств

$data публичное свойство

Used for storage of arbitrary data.
public array $data
Результат array

$endLine защищенное свойство

protected int $endLine
Результат integer

$finalStringContents защищенное свойство

protected string $finalStringContents
Результат string

$lastLineBlank защищенное свойство

protected bool $lastLineBlank
Результат boolean

$open защищенное свойство

protected bool $open
Результат boolean

$startLine защищенное свойство

protected int $startLine
Результат integer

$strings защищенное свойство

protected ArrayCollection,League\CommonMark\Util|string[] $strings
Результат League\CommonMark\Util\ArrayCollection | string[]