<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>CQL Execution</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="commonmark-cql.construct.html">CommonMark\CQL::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ref.cmark.html">CommonMark Functions</a></div>
<div class="up"><a href="class.commonmark-cql.html">CommonMark\CQL</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="commonmark-cql.invoke" class="refentry">
<div class="refnamediv">
<h1 class="refname">CommonMark\CQL::__invoke</h1>
<p class="verinfo">(cmark >= 1.1.0)</p><p class="refpurpose"><span class="refname">CommonMark\CQL::__invoke</span> — <span class="dc-title">CQL Execution</span></p>
</div>
<div class="refsect1 description" id="refsect1-commonmark-cql.invoke-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><strong>CommonMark\CQL::__invoke</strong></span>
( <span class="methodparam"><span class="type"><span class="type \CommonMark\Node">\CommonMark\Node</span></span> <code class="parameter">$root</code></span>
, <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$handler</code></span>
)</div>
<p class="para rdfs-comment">
Shall invoke the current CQL function on the given <code class="parameter">root</code>,
executing the given <code class="parameter">handler</code> on entry to a <span class="type"><span class="type \CommonMark\Node">\CommonMark\Node</span></span>
</p>
</div>
<div class="refsect1 parameters" id="refsect1-commonmark-cql.invoke-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">root</code></dt>
<dd>
<p class="para">the root node of a tree</p>
</dd>
<dt>
<code class="parameter">handler</code></dt>
<dd>
<p class="para">
should have the prototype:
<div class="methodsynopsis dc-description">
<span class="type"><span class="type ?bool">?bool</span></span> <span class="methodname"><strong>handler</strong></span>
( <span class="methodparam"><span class="type"><span class="type \CommonMark\Node">\CommonMark\Node</span></span> <code class="parameter">$root</code></span>
, <span class="methodparam"><span class="type"><span class="type \CommonMark\Node">\CommonMark\Node</span></span> <code class="parameter">$entering</code></span>
)</div>
<ul class="simplelist">
<li class="member">Should <code class="parameter">handler</code> fail to return (void), or return <span class="type"><a href="language.types.null.html" class="type null">null</a></span>, CQL will continue executing</li>
<li class="member">Should the handler return a truthy value, CQL will continue executing.</li>
<li class="member">Should the handler return a falsy value, CQL will stop executing</li>
</ul>
</p>
</dd>
</dl>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="commonmark-cql.construct.html">CommonMark\CQL::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ref.cmark.html">CommonMark Functions</a></div>
<div class="up"><a href="class.commonmark-cql.html">CommonMark\CQL</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
