mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-31 16:28:55 +00:00
c47a493278
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@313602 c90b9560-bf6c-de11-be94-00142212c4b1
103 lines
2.6 KiB
XML
103 lines
2.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="mongocursor.doquery" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>MongoCursor::doQuery</refname>
|
|
<refpurpose>Execute the query.</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>protected</modifier> <type>void</type><methodname>MongoCursor::doQuery</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function actually queries the database. All queries and commands go
|
|
through this function. Thus, this function can be overridden to provide
|
|
custom query handling.
|
|
</para>
|
|
<para>
|
|
This handles serializing your query, sending it to the database, receiving a
|
|
response, and deserializing it. Thus, if you are planning to override this,
|
|
your code should probably call out to the original to use the existing
|
|
functionality (see the example below).
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
&no.function.parameters;
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&null;.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
Throws <classname>MongoConnectionException</classname> if it cannot reach the
|
|
database.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples"><!-- {{{ -->
|
|
&reftitle.examples;
|
|
<para>
|
|
<example xml:id="mongocursor.doquery.example.basic"><!-- {{{ -->
|
|
<title><function>MongoCursor::doQuery</function> example</title>
|
|
<para>
|
|
You could override this function to attempt a query on a slave and, if that
|
|
fails, try it again on the master.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
class MyCursor extends MongoCursor {
|
|
|
|
protected function doQuery() {
|
|
|
|
$this->slaveOkay();
|
|
|
|
try {
|
|
MongoCursor::doQuery();
|
|
}
|
|
catch(MongoCursorException $e) {
|
|
$this->slaveOkay(false);
|
|
MongoCursor::doQuery();
|
|
}
|
|
}
|
|
}
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example><!-- }}} -->
|
|
</para>
|
|
</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
|
|
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
|
|
-->
|