Skip to content

Commit 058eca3

Browse files
committed
Translate BCMath\Number methods
1 parent 11609d3 commit 058eca3

File tree

17 files changed

+2955
-0
lines changed

17 files changed

+2955
-0
lines changed

reference/bc/bcmath/number/add.xml

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- EN-Revision: c7e83fbbbcde9f54affc09424d032c38492a3ff4 Maintainer: Fan2Shrek Status: ready -->
3+
<!-- Reviewed: yes -->
4+
<refentry xml:id="bcmath-number.add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5+
<refnamediv>
6+
<refname>BcMath\Number::add</refname>
7+
<refpurpose>Ajouter un nombre de précision arbitraire</refpurpose>
8+
</refnamediv>
9+
10+
<refsect1 role="description">
11+
&reftitle.description;
12+
<methodsynopsis role="BcMath\\Number">
13+
<modifier>public</modifier> <type>BcMath\Number</type><methodname>BcMath\Number::add</methodname>
14+
<methodparam><type class="union"><type>BcMath\Number</type><type>string</type><type>int</type></type><parameter>num</parameter></methodparam>
15+
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>scale</parameter><initializer>&null;</initializer></methodparam>
16+
</methodsynopsis>
17+
<simpara>
18+
Ajoute <varname>$this</varname> et <parameter>num</parameter>.
19+
</simpara>
20+
</refsect1>
21+
22+
<refsect1 role="parameters">
23+
&reftitle.parameters;
24+
<variablelist>
25+
<varlistentry>
26+
<term><parameter>num</parameter></term>
27+
<listitem>
28+
<simpara>
29+
La valeur à ajouter.
30+
</simpara>
31+
</listitem>
32+
</varlistentry>
33+
<varlistentry>
34+
<term><parameter>scale</parameter></term>
35+
<listitem>
36+
<simpara>
37+
<parameter>scale</parameter> spécifié explicitement pour les résultats du calcul.
38+
Si &null;, le <parameter>scale</parameter> du résultat du calcul sera défini automatiquement.
39+
</simpara>
40+
</listitem>
41+
</varlistentry>
42+
</variablelist>
43+
</refsect1>
44+
45+
<refsect1 role="returnvalues">
46+
&reftitle.returnvalues;
47+
<simpara>
48+
Renvoie le résultat de l'addition sous la forme d'un nouvel objet <classname>BcMath\Number</classname>.
49+
</simpara>
50+
<simpara>
51+
Lorsque le <property>BcMath\Number::scale</property> du résultat est défini automatiquement,
52+
le plus grand <property>BcMath\Number::scale</property> des deux nombres utilisés pour l'addition est utilisé.
53+
</simpara>
54+
<simpara>
55+
C'est-à-dire que si les <property>BcMath\Number::scale</property> de deux valeurs sont <literal>2</literal>
56+
et <literal>5</literal> respectivement, le <property>BcMath\Number::scale</property> du résultat
57+
sera <literal>5</literal>.
58+
</simpara>
59+
</refsect1>
60+
61+
<refsect1 role="errors">
62+
&reftitle.errors;
63+
<para>
64+
Cette méthode lève une <exceptionname>ValueError</exceptionname> dans les cas suivants :
65+
<simplelist>
66+
<member><parameter>num</parameter> est un <type>string</type> et n'est pas une chaîne numérique BCMath bien formée</member>
67+
<member><parameter>scale</parameter> est en dehors de la plage valide</member>
68+
</simplelist>
69+
</para>
70+
</refsect1>
71+
72+
<refsect1 role="examples">
73+
&reftitle.examples;
74+
<example>
75+
<title>Exemple de <methodname>BcMath\Number::add</methodname> lorsque <parameter>scale</parameter> n'est pas spécifié</title>
76+
<programlisting role="php">
77+
<![CDATA[
78+
<?php
79+
$number = new BcMath\Number('1.234');
80+
81+
$ret1 = $number->add(new BcMath\Number('2.34567'));
82+
$ret2 = $number->add('-3.456');
83+
$ret3 = $number->add(7);
84+
85+
var_dump($number, $ret1, $ret2, $ret3);
86+
?>
87+
]]>
88+
</programlisting>
89+
&example.outputs;
90+
<screen>
91+
<![CDATA[
92+
object(BcMath\Number)#1 (2) {
93+
["value"]=>
94+
string(5) "1.234"
95+
["scale"]=>
96+
int(3)
97+
}
98+
object(BcMath\Number)#3 (2) {
99+
["value"]=>
100+
string(7) "3.57967"
101+
["scale"]=>
102+
int(5)
103+
}
104+
object(BcMath\Number)#2 (2) {
105+
["value"]=>
106+
string(6) "-2.222"
107+
["scale"]=>
108+
int(3)
109+
}
110+
object(BcMath\Number)#4 (2) {
111+
["value"]=>
112+
string(5) "8.234"
113+
["scale"]=>
114+
int(3)
115+
}
116+
]]>
117+
</screen>
118+
</example>
119+
120+
<example>
121+
<title><methodname>BcMath\Number::add</methodname> example of explicitly specifying <parameter>scale</parameter></title>
122+
<programlisting role="php">
123+
<![CDATA[
124+
<?php
125+
$number = new BcMath\Number('1.234');
126+
127+
$ret1 = $number->add(new BcMath\Number('2.34567'), 1);
128+
$ret2 = $number->add('-3.456', 10);
129+
$ret3 = $number->add(7, 0);
130+
131+
var_dump($number, $ret1, $ret2, $ret3);
132+
?>
133+
]]>
134+
</programlisting>
135+
&example.outputs;
136+
<screen>
137+
<![CDATA[
138+
object(BcMath\Number)#1 (2) {
139+
["value"]=>
140+
string(5) "1.234"
141+
["scale"]=>
142+
int(3)
143+
}
144+
object(BcMath\Number)#3 (2) {
145+
["value"]=>
146+
string(3) "3.5"
147+
["scale"]=>
148+
int(1)
149+
}
150+
object(BcMath\Number)#2 (2) {
151+
["value"]=>
152+
string(13) "-2.2220000000"
153+
["scale"]=>
154+
int(10)
155+
}
156+
object(BcMath\Number)#4 (2) {
157+
["value"]=>
158+
string(1) "8"
159+
["scale"]=>
160+
int(0)
161+
}
162+
]]>
163+
</screen>
164+
</example>
165+
</refsect1>
166+
167+
<refsect1 role="seealso">
168+
&reftitle.seealso;
169+
<simplelist>
170+
<member><function>bcadd</function></member>
171+
<member><methodname>BcMath\Number::sub</methodname></member>
172+
</simplelist>
173+
</refsect1>
174+
175+
</refentry>
176+
<!-- Keep this comment at the end of the file
177+
Local variables:
178+
mode: sgml
179+
sgml-omittag:t
180+
sgml-shorttag:t
181+
sgml-minimize-attributes:nil
182+
sgml-always-quote-attributes:t
183+
sgml-indent-step:1
184+
sgml-indent-data:t
185+
indent-tabs-mode:nil
186+
sgml-parent-document:nil
187+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
188+
sgml-exposed-tags:nil
189+
sgml-local-catalogs:nil
190+
sgml-local-ecat-files:nil
191+
End:
192+
vim600: syn=xml fen fdm=syntax fdl=2 si
193+
vim: et tw=78 syn=sgml
194+
vi: ts=1 sw=1
195+
-->
Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- EN-Revision: c7e83fbbbcde9f54affc09424d032c38492a3ff4 Maintainer: Fan2Shrek Status: ready -->
3+
<!-- Reviewed: yes -->
4+
<refentry xml:id="bcmath-number.ceil" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5+
<refnamediv>
6+
<refname>BcMath\Number::ceil</refname>
7+
<refpurpose>Arrondit au supérieur un nombre de précision arbitraire</refpurpose>
8+
</refnamediv>
9+
10+
<refsect1 role="description">
11+
&reftitle.description;
12+
<methodsynopsis role="BcMath\\Number">
13+
<modifier>public</modifier> <type>BcMath\Number</type><methodname>BcMath\Number::ceil</methodname>
14+
<void/>
15+
</methodsynopsis>
16+
<simpara>
17+
Renvoie la valeur entière supérieure suivante en arrondissant au supérieur
18+
<varname>$this</varname> si nécessaire.
19+
</simpara>
20+
</refsect1>
21+
22+
<refsect1 role="parameters">
23+
&reftitle.parameters;
24+
&no.function.parameters;
25+
</refsect1>
26+
27+
<refsect1 role="returnvalues">
28+
&reftitle.returnvalues;
29+
<simpara>
30+
Renvoie le résultats sous forme d'un nouvel objet <classname>BcMath\Number</classname>.
31+
La <property>BcMath\Number::scale</property> du résultat est toujours <literal>0</literal>.
32+
</simpara>
33+
</refsect1>
34+
35+
<refsect1 role="examples">
36+
&reftitle.examples;
37+
<example>
38+
<title>Exemple de <methodname>BcMath\Number::ceil</methodname></title>
39+
<programlisting role="php">
40+
<![CDATA[
41+
<?php
42+
$num1 = new BcMath\Number('4.3')->ceil();
43+
$num2 = new BcMath\Number('9.999')->ceil();
44+
$num3 = new BcMath\Number('-3.14')->ceil();
45+
46+
var_dump($num1, $num2, $num3);
47+
?>
48+
]]>
49+
</programlisting>
50+
&example.outputs;
51+
<screen>
52+
<![CDATA[
53+
object(BcMath\Number)#2 (2) {
54+
["value"]=>
55+
string(1) "5"
56+
["scale"]=>
57+
int(0)
58+
}
59+
object(BcMath\Number)#3 (2) {
60+
["value"]=>
61+
string(2) "10"
62+
["scale"]=>
63+
int(0)
64+
}
65+
object(BcMath\Number)#4 (2) {
66+
["value"]=>
67+
string(2) "-3"
68+
["scale"]=>
69+
int(0)
70+
}
71+
]]>
72+
</screen>
73+
</example>
74+
</refsect1>
75+
76+
<refsect1 role="seealso">
77+
&reftitle.seealso;
78+
<simplelist>
79+
<member><function>bcceil</function></member>
80+
<member><methodname>BcMath\Number::floor</methodname></member>
81+
<member><methodname>BcMath\Number::round</methodname></member>
82+
</simplelist>
83+
</refsect1>
84+
85+
</refentry>
86+
<!-- Keep this comment at the end of the file
87+
Local variables:
88+
mode: sgml
89+
sgml-omittag:t
90+
sgml-shorttag:t
91+
sgml-minimize-attributes:nil
92+
sgml-always-quote-attributes:t
93+
sgml-indent-step:1
94+
sgml-indent-data:t
95+
indent-tabs-mode:nil
96+
sgml-parent-document:nil
97+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
98+
sgml-exposed-tags:nil
99+
sgml-local-catalogs:nil
100+
sgml-local-ecat-files:nil
101+
End:
102+
vim600: syn=xml fen fdm=syntax fdl=2 si
103+
vim: et tw=78 syn=sgml
104+
vi: ts=1 sw=1
105+
-->

0 commit comments

Comments
 (0)