<!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>Visitation</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.commonmark-interfaces-ivisitor.html">CommonMark\Interfaces\IVisitor</a></div>
<div class="next" style="text-align: right; float: right;"><a href="commonmark-interfaces-ivisitor.leave.html">CommonMark\Interfaces\IVisitor::leave</a></div>
<div class="up"><a href="class.commonmark-interfaces-ivisitor.html">CommonMark\Interfaces\IVisitor</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="commonmark-interfaces-ivisitor.enter" class="refentry">
<div class="refnamediv">
<h1 class="refname">CommonMark\Interfaces\IVisitor::enter</h1>
<p class="verinfo">(cmark >= 1.0.0)</p><p class="refpurpose"><span class="refname">CommonMark\Interfaces\IVisitor::enter</span> — <span class="dc-title">Visitation</span></p>
</div>
<div class="refsect1 description" id="refsect1-commonmark-interfaces-ivisitor.enter-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type"><span class="type ?int|IVisitable">?int|IVisitable</span></span> <span class="methodname"><strong>CommonMark\Interfaces\IVisitor::enter</strong></span>
( <span class="methodparam"><span class="type"><span class="type IVisitable">IVisitable</span></span> <code class="parameter">$visitable</code></span>
)</div>
</div>
<div class="refsect1 parameters" id="refsect1-commonmark-interfaces-ivisitor.enter-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">visitable</code></dt>
<dd>
<p class="para">
The current <a href="class.commonmark-interfaces-ivisitable.html" class="classname">CommonMark\Interfaces\IVisitable</a> being entered
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-commonmark-interfaces-ivisitor.enter-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returning <var class="varname"><var class="varname">CommonMark\Interfaces\IVisitor::Done</var></var> will cause the backing iterator to exit.
</p>
<p class="para">
Returning <var class="varname"><var class="varname">CommonMark\Interfaces\IVisitor::Enter</var></var> will reset the backing iterator at entering the current <strong class="classname">IVisitable</strong>
</p>
<p class="para">
Returning <var class="varname"><var class="varname">CommonMark\Interfaces\IVisitor::Leave</var></var> will reset the backing iterator at exiting the current <strong class="classname">IVisitable</strong>
</p>
<p class="para">
Returning an <strong class="classname">IVisitable</strong> will reset the backing iterator at entering the given <strong class="classname">IVisitable</strong>
</p>
<p class="para">
Returning nothing will allow the backing iterator to continue
</p>
</div>
<div class="refsect1 seealso" id="refsect1-commonmark-interfaces-ivisitor.enter-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><a href="commonmark-interfaces-ivisitable.accept.html" class="xref">CommonMark\Interfaces\IVisitable::accept</a></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.commonmark-interfaces-ivisitor.html">CommonMark\Interfaces\IVisitor</a></div>
<div class="next" style="text-align: right; float: right;"><a href="commonmark-interfaces-ivisitor.leave.html">CommonMark\Interfaces\IVisitor::leave</a></div>
<div class="up"><a href="class.commonmark-interfaces-ivisitor.html">CommonMark\Interfaces\IVisitor</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
