Documentation

NumberComparator extends Comparator
in package

NumberComparator compiles a simple comparison to an anonymous subroutine, which you can call with a value to be tested again.

Now this would be very pointless, if NumberCompare didn't understand magnitudes.

The target value may use magnitudes of kilobytes (k, ki), megabytes (m, mi), or gigabytes (g, gi). Those suffixed with an i use the appropriate 2**n version in accordance with the IEC standard: http://physics.nist.gov/cuu/Units/binary.html

Based on the Perl Number::Compare module.

Tags
author

Fabien Potencier fabien@symfony.com PHP port

author

Richard Clamp richardc@unixbeard.net Perl version

copyright

2004-2005 Fabien Potencier fabien@symfony.com

copyright

2002 Richard Clamp richardc@unixbeard.net

see
http://physics.nist.gov/cuu/Units/binary.html

Table of Contents

$operator  : mixed
$target  : mixed
__construct()  : mixed
getOperator()  : string
Gets the comparison operator.
getTarget()  : string
Gets the target value.
setOperator()  : mixed
Sets the comparison operator.
setTarget()  : mixed
test()  : bool
Tests against the target.

Properties

Methods

__construct()

public __construct(string|int $test) : mixed
Parameters
$test : string|int

A comparison string or an integer

Tags
throws
InvalidArgumentException

If the test is not understood

Return values
mixed

getOperator()

Gets the comparison operator.

public getOperator() : string
Return values
string

The operator

getTarget()

Gets the target value.

public getTarget() : string
Return values
string

The target value

setOperator()

Sets the comparison operator.

public setOperator(string $operator) : mixed
Parameters
$operator : string
Tags
throws
InvalidArgumentException
Return values
mixed

setTarget()

public setTarget(string $target) : mixed
Parameters
$target : string
Return values
mixed

test()

Tests against the target.

public test(mixed $test) : bool
Parameters
$test : mixed

A test value

Return values
bool

Search results