The CommonMark\CQL class

(cmark >= 1.1.0)

简介

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 {

/* Constructor */

public __construct ( string $query )

/* 方法 */

public __invoke ( \CommonMark\Node $root , callable $handler )

}

php cairo the cairofillrule class php cairo the cairooperator class php cairo the cairosvgversion class php commonmark the commonmark cql class php commonmark custominline concrete commonmark node php commonmark abstract commonmark node php commonmark the commonmark parser class php dom the domnode class php data structures the stack class php event the eventhttprequest class php gmagick the gmagick class php imagemagick the imagick class php 异常 the invalidargumentexception class php 迭代器 the limititerator class php exceptions the mongocursorexception class php mongodb bson the mongodb bson objectid class php mongodb driver the mongodb driver cursor class php mongodb driver monitoring the mongodb driver monitoring commandstartedevent class php commonmark cql cql construction php commonmark cql cql execution