php-doc-en/reference/mongo/mongolog/getmodule.xml
Jeremy Mikola c2b2224748 Revise MongoLog method documentation
Replace reference to deprecated MongoLog constants. Fix typing docs in callback pages and add PHP version requirement to getCallback(). Make language consistent between the getter/setter method docs.

https://jira.mongodb.org/browse/PHP-1162


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334511 c90b9560-bf6c-de11-be94-00142212c4b1
2014-08-06 19:39:17 +00:00

76 lines
1.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mongolog.getmodule" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoLog::getModule</refname>
<refpurpose>Gets the module(s) currently being logged</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>int</type><methodname>MongoLog::getModule</methodname>
<void/>
</methodsynopsis>
<para>
This function can be used to see which driver modules are currently being
logged. The returned integer may be compared with the
<link linkend="mongolog.constants.module">MongoLog module constants</link>
using bitwise operators to check if specific modules are being logged.
</para>
<programlisting role="php">
<![CDATA[
<?php
if (MongoLog::getModule() & MongoLog::RS) {
echo "logging replica sets\n";
}
if (MongoLog::getModule() ^ MongoLog::NONE) {
echo "logging something\n";
}
if ((MongoLog::getModule() & MongoLog::IO) == 0) {
echo "not logging io\n";
}
?>
]]>
</programlisting>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the module(s) currently being logged.
</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
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
-->