Book/cmark-Phpdoc专题
CommonMark
目录
- 简介
- 安装／配置
- CommonMark\Node\Document — Document concrete CommonMark\Node
- CommonMark\Node\Heading —
Heading concrete CommonMark\Node
- CommonMark\Node\Heading::__construct — Heading Construction
- CommonMark\Node\Paragraph — Paragraph concrete CommonMark\Node
- CommonMark\Node\BlockQuote — BlockQuote concrete CommonMark\Node
- CommonMark\Node\BulletList
— BulletList concrete CommonMark\Node
- CommonMark\Node\BulletList::__construct — BulletList Construction
- CommonMark\Node\OrderedList
— OrderedList concrete CommonMark\Node
- CommonMark\Node\OrderedList::__construct — OrderedList Construction
- CommonMark\Node\Item — Item concrete CommonMark\Node
- CommonMark\Node\Text — Text
concrete CommonMark\Node
- CommonMark\Node\Text::__construct — Text Construction
- CommonMark\Node\Text\Strong — Strong concrete CommonMark\Node
- CommonMark\Node\Text\Emphasis — Emphasis concrete CommonMark\Node
- CommonMark\Node\ThematicBreak — ThematicBreak concrete CommonMark\Node
- CommonMark\Node\SoftBreak — SoftBreak concrete CommonMark\Node
- CommonMark\Node\LineBreak — LineBreak concrete CommonMark\Node
- CommonMark\Node\Code — Code concrete CommonMark\Node
- CommonMark\Node\CodeBlock
— CodeBlock concrete CommonMark\Node
- CommonMark\Node\CodeBlock::__construct — CodeBlock Construction
- CommonMark\Node\HTMLBlock — HTMLBlock concrete CommonMark\Node
- CommonMark\Node\HTMLInline — HTMLInline concrete CommonMark\Node
- CommonMark\Node\Image — Image
concrete CommonMark\Node
- CommonMark\Node\Image::__construct — Image Construction
- CommonMark\Node\Link — Link
concrete CommonMark\Node
- CommonMark\Node\Link::__construct — Link Construction
- CommonMark\Node\CustomBlock — CustomBlock concrete CommonMark\Node
- CommonMark\Node\CustomInline — CustomInline concrete CommonMark\Node
- CommonMark\Node — Abstract
CommonMark\Node
- CommonMark\Node::appendChild — AST Manipulation
- CommonMark\Node::prependChild — AST Manipulation
- CommonMark\Node::insertAfter — AST Manipulation
- CommonMark\Node::insertBefore — AST Manipulation
- CommonMark\Node::replace — AST Manipulation
- CommonMark\Node::unlink — AST Manipulation
- CommonMark\Node::accept — Visitation
- CommonMark\Interfaces\IVisitor
— The CommonMark\Interfaces\IVisitor interface
- CommonMark\Interfaces\IVisitor::enter — Visitation
- CommonMark\Interfaces\IVisitor::leave — Visitation
- CommonMark\Interfaces\IVisitable
— The CommonMark\Interfaces\IVisitable interface
- CommonMark\Interfaces\IVisitable::accept — Visitation
- CommonMark\Parser — The
CommonMark\Parser class
- CommonMark\Parser::__construct — Parsing
- CommonMark\Parser::parse — Parsing
- CommonMark\Parser::finish — Parsing
- CommonMark\CQL — The CommonMark\CQL
class
- CommonMark\CQL::__construct — CQL Construction
- CommonMark\CQL::__invoke — CQL Execution
- CommonMark 函数
- CommonMark\Parse — Parsing
- CommonMark\Render — Rendering
- CommonMark\Render\HTML — Rendering
- CommonMark\Render\Latex — Rendering
- CommonMark\Render\Man — Rendering
- CommonMark\Render\XML — Rendering
类摘要
CommonMark\Node\Document
final class CommonMark\Node\Document <span class="modifier">extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
类摘要
CommonMark\Node\Heading
final class CommonMark\Node\Heading <span class="modifier">extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 属性 */
public int
$level ;
/* Constructor */
public <span class="methodname">__construct ( <span class="methodparam">void )
public <span
class="methodname">__construct ( <span
class="methodparam">int $level )
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
CommonMark\Node\Heading::__construct
Heading Construction
说明
public <span class="methodname">CommonMark\Node\Heading::__construct ( void )
public <span
class="methodname">CommonMark\Node\Heading::__construct (
int $level
)
Warning
本函数还未编写文档，仅有参数列表。
参数
此函数没有参数。
类摘要
CommonMark\Node\Paragraph
final class CommonMark\Node\Paragraph <span class="modifier">extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
类摘要
CommonMark\Node\BlockQuote
final class CommonMark\Node\BlockQuote <span class="modifier">extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
类摘要
CommonMark\Node\BulletList
final class CommonMark\Node\BulletList <span class="modifier">extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 属性 */
public bool
$tight ;
public int
$delimiter ;
/* Constructor */
public <span class="methodname">__construct ( <span class="methodparam">void )
public <span
class="methodname">__construct ( <span
class="methodparam">int $tight )
public <span
class="methodname">__construct ( <span
class="methodparam">int $tight ,
int
$delimiter )
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
CommonMark\Node\BulletList::__construct
BulletList Construction
说明
public <span class="methodname">CommonMark\Node\BulletList::__construct ( void )
public <span
class="methodname">CommonMark\Node\BulletList::__construct (
int $tight
)
public <span
class="methodname">CommonMark\Node\BulletList::__construct (
int $tight
, int
$delimiter )
Warning
本函数还未编写文档，仅有参数列表。
参数
此函数没有参数。
类摘要
CommonMark\Node\OrderedList
final class CommonMark\Node\OrderedList <span class="modifier">extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 属性 */
public bool
$tight ;
public int
$delimiter ;
public int
$start ;
/* Constructor */
public <span class="methodname">__construct ( <span class="methodparam">void )
public <span
class="methodname">__construct ( <span
class="methodparam">int $tight )
public <span
class="methodname">__construct ( <span
class="methodparam">int $tight ,
int
$delimiter )
public <span
class="methodname">__construct ( <span
class="methodparam">int $tight ,
int
$delimiter , <span
class="type">int $start )
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
CommonMark\Node\OrderedList::__construct
OrderedList Construction
说明
public <span class="methodname">CommonMark\Node\OrderedList::__construct ( void )
public <span
class="methodname">CommonMark\Node\OrderedList::__construct (
int $tight
)
public <span
class="methodname">CommonMark\Node\OrderedList::__construct (
int $tight
, int
$delimiter )
public <span
class="methodname">CommonMark\Node\OrderedList::__construct (
int $tight
, int
$delimiter , <span
class="type">int $start )
Warning
本函数还未编写文档，仅有参数列表。
参数
tight
delimiter
start
类摘要
CommonMark\Node\Item
final class CommonMark\Node\Item <span class="modifier">extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
类摘要
CommonMark\Node\Text
final class CommonMark\Node\Text <span class="modifier">extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 属性 */
public <span
class="type">stringnull
$literal ;
/* Constructor */
public <span class="methodname">__construct ( <span class="methodparam">void )
public <span
class="methodname">__construct ( <span
class="methodparam">string $literal )
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
CommonMark\Node\Text::__construct
Text Construction
说明
public <span class="methodname">CommonMark\Node\Text::__construct ( <span class="methodparam">void )
public <span
class="methodname">CommonMark\Node\Text::__construct ( <span
class="methodparam">string $literal )
Warning
本函数还未编写文档，仅有参数列表。
参数
literal
类摘要
CommonMark\Node\Text\Strong
final class CommonMark\Node\Text\Strong <span class="modifier">extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
类摘要
CommonMark\Node\Text\Emphasis
final class CommonMark\Node\Text\Emphasis extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
类摘要
CommonMark\Node\ThematicBreak
final class CommonMark\Node\ThematicBreak <span class="modifier">extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
类摘要
CommonMark\Node\SoftBreak
final class CommonMark\Node\SoftBreak <span class="modifier">extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
类摘要
CommonMark\Node\LineBreak
final class CommonMark\Node\LineBreak <span class="modifier">extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
类摘要
CommonMark\Node\Code
final class CommonMark\Node\Code <span class="modifier">extends CommonMark\Node\Text <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
public <span
class="type">stringnull
$literal ;
/* Constructor */
public <span class="methodname">CommonMark\Node\Text::__construct ( <span class="methodparam">void )
public <span
class="methodname">CommonMark\Node\Text::__construct ( <span
class="methodparam">string $literal )
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
类摘要
CommonMark\Node\CodeBlock
final class CommonMark\Node\CodeBlock <span class="modifier">extends CommonMark\Node\Text <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
public <span
class="type">stringnull
$literal ;
/* 属性 */
public <span
class="type">stringnull $fence
;
/* Constructor */
public <span class="methodname">CommonMark\Node\Text::__construct ( <span class="methodparam">void )
public <span
class="methodname">CommonMark\Node\Text::__construct ( <span
class="methodparam">string $literal )
public <span
class="methodname">__construct ( <span
class="methodparam">string $fence ,
string
$literal )
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
CommonMark\Node\CodeBlock::__construct
CodeBlock Construction
说明
public <span
class="methodname">CommonMark\Node\CodeBlock::__construct (
string
$fence , <span
class="type">string $literal )
Warning
本函数还未编写文档，仅有参数列表。
参数
fence
literal
类摘要
CommonMark\Node\HTMLBlock
final class CommonMark\Node\HTMLBlock <span class="modifier">extends CommonMark\Node\Text <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
public <span
class="type">stringnull
$literal ;
/* Constructor */
public <span class="methodname">CommonMark\Node\Text::__construct ( <span class="methodparam">void )
public <span
class="methodname">CommonMark\Node\Text::__construct ( <span
class="methodparam">string $literal )
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
类摘要
CommonMark\Node\HTMLInline
final class CommonMark\Node\HTMLInline <span class="modifier">extends CommonMark\Node\Text <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
public <span
class="type">stringnull
$literal ;
/* Constructor */
public <span class="methodname">CommonMark\Node\Text::__construct ( <span class="methodparam">void )
public <span
class="methodname">CommonMark\Node\Text::__construct ( <span
class="methodparam">string $literal )
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
类摘要
CommonMark\Node\Image
final class CommonMark\Node\Image <span class="modifier">extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 属性 */
public <span
class="type">stringnull $url ;
public <span
class="type">stringnull $title
;
/* Constructor */
public <span class="methodname">__construct ( <span class="methodparam">void )
public <span
class="methodname">__construct ( <span
class="methodparam">string $url )
public <span
class="methodname">__construct ( <span
class="methodparam">string $url ,
string
$title )
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
CommonMark\Node\Image::__construct
Image Construction
说明
public <span class="methodname">CommonMark\Node\Image::__construct ( <span class="methodparam">void )
public <span
class="methodname">CommonMark\Node\Image::__construct ( <span
class="methodparam">string $url )
public <span
class="methodname">CommonMark\Node\Image::__construct ( <span
class="methodparam">string $url ,
string
$title )
Warning
本函数还未编写文档，仅有参数列表。
参数
url
title
类摘要
CommonMark\Node\Link
final class CommonMark\Node\Link <span class="modifier">extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 属性 */
public <span
class="type">stringnull $url ;
public <span
class="type">stringnull $title
;
/* Constructor */
public <span class="methodname">__construct ( <span class="methodparam">void )
public <span
class="methodname">__construct ( <span
class="methodparam">string $url )
public <span
class="methodname">__construct ( <span
class="methodparam">string $url ,
string
$title )
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
CommonMark\Node\Link::__construct
Link Construction
说明
public <span class="methodname">CommonMark\Node\Link::__construct ( <span class="methodparam">void )
public <span
class="methodname">CommonMark\Node\Link::__construct ( <span
class="methodparam">string $url )
public <span
class="methodname">CommonMark\Node\Link::__construct ( <span
class="methodparam">string $url ,
string
$title )
Warning
本函数还未编写文档，仅有参数列表。
参数
url
title
类摘要
CommonMark\Node\CustomBlock
final class CommonMark\Node\CustomBlock <span class="modifier">extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 属性 */
public <span
class="type">stringnull
$onEnter ;
public <span
class="type">stringnull
$onLeave ;
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
类摘要
CommonMark\Node\CustomInline
final class CommonMark\Node\CustomInline <span class="modifier">extends CommonMark\Node <span class="oointerface">implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 继承的属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 属性 */
public <span
class="type">stringnull
$onEnter ;
public <span
class="type">stringnull
$onLeave ;
/* 继承的方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
public void CommonMark\Node::unlink ( <span class="methodparam">void )
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
简介
Represents an Abstract Node, this final abstract is not for direct use by the programmer.
类摘要
CommonMark\Node
final <span class="modifier">abstract class CommonMark\Node implements <span class="interfacename">CommonMark\Interfaces\IVisitable , <span class="interfacename">Traversable {
/* 属性 */
public <span
class="modifier">readonly <span
class="type">Nodenull $parent
;
public <span
class="modifier">readonly <span
class="type">Nodenull
$previous ;
public <span
class="modifier">readonly <span
class="type">Nodenull $next ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$lastChild ;
public <span
class="modifier">readonly <span
class="type">Nodenull
$firstChild ;
public <span
class="modifier">readonly int
$startLine ;
public <span
class="modifier">readonly int
$endLine ;
public <span
class="modifier">readonly int
$startColumn ;
public <span
class="modifier">readonly int
$endColumn ;
/* 方法 */
public <span
class="type">CommonMark\Node <span
class="methodname">appendChild ( <span
class="type">CommonMark\Node $child )
public <span
class="type">CommonMark\Node <span
class="methodname">prependChild ( <span
class="type">CommonMark\Node $child )
public <span
class="type">CommonMark\Node <span
class="methodname">insertAfter ( <span
class="type">CommonMark\Node $sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">insertBefore ( <span
class="type">CommonMark\Node $sibling )
public <span
class="type">CommonMark\Node <span
class="methodname">replace ( <span
class="type">CommonMark\Node $target )
public void unlink ( <span class="methodparam">void )
public void
accept ( <span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
CommonMark\Node::appendChild
AST Manipulation
说明
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::appendChild ( <span
class="methodparam">CommonMark\Node
$child )
Warning
本函数还未编写文档，仅有参数列表。
参数
child
返回值
CommonMark\Node::prependChild
AST Manipulation
说明
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::prependChild ( <span
class="methodparam">CommonMark\Node
$child )
Warning
本函数还未编写文档，仅有参数列表。
参数
child
返回值
CommonMark\Node::insertAfter
AST Manipulation
说明
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertAfter ( <span
class="methodparam">CommonMark\Node
$sibling )
Warning
本函数还未编写文档，仅有参数列表。
参数
sibling
返回值
CommonMark\Node::insertBefore
AST Manipulation
说明
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::insertBefore ( <span
class="methodparam">CommonMark\Node
$sibling )
Warning
本函数还未编写文档，仅有参数列表。
参数
sibling
返回值
CommonMark\Node::replace
AST Manipulation
说明
public <span
class="type">CommonMark\Node <span
class="methodname">CommonMark\Node::replace ( <span
class="methodparam">CommonMark\Node
$target )
Warning
本函数还未编写文档，仅有参数列表。
参数
target
返回值
CommonMark\Node::unlink
AST Manipulation
说明
public void CommonMark\Node::unlink ( <span class="methodparam">void )
Warning
本函数还未编写文档，仅有参数列表。
参数
此函数没有参数。
返回值
CommonMark\Node::accept
Visitation
说明
public void
CommonMark\Node::accept ( <span
class="methodparam"><span
class="type">CommonMark\Interfaces\IVisitor $visitor )
参数
visitor
An object implementing <span
class="classname">CommonMark\Interfaces\IVisitor
参见
简介
类摘要
CommonMark\Interfaces\IVisitor
final class CommonMark\Interfaces\IVisitor {
/* Constants */
const int
CommonMark\Interfaces\IVisitor::Done ;
const int
CommonMark\Interfaces\IVisitor::Enter ;
const int
CommonMark\Interfaces\IVisitor::Leave ;
/* 方法 */
abstract <span
class="modifier">public <span
class="type">intIVisitable<span
class="type">null enter (
IVisitable
$visitable )
abstract <span
class="modifier">public <span
class="type">intIVisitable<span
class="type">null leave (
IVisitable
$visitable )
}
CommonMark\Interfaces\IVisitor::enter
Visitation
说明
abstract <span
class="modifier">public <span
class="type">intIVisitable<span
class="type">null <span
class="methodname">CommonMark\Interfaces\IVisitor::enter (
IVisitable
$visitable )
参数
visitable
The current <span
class="classname">CommonMark\Interfaces\IVisitable being
entered
返回值
Returning CommonMark\Interfaces\IVisitor::Done will cause the backing
iterator to exit.
Returning CommonMark\Interfaces\IVisitor::Enter will reset the backing
iterator at entering the current <span
class="classname">IVisitable
Returning CommonMark\Interfaces\IVisitor::Leave will reset the backing
iterator at exiting the current <span
class="classname">IVisitable
Returning an IVisitable will reset the backing iterator at entering the given <span class="classname">IVisitable
Returning nothing will allow the backing iterator to continue
参见
CommonMark\Interfaces\IVisitor::leave
Visitation
说明
abstract <span
class="modifier">public <span
class="type">intIVisitable<span
class="type">null <span
class="methodname">CommonMark\Interfaces\IVisitor::leave (
IVisitable
$visitable )
参数
visitable
The current <span
class="classname">CommonMark\Interfaces\IVisitable being exited
返回值
Returning CommonMark\Interfaces\IVisitor::Done will cause the backing
iterator to exit.
Returning CommonMark\Interfaces\IVisitor::Enter will reset the backing
iterator at entering the current <span
class="classname">IVisitable
Returning CommonMark\Interfaces\IVisitor::Leave will reset the backing
iterator at exiting the current <span
class="classname">IVisitable
Returning an IVisitable will reset the backing iterator at exiting the given <span class="classname">IVisitable
Returning nothing will allow the backing iterator to continue
参见
简介
类摘要
CommonMark\Interfaces\IVisitable
final class CommonMark\Interfaces\IVisitable {
abstract <span
class="modifier">public void <span
class="methodname">accept ( <span
class="type">CommonMark\Interfaces\IVisitor $visitor )
}
CommonMark\Interfaces\IVisitable::accept
Visitation
说明
abstract <span
class="modifier">public void <span
class="methodname">CommonMark\Interfaces\IVisitable::accept (
<span
class="type">CommonMark\Interfaces\IVisitor $visitor )
参数
visitor
An object implementing <span
class="classname">CommonMark\Interfaces\IVisitor
参见
简介
Provides an incremental parser as an alternative to the simple Parsing API function
类摘要
CommonMark\Parser
final class CommonMark\Parser {
/* Constructor */
public <span
class="methodname">__construct ([ <span
class="methodparam">int $options ] )
/* 方法 */
public void
parse ( <span
class="type">string $buffer )
public <span class="type">CommonMark\Node <span class="methodname">finish ( void )
}
CommonMark\Parser::__construct
Parsing
说明
public <span
class="methodname">CommonMark\Parser::__construct ([ <span
class="methodparam">int $options ] )
Warning
本函数还未编写文档，仅有参数列表。
参数
options
A mask of:
CommonMark\Parser\Normal (int)
CommonMark\Parser\Normalize (int)
CommonMark\Parser\ValidateUTF8 (int)
CommonMark\Parser\Smart (int)
CommonMark\Parser::parse
Parsing
说明
public void
CommonMark\Parser::parse ( <span
class="methodparam">string $buffer )
Warning
本函数还未编写文档，仅有参数列表。
参数
buffer
返回值
CommonMark\Parser::finish
Parsing
说明
public <span class="type">CommonMark\Node <span class="methodname">CommonMark\Parser::finish ( <span class="methodparam">void )
Warning
本函数还未编写文档，仅有参数列表。
参数
此函数没有参数。
返回值
简介
CommonMark Query Language is a DSL for describing how to travel through a CommonMark Node tree implemented as a parser and compiler for a small set of instructions, and a virtual machine for executing those instructions.
Paths:
In it's most simplistic form, a CQL query combines the following paths and / to describe how to travel through a tree:
- firstChild
- lastChild
- previous
- next
- parent
For example, /firstChild/lastChild would travel to the last child node of the first child node.
Loops
CQL can be instructed to loop, for example through the children of, or siblings to a particular node, by using the path children, or siblings. For example, /firstChild/children will travel to all the children of the first child node.
Subqueries
CQL can be instructed how to travel by using a subquery like [/firstChild]. For example, /firstChild/children[/firstChild] will travel to the first child node of all the children of the first child node.
Loop Constraints
While looping, CQL can be instructed to constrict the travelled path to nodes of particular type. For example /children(BlockQuote) will travel to the children of a node where the type is BlockQuote. The following types are recognized (case insensitively):
- BlockQuote
- List
- Item
- CodeBlock
- HtmlBlock
- CustomBlock
- Paragraph
- Heading
- ThematicBreak
- Text
- SoftBreak
- LineBreak
- Code
- HtmlInline
- CustomInline
- Emphasis
- Strong
- Link
- Image
Types may be used as a union, for example /children(BlockQuote|List) will travel to the children of a node where the type is BlockQuote or List. Types, or unions of types, may be also negated. For example /children(~BlockQuote) will travel to the children of a node where the type is not BlockQuote, and /children(~BlockQuote|Paragraph) will travel to the children of a node where the type is not BlockQuote or Paragraph
Path Constraints
CQL can be instructed to create a loop to travel to a node of a particular type, at a particular path. For example, /firstChild(BlockQuote) will travel to the first child node where the type is BlockQuote. Note that like other loops for children and siblings, this kind of path can only be followed by a subquery.
Implementation Notes
While CQL has been implemented as part of the PHP CommonMark extension, it stands separately from PHP and does not use PHP's virtual machine or internal representation of values.
类摘要
CommonMark\CQL
class CommonMark\CQL {
/* Constructor */
public <span
class="methodname">__construct ( <span
class="methodparam">string $query )
/* 方法 */
public <span
class="methodname">__invoke ( <span
class="type">CommonMark\Node $root , <span
class="methodparam">callable $handler
)
}
CommonMark\CQL::__construct
CQL Construction
说明
public <span
class="methodname">CommonMark\CQL::__construct ( <span
class="methodparam">string $query )
参数
query
a CQL string
CommonMark\CQL::__invoke
CQL Execution
说明
public <span
class="methodname">CommonMark\CQL::__invoke ( <span
class="methodparam">CommonMark\Node
$root , <span
class="type">callable $handler )
Shall invoke the current CQL function on the given root, executing the
given handler on entry to a CommonMark\Node
参数
root
the root node of a tree
handler
should have the prototype:
bool<span
class="type">null handler
( CommonMark\Node
$root , <span
class="type">CommonMark\Node $entering )
- Should
handlerfail to return (void), or return <span class="type">null, CQL will continue executing - Should the handler return a truthy value, CQL will continue executing.
- Should the handler return a falsy value, CQL will stop executing