php-doc-en/reference/mongodb/mongodb/driver/cursorinterface.xml
Jeremy Mikola 04ca316e18 Revise docs for CursorInterface
Replace Traversable with CursorInterface for Cursor class synopsis, but note that CursorInterface extends Traversable in the changelog. Replace "final" modifier with "abstract" for interface methods. Add "See Also" links to Cursor methods. Remove iteration details from setTypeMap(), as those are more relevant to the Cursor implementation. Change order of CursorInterface in MongoDB\Driver class list.

https://jira.mongodb.org/browse/PHPC-1123


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347939 c90b9560-bf6c-de11-be94-00142212c4b1
2019-09-05 03:29:38 +00:00

73 lines
2.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 344505 $ -->
<phpdoc:classref xml:id="class.mongodb-driver-cursorinterface" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The MongoDB\Driver\CursorInterface interface</title>
<titleabbrev>MongoDB\Driver\CursorInterface</titleabbrev>
<partintro>
<!-- {{{ MongoDB\Driver\CursorInterface intro -->
<section xml:id="mongodb-driver-cursorinterface.intro">
&reftitle.intro;
<para>
This interface is implemented by
<classname>MongoDB\Driver\Cursor</classname> but may also be used for
type-hinting and userland classes.
</para>
</section>
<!-- }}} -->
<section xml:id="mongodb-driver-cursorinterface.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>MongoDB\Driver\CursorInterface</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>MongoDB\Driver\CursorInterface</classname>
</ooclass>
<oointerface>
<interfacename>Traversable</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongodb-driver-cursorinterface')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
&reference.mongodb.mongodb.driver.entities.cursorinterface;
</phpdoc:classref>
<!-- 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
-->