variant-mod.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.variant-mod" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>variant_mod</refname>
  <refpurpose>Divides two variants and returns only the remainder</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>variant</type><methodname>variant_mod</methodname>
   <methodparam><type>mixed</type><parameter>left</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>right</parameter></methodparam>
  </methodsynopsis>
  <para>
   Divides <parameter>left</parameter> by <parameter>right</parameter> and
   returns the remainder.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>left</parameter></term>
     <listitem>
      <para>
       The left operand.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>right</parameter></term>
     <listitem>
      <para>
       The right operand.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  &com.variant-arith;
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the remainder of the division.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Throws a <classname>com_exception</classname> on failure.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>variant_div</function></member>
    <member><function>variant_idiv</function></member>
   </simplelist>
  </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
-->