mirror of
https://github.com/php/doc-en.git
synced 2026-03-23 23:32:18 +01:00
80 lines
2.5 KiB
XML
80 lines
2.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="commonmark-interfaces-ivisitor.enter">
|
|
<refnamediv>
|
|
<refname>CommonMark\Interfaces\IVisitor::enter</refname>
|
|
<refpurpose>Visitation</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>abstract</modifier> <modifier>public</modifier> <type class="union"><type>int</type><type>IVisitable</type><type>null</type></type><methodname>CommonMark\Interfaces\IVisitor::enter</methodname>
|
|
<methodparam><type>IVisitable</type><parameter>visitable</parameter></methodparam>
|
|
</methodsynopsis>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>visitable</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
The current <classname>CommonMark\Interfaces\IVisitable</classname> being entered
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<simpara>
|
|
Returning <varname>CommonMark\Interfaces\IVisitor::Done</varname> will cause the backing iterator to exit.
|
|
</simpara>
|
|
<simpara>
|
|
Returning <varname>CommonMark\Interfaces\IVisitor::Enter</varname> will reset the backing iterator at entering the current <classname>IVisitable</classname>
|
|
</simpara>
|
|
<simpara>
|
|
Returning <varname>CommonMark\Interfaces\IVisitor::Leave</varname> will reset the backing iterator at exiting the current <classname>IVisitable</classname>
|
|
</simpara>
|
|
<simpara>
|
|
Returning an <classname>IVisitable</classname> will reset the backing iterator at entering the given <classname>IVisitable</classname>
|
|
</simpara>
|
|
<simpara>
|
|
Returning nothing will allow the backing iterator to continue
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><xref linkend="commonmark-interfaces-ivisitable.accept"/></member>
|
|
</simplelist>
|
|
</refsect1>
|
|
|
|
|
|
</refentry>
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|