IntSchema.md

IntSchema

The IntSchema validates integer values with numeric constraints.

Basic Usage

use Chubbyphp\Parsing\Parser;

$p = new Parser();

$schema = $p->int();

$data = $schema->parse(1337); // Returns: 1337

Validations

Comparison Constraints

$schema->minimum(5);  // Greater than or equal to 5
$schema->exclusiveMinimum(5);   // Greater than 5
$schema->exclusiveMaximum(10);  // Less than 10
$schema->maximum(10); // Less than or equal to 10
$schema->multipleOf(5); // Multiple of 5

Sign Constraints

$schema->positive();    // Must be > 0
$schema->nonNegative(); // Must be >= 0
$schema->negative();    // Must be < 0
$schema->nonPositive(); // Must be <= 0

Conversions

$schema->toDateTime(); // Convert Unix timestamp to DateTimeImmutable
$schema->toFloat();    // Convert to float
$schema->toString();   // Convert to string

Common Patterns

Positive Integer

$positiveSchema = $p->int()->positive();

$positiveSchema->parse(42);  // Returns: 42
$positiveSchema->parse(0);   // Throws: positive validation error
$positiveSchema->parse(-1);  // Throws: positive validation error

Range Validation

$ageSchema = $p->int()->minimum(0)->maximum(150);

$ageSchema->parse(25);  // Returns: 25
$ageSchema->parse(-1);  // Throws: minimum validation error
$ageSchema->parse(200); // Throws: maximum validation error

Pagination

$offsetSchema = $p->int()->nonNegative();
$limitSchema = $p->int()->positive()->maximum(100);

$paginationSchema = $p->object([
    'offset' => $offsetSchema,
    'limit' => $limitSchema,
]);

Unix Timestamp to DateTime

$timestampSchema = $p->int()->positive()->toDateTime();

$date = $timestampSchema->parse(1705744500);
// Returns: DateTimeImmutable instance for 2024-01-20T09:15:00+00:00

Error Codes

Code	Description
int.type	Value is not an integer
int.minimum	Value is not greater than or equal to threshold
int.exclusiveMinimum	Value is not greater than to threshold
int.exclusiveMaximum	Value is not less than to threshold
int.maximum	Value is not less than or equal to threshold
int.multipleOf	Value is not a multiple of threshold