bcscale.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.bcscale" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>bcscale</refname>
  <refpurpose>Set or get default scale parameter for all bc math functions</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>bcscale</methodname>
   <methodparam><type>int</type><parameter>scale</parameter></methodparam>
  </methodsynopsis>
  <para>
   Sets the default scale parameter for all subsequent calls to bc math functions that
   do not explicitly specify a scale parameter.
  </para>
  <methodsynopsis>
   <type>int</type><methodname>bcscale</methodname>
   <methodparam choice="opt"><type>null</type><parameter>scale</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Gets the current scale factor.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>scale</parameter></term>
     <listitem>
      <para>
       The scale factor.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the old scale when used as setter. Otherwise the current scale is returned.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <simpara>
   This function throws a <exceptionname>ValueError</exceptionname> if <parameter>scale</parameter>
   is outside the valid range.
  </simpara>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>scale</parameter> is now nullable.
      </entry>
     </row>
     <row>
      <entry>7.3.0</entry>
      <entry>
       <function>bcscale</function> can now be used to get the current scale
       factor; when used as setter, it now returns the old scale value.
       Formerly, <parameter>scale</parameter> was mandatory, and
       <function>bcscale</function> always returned &true;.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>bcscale</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

// default scale : 3
bcscale(3);
echo bcdiv('105', '6.55957'); // 16.007

// this is the same without bcscale()
echo bcdiv('105', '6.55957', 3); // 16.007

?>
]]>
    </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
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
-->