テキスト処理
PHP マニュアル

CommonMark

目次

Document concrete CommonMark\Node

クラス概要

CommonMark\Node\Document
final class CommonMark\Node\Document extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

Heading concrete CommonMark\Node

クラス概要

CommonMark\Node\Heading
final class CommonMark\Node\Heading extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* プロパティ */
public int $level;
/* Constructor */
public __construct()
public __construct(int $level)
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

Paragraph concrete CommonMark\Node

クラス概要

CommonMark\Node\Paragraph
final class CommonMark\Node\Paragraph extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

BlockQuote concrete CommonMark\Node

クラス概要

CommonMark\Node\BlockQuote
final class CommonMark\Node\BlockQuote extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

BulletList concrete CommonMark\Node

クラス概要

CommonMark\Node\BulletList
final class CommonMark\Node\BulletList extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* プロパティ */
public bool $tight;
public int $delimiter;
/* Constructor */
public __construct()
public __construct(int $tight)
public __construct(int $tight, int $delimiter)
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

OrderedList concrete CommonMark\Node

クラス概要

CommonMark\Node\OrderedList
final class CommonMark\Node\OrderedList extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* プロパティ */
public bool $tight;
public int $delimiter;
public int $start;
/* Constructor */
public __construct()
public __construct(int $tight)
public __construct(int $tight, int $delimiter)
public __construct(int $tight, int $delimiter, int $start)
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

Item concrete CommonMark\Node

クラス概要

CommonMark\Node\Item
final class CommonMark\Node\Item extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

Text concrete CommonMark\Node

クラス概要

CommonMark\Node\Text
final class CommonMark\Node\Text extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* プロパティ */
public stringnull $literal;
/* Constructor */
public __construct()
public __construct(string $literal)
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

Strong concrete CommonMark\Node

クラス概要

CommonMark\Node\Text\Strong
final class CommonMark\Node\Text\Strong extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

Emphasis concrete CommonMark\Node

クラス概要

CommonMark\Node\Text\Emphasis
final class CommonMark\Node\Text\Emphasis extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

ThematicBreak concrete CommonMark\Node

クラス概要

CommonMark\Node\ThematicBreak
final class CommonMark\Node\ThematicBreak extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

SoftBreak concrete CommonMark\Node

クラス概要

CommonMark\Node\SoftBreak
final class CommonMark\Node\SoftBreak extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

LineBreak concrete CommonMark\Node

クラス概要

CommonMark\Node\LineBreak
final class CommonMark\Node\LineBreak extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

Code concrete CommonMark\Node

クラス概要

CommonMark\Node\Code
final class CommonMark\Node\Code extends CommonMark\Node\Text implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
public stringnull $literal;
/* Constructor */
public CommonMark\Node\Text::__construct()
public CommonMark\Node\Text::__construct(string $literal)
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

CodeBlock concrete CommonMark\Node

クラス概要

CommonMark\Node\CodeBlock
final class CommonMark\Node\CodeBlock extends CommonMark\Node\Text implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
public stringnull $literal;
/* プロパティ */
public stringnull $fence;
/* Constructor */
public CommonMark\Node\Text::__construct()
public CommonMark\Node\Text::__construct(string $literal)
public __construct(string $fence, string $literal)
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

HTMLBlock concrete CommonMark\Node

クラス概要

CommonMark\Node\HTMLBlock
final class CommonMark\Node\HTMLBlock extends CommonMark\Node\Text implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
public stringnull $literal;
/* Constructor */
public CommonMark\Node\Text::__construct()
public CommonMark\Node\Text::__construct(string $literal)
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

HTMLInline concrete CommonMark\Node

クラス概要

CommonMark\Node\HTMLInline
final class CommonMark\Node\HTMLInline extends CommonMark\Node\Text implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
public stringnull $literal;
/* Constructor */
public CommonMark\Node\Text::__construct()
public CommonMark\Node\Text::__construct(string $literal)
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

Image concrete CommonMark\Node

クラス概要

CommonMark\Node\Image
final class CommonMark\Node\Image extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* プロパティ */
public stringnull $url;
public stringnull $title;
/* Constructor */
public __construct()
public __construct(string $url)
public __construct(string $url, string $title)
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

Link concrete CommonMark\Node

クラス概要

CommonMark\Node\Link
final class CommonMark\Node\Link extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* プロパティ */
public stringnull $url;
public stringnull $title;
/* Constructor */
public __construct()
public __construct(string $url)
public __construct(string $url, string $title)
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

CustomBlock concrete CommonMark\Node

クラス概要

CommonMark\Node\CustomBlock
final class CommonMark\Node\CustomBlock extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* プロパティ */
public stringnull $onEnter;
public stringnull $onLeave;
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

CustomInline concrete CommonMark\Node

クラス概要

CommonMark\Node\CustomInline
final class CommonMark\Node\CustomInline extends CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* 継承したプロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* プロパティ */
public stringnull $onEnter;
public stringnull $onLeave;
/* 継承したメソッド */
public CommonMark\Node CommonMark\Node::appendChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::prependChild(CommonMark\Node $child)
public CommonMark\Node CommonMark\Node::insertAfter(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::insertBefore(CommonMark\Node $sibling)
public CommonMark\Node CommonMark\Node::replace(CommonMark\Node $target)
public void CommonMark\Node::unlink()
public void CommonMark\Node::accept(CommonMark\Interfaces\IVisitor $visitor)
}

Abstract CommonMark\Node

はじめに

Represents an Abstract Node, this final abstract is not for direct use by the programmer.

クラス概要

CommonMark\Node
final abstract class CommonMark\Node implements CommonMark\Interfaces\IVisitable, Traversable {
/* プロパティ */
public readonly Nodenull $parent;
public readonly Nodenull $previous;
public readonly Nodenull $next;
public readonly Nodenull $lastChild;
public readonly Nodenull $firstChild;
public readonly int $startLine;
public readonly int $endLine;
public readonly int $startColumn;
public readonly int $endColumn;
/* メソッド */
public CommonMark\Node appendChild(CommonMark\Node $child)
public CommonMark\Node prependChild(CommonMark\Node $child)
public CommonMark\Node insertAfter(CommonMark\Node $sibling)
public CommonMark\Node insertBefore(CommonMark\Node $sibling)
public CommonMark\Node replace(CommonMark\Node $target)
public void unlink()
public void accept(CommonMark\Interfaces\IVisitor $visitor)
}

The CommonMark\Interfaces\IVisitor interface

はじめに

クラス概要

CommonMark\Interfaces\IVisitor
final class CommonMark\Interfaces\IVisitor {
/* 定数 */
const int CommonMark\Interfaces\IVisitor::Done;
const int CommonMark\Interfaces\IVisitor::Enter;
const int CommonMark\Interfaces\IVisitor::Leave;
/* メソッド */
abstract public intIVisitablenull enter(IVisitable $visitable)
abstract public intIVisitablenull leave(IVisitable $visitable)
}

The CommonMark\Interfaces\IVisitable interface

はじめに

クラス概要

CommonMark\Interfaces\IVisitable
final class CommonMark\Interfaces\IVisitable {
abstract public void accept(CommonMark\Interfaces\IVisitor $visitor)
}

The CommonMark\Parser class

はじめに

Provides an incremental parser as an alternative to the simple Parsing API function

クラス概要

CommonMark\Parser
final class CommonMark\Parser {
/* Constructor */
public __construct(int $options = ?)
/* メソッド */
public void parse(string $buffer)
public CommonMark\Node finish()
}

The CommonMark\CQL class

はじめに

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 __construct(string $query)
/* メソッド */
public __invoke(CommonMark\Node $root, callable $handler)
}