(PHP 8 >= 8.4.0)
BcMath\Number::mod — Obtém o resto de um número de precisão arbitrária
Obtém o resto da divisão de $this por num.
A menos que num seja 0, o resultado tem o mesmo sinal
de $this.
numscalenull, a BcMath\Number::scale do resultado do cálculo será definida automaticamente.
Retorna o resto como um novo objeto BcMath\Number.
Quando a BcMath\Number::scale do objeto resultante é definida automaticamente, a maior BcMath\Number::scale dos dois números da operação de resto é usada.
Isto é, com a propriedade BcMath\Number::scale de dois valores 2
e 5 respectivamente, a propriedade BcMath\Number::scale do resultado
será 5.
Este método lança uma exceção ValueError nos seguintes casos:
num é string e não é uma string numérica BCMath bem formadascale está fora do intervalo válido
Este método lança uma exceção DivisionByZeroError se
num for 0.
Exemplo #1 Exemplo de BcMath\Number::mod() quando scale não for especificado
<?php
$number = new BcMath\Number('8.3');
$ret1 = $number->mod(new BcMath\Number('2.22'));
$ret2 = $number->mod('8.3');
$ret3 = $number->mod(-5);
var_dump($number, $ret1, $ret2, $ret3);
?>O exemplo acima produzirá:
object(BcMath\Number)#1 (2) {
["value"]=>
string(3) "8.3"
["scale"]=>
int(1)
}
object(BcMath\Number)#3 (2) {
["value"]=>
string(4) "1.64"
["scale"]=>
int(2)
}
object(BcMath\Number)#2 (2) {
["value"]=>
string(3) "0.0"
["scale"]=>
int(1)
}
object(BcMath\Number)#4 (2) {
["value"]=>
string(3) "3.3"
["scale"]=>
int(1)
}
Exemplo #2 Exemplo de BcMath\Number::mod() especificando scale explicitamente
<?php
$number = new BcMath\Number('8.3');
$ret1 = $number->mod(new BcMath\Number('2.22'), 1);
$ret2 = $number->mod('8.3', 3);
$ret3 = $number->mod(-5, 0);
var_dump($number, $ret1, $ret2, $ret3);
?>O exemplo acima produzirá:
object(BcMath\Number)#1 (2) {
["value"]=>
string(3) "8.3"
["scale"]=>
int(1)
}
object(BcMath\Number)#3 (2) {
["value"]=>
string(3) "1.6"
["scale"]=>
int(1)
}
object(BcMath\Number)#2 (2) {
["value"]=>
string(5) "0.000"
["scale"]=>
int(3)
}
object(BcMath\Number)#4 (2) {
["value"]=>
string(1) "3"
["scale"]=>
int(0)
}