array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'commonmark-cql.invoke.php', 1 => 'CommonMark\\CQL::__invoke', 2 => 'CQL Execution', ), 'up' => array ( 0 => 'class.commonmark-cql.php', 1 => 'CommonMark\\CQL', ), 'prev' => array ( 0 => 'commonmark-cql.construct.php', 1 => 'CommonMark\\CQL::__construct', ), 'next' => array ( 0 => 'ref.cmark.php', 1 => 'CommonMark Functions', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/cmark/commonmark/cql/invoke.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

CommonMark\CQL::__invoke

(cmark >= 1.1.0)

CommonMark\CQL::__invoke — CQL Execution

Description

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

Shall invoke the current CQL function on the given root, executing the given handler on entry to a CommonMark\Node

Parameters

root
the root node of a tree
handler

should have the prototype:

handler(CommonMark\Node $root, CommonMark\Node $entering): ?bool
  • Should handler fail to return (void), or return 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