classUpsertNumber

Simulation packages/ztd-query-core/src/Shadow/Mutation/Upsert/UpsertNumber.php:19

final class UpsertNumber

Does arithmetic the way a database does it, over the values a row carries.

Two things separate this from PHP's own operators. A row value arrives as text however it was declared, so '12' is a number here; and null is unknown rather than zero, so anything touching it is unknown too.

Type Aliases§

RowValue = import from TableDefinition

Methods§

public function of(mixed $value): int|float

100%source §

Reads a value as the number it stands for.

A string is read as an integer unless it is written the way a float is, which keeps whole numbers exact however the driver handed them over.

Parameters

$value mixed Value to read

Returns

int|float The number it stands for

Throws

UnsupportedSqlException When the value is not written as a number

Test cases 16

UpsertNumberTest::testAddSumsBothSides covers
UpsertNumberTest::testDivideDividesTheLeftSideByTheRight covers
UpsertNumberTest::testDivideRefusesAZeroDivisor covers
UpsertNumberTest::testDivideRefusesAZeroDivisorWrittenAsAFloat covers
UpsertNumberTest::testModuloAnswersWhatIsLeftOver covers
UpsertNumberTest::testModuloRefusesADivisorThatIsZeroOnceItIsAWholeNumber covers
UpsertNumberTest::testModuloTakesBothSidesAsWholeNumbersFirst covers
UpsertNumberTest::testMultiplyMultipliesBothSides covers
UpsertNumberTest::testNegativeTurnsTheSignAround covers
UpsertNumberTest::testOfKeepsANumberAsItIs covers and calls
UpsertNumberTest::testOfReadsTextWrittenTheWayAFloatIsAsAFloat covers and calls
UpsertNumberTest::testOfReadsWholeTextAsAnIntegerRatherThanAFloat covers and calls
UpsertNumberTest::testOfRefusesABooleanBecauseArithmeticOnItIsNotSomethingSqlAgreesOn covers and calls
UpsertNumberTest::testOfRefusesTextThatIsNotWrittenAsANumber covers and calls
UpsertNumberTest::testPositiveKeepsTheNumberAndItsSign covers
UpsertNumberTest::testSubtractTakesTheRightSideFromTheLeft covers

Called from 11

Calls 6

function-call is_int line 35
function-call is_float line 35
function-call is_string line 38
function-call is_numeric line 38
new UnsupportedSqlException line 39
function-call strpbrk line 42

public function isNumeric(mixed $value): bool

100%source §

Reports whether a value is one arithmetic can be done on.

Parameters

$value mixed Value to test

Returns

bool True when it is a number or written as one

Test cases 1

UpsertNumberTest::testIsNumericAnswersForTheValuesArithmeticCanBeDoneOn covers and calls

Called from 3

Calls 4

function-call is_int line 54
function-call is_float line 54
function-call is_string line 58
function-call is_numeric line 58

public function positive(mixed $value): int|float|null

100%source §

Answers the value with its sign kept, as a number.

Parameters

$value mixed Value to read

Returns

int|float|null The number, or null when the value is unknown

Throws

UnsupportedSqlException When the value is not written as a number

Test cases 2

UpsertNumberTest::testPositiveIsUnknownForAnUnknownValue covers and calls
UpsertNumberTest::testPositiveKeepsTheNumberAndItsSign covers and calls

Called from 1

method-call ZtdQuery\Shadow\Mutation\Upsert\UpsertOperator::apply() packages/ztd-query-core/src/Shadow/Mutation/Upsert/UpsertOperator.php:58

Calls 1

method-call UpsertNumber::of() line 72

public function negative(mixed $value): int|float|null

100%source §

Answers the value with its sign turned around.

Parameters

$value mixed Value to read

Returns

int|float|null The number, or null when the value is unknown

Throws

UnsupportedSqlException When the value is not written as a number

Test cases 2

UpsertNumberTest::testNegativeIsUnknownForAnUnknownValue covers and calls
UpsertNumberTest::testNegativeTurnsTheSignAround covers and calls

Called from 1

method-call ZtdQuery\Shadow\Mutation\Upsert\UpsertOperator::apply() packages/ztd-query-core/src/Shadow/Mutation/Upsert/UpsertOperator.php:59

Calls 1

method-call UpsertNumber::of() line 86

public function add(mixed $left, mixed $right): int|float|null

100%source §

Adds two values.

Parameters

`$left`	`mixed`	Left operand
`$right`	`mixed`	Right operand

Returns

int|float|null The sum, or null when either is unknown

Throws

UnsupportedSqlException When either is not written as a number

Test cases 2

UpsertNumberTest::testAddIsUnknownWhenEitherSideIs covers and calls
UpsertNumberTest::testAddSumsBothSides covers and calls

Called from 1

method-call ZtdQuery\Shadow\Mutation\Upsert\UpsertOperator::apply() packages/ztd-query-core/src/Shadow/Mutation/Upsert/UpsertOperator.php:61

Calls 1

method-call UpsertNumber::of() line 105

public function subtract(mixed $left, mixed $right): int|float|null

100%source §

Subtracts the right value from the left.

Parameters

`$left`	`mixed`	Left operand
`$right`	`mixed`	Right operand

Returns

int|float|null The difference, or null when either is unknown

Throws

UnsupportedSqlException When either is not written as a number

Test cases 2

UpsertNumberTest::testSubtractIsUnknownWhenEitherSideIs covers and calls
UpsertNumberTest::testSubtractTakesTheRightSideFromTheLeft covers and calls

Called from 1

method-call ZtdQuery\Shadow\Mutation\Upsert\UpsertOperator::apply() packages/ztd-query-core/src/Shadow/Mutation/Upsert/UpsertOperator.php:62

Calls 1

method-call UpsertNumber::of() line 124

public function multiply(mixed $left, mixed $right): int|float|null

100%source §

Multiplies two values.

Parameters

`$left`	`mixed`	Left operand
`$right`	`mixed`	Right operand

Returns

int|float|null The product, or null when either is unknown

Throws

UnsupportedSqlException When either is not written as a number

Test cases 2

UpsertNumberTest::testMultiplyIsUnknownWhenEitherSideIs covers and calls
UpsertNumberTest::testMultiplyMultipliesBothSides covers and calls

Called from 1

method-call ZtdQuery\Shadow\Mutation\Upsert\UpsertOperator::apply() packages/ztd-query-core/src/Shadow/Mutation/Upsert/UpsertOperator.php:63

Calls 1

method-call UpsertNumber::of() line 143

public function divide(mixed $left, mixed $right): int|float|null

100%source §

Divides the left value by the right.

Parameters

`$left`	`mixed`	Left operand
`$right`	`mixed`	Right operand

Returns

int|float|null The quotient, or null when either is unknown

Throws

UnsupportedSqlException When either is not a number, or the divisor is zero

Test cases 4

UpsertNumberTest::testDivideDividesTheLeftSideByTheRight covers and calls
UpsertNumberTest::testDivideIsUnknownWhenEitherSideIs covers and calls
UpsertNumberTest::testDivideRefusesAZeroDivisor covers and calls
UpsertNumberTest::testDivideRefusesAZeroDivisorWrittenAsAFloat covers and calls

Called from 1

method-call ZtdQuery\Shadow\Mutation\Upsert\UpsertOperator::apply() packages/ztd-query-core/src/Shadow/Mutation/Upsert/UpsertOperator.php:64

Calls 2

method-call UpsertNumber::of() line 161
new UnsupportedSqlException line 163

public function modulo(mixed $left, mixed $right): int|null

100%source §

Answers what is left over when the left value is divided by the right.

Both sides are taken as whole numbers first, which is what SQL's own modulo does with a fractional operand.

Parameters

`$left`	`mixed`	Left operand
`$right`	`mixed`	Right operand

Returns

int|null The remainder, or null when either is unknown

Throws

UnsupportedSqlException When either is not a number, or the divisor is zero

Test cases 4

UpsertNumberTest::testModuloAnswersWhatIsLeftOver covers and calls
UpsertNumberTest::testModuloIsUnknownWhenEitherSideIs covers and calls
UpsertNumberTest::testModuloRefusesADivisorThatIsZeroOnceItIsAWholeNumber covers and calls
UpsertNumberTest::testModuloTakesBothSidesAsWholeNumbersFirst covers and calls

Called from 1

method-call ZtdQuery\Shadow\Mutation\Upsert\UpsertOperator::apply() packages/ztd-query-core/src/Shadow/Mutation/Upsert/UpsertOperator.php:65

Calls 3

Test cases 33§

Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.

Dedicated tests 24

UpsertNumberTest::testAddIsUnknownWhenEitherSideIs covers and calls
UpsertNumberTest::testAddSumsBothSides covers and calls
UpsertNumberTest::testDivideDividesTheLeftSideByTheRight covers and calls
UpsertNumberTest::testDivideIsUnknownWhenEitherSideIs covers and calls
UpsertNumberTest::testDivideRefusesAZeroDivisor covers and calls
UpsertNumberTest::testDivideRefusesAZeroDivisorWrittenAsAFloat covers and calls
UpsertNumberTest::testIsNumericAnswersForTheValuesArithmeticCanBeDoneOn covers and calls
UpsertNumberTest::testModuloAnswersWhatIsLeftOver covers and calls
UpsertNumberTest::testModuloIsUnknownWhenEitherSideIs covers and calls
UpsertNumberTest::testModuloRefusesADivisorThatIsZeroOnceItIsAWholeNumber covers and calls
UpsertNumberTest::testModuloTakesBothSidesAsWholeNumbersFirst covers and calls
UpsertNumberTest::testMultiplyIsUnknownWhenEitherSideIs covers and calls
UpsertNumberTest::testMultiplyMultipliesBothSides covers and calls
UpsertNumberTest::testNegativeIsUnknownForAnUnknownValue covers and calls
UpsertNumberTest::testNegativeTurnsTheSignAround covers and calls
UpsertNumberTest::testOfKeepsANumberAsItIs covers and calls
UpsertNumberTest::testOfReadsTextWrittenTheWayAFloatIsAsAFloat covers and calls
UpsertNumberTest::testOfReadsWholeTextAsAnIntegerRatherThanAFloat covers and calls
UpsertNumberTest::testOfRefusesABooleanBecauseArithmeticOnItIsNotSomethingSqlAgreesOn covers and calls
UpsertNumberTest::testOfRefusesTextThatIsNotWrittenAsANumber covers and calls
UpsertNumberTest::testPositiveIsUnknownForAnUnknownValue covers and calls
UpsertNumberTest::testPositiveKeepsTheNumberAndItsSign covers and calls
UpsertNumberTest::testSubtractIsUnknownWhenEitherSideIs covers and calls
UpsertNumberTest::testSubtractTakesTheRightSideFromTheLeft covers and calls

Other tests reaching this symbol 9

Relations§

Instantiated in 3

Method calls 12

Type declarations 3