PHP implementation for Excel's mround function: Returns a number rounded to the nearest multiple of another number., (*1)
, (*2)
What's in this package?
Rounding to a nearest multiple or fraction
with the mround function, corresponding to MROUND, (*3)
Rounding down to a nearest multiple or fraction
with the mfloor function, corresponding to FLOOR, (*4)
Rounding up to a nearest multiple or fraction
with the mceil function, corresponding to CEILING, (*5)
All these are bundled in a callable MRounder class; the rounding behaviour is defined by an optional contructor parameter., (*6)
Please see the desktop software documentation for Excel, LibreOffice, or OpenOffice and the original PHP implementation by Nasser Hekmati on StackOverflow., (*7)
Installation
$ composer require filmtools/mround
The functions
The functions are namespaced, so you will have to mention it in your use statements:, (*8)
use function FilmTools\MRounder\mround;
use function FilmTools\MRounder\mfloor;
use function FilmTools\MRounder\mceil;
The functions all round num to the nearest multiple of base; their signature is:, (*9)
fn( float $num, float $base);
mround · “normal” rounding
<?php
use function FilmTools\MRounder\mround;
echo mround( 12, 10); // 10
echo mround( 2.4, 0.5); // 2.5
echo mround( 11.2, 1/3); // 11.333333333333
echo mround( 11.1, 1/3); // 11
mfloor · round down
<?php
use function FilmTools\MRounder\mfloor;
echo mfloor( 59, 10); // 50
echo mfloor( 2.4, 0.5); // 2.0
mceil · round mceil
<?php
use function FilmTools\MRounder\mceil;
echo mceil( 51, 10); // 60
echo mceil( 2.4, 0.5); // 2.5
MRounder · Callable class
<?php
use FilmTools\MRounder\MRounder;
// Instantiate with the desired base multiple
$mrounder = new MRounder( 0.5 );
$mrounder = new MRounder( 0.5, MRounder::ROUND );
$mrounder = new MRounder( 0.5, "round" );
echo $mrounder( 2.4 ); // 2.5
// Down-rounder
$round_down = new MRounder( 0.5, MRounder::FLOOR );
$round_down = new MRounder( 0.5, "floor" );
echo $round_down( 2.4 ); // 2.0
// Up-rounder
$round_up = new MRounder( 0.5, MRounder::CEIL );
$round_up = new MRounder( 0.5, "ceil" );
echo $round_up( 7.2 ); // 7.5
// Bonus – You will find this interesting:
echo mround( 99, 0); // 0
Arrays are welcome!, (*10)
// Build an array with equal keys and values:
$steps = range(0, 1, 0.1);
$numbers = array_combine($steps, $steps);
// Now let's round to multiples
// of one-sixth fraction:
$mround = new MRounder( 1/6 );
$sixths = array_map($mround, $numbers);
print_r($sixths);
// Output:
Array
(
[0] => 0
[0.1] => 0.16666666666667
[0.2] => 0.16666666666667
[0.3] => 0.33333333333333
[0.4] => 0.33333333333333
[0.5] => 0.5 # funny, but of course equals 2/6.
[0.6] => 0.66666666666667
[0.7] => 0.66666666666667
[0.8] => 0.83333333333333
[0.9] => 0.83333333333333
[1] => 1
)
Exceptions
When passed not-numeric numbers, both MRounder and mround will throw a MRoundInvalidArgumentException which extends PHP's \InvalidArgumentException and implements the MRoundExceptionInterface., (*11)
<?php
use FilmTools\MRounder\MRounder;
use FilmTools\MRounder\MRoundInvalidArgumentException;
use FilmTools\MRounder\MRoundExceptionInterface;
try {
$mround = new MRounder( "foobar" );
// accordingly
echo mround( 22, "string");
echo mround( "foo", 4);
}
catch (MRoundExceptionInterface $e) {
echo get_class( $e );
echo $e->getMessage();
// MRoundInvalidArgumentException
// Parameter must be numeric.
}
Development and Unit testing
$ git clone https://github.com/filmtools/mround.git
$ cd mround
$ composer install
# either, or, and:
$ composer phpunit
$ vendor/bin/phpunit
Wallogit.com
