stubbles/input

Stubbles Input enables to handle input data via validation and filtering.

v9.0.0 2024-01-16 20:30 UTC

Requires

• php: ^8.2
• ext-iconv: *
• ext-json: *
• stubbles/reflect: ^10.0
• stubbles/values: ^11.0

Requires (Dev)

• bovigo/assert: ^8.0
• bovigo/callmap: ^8.0
• mikey179/vfsstream: ^1.6.11
• phpunit/phpunit: ^10.5
• stubbles/date: ^9.0
• stubbles/peer: ^10.0

Suggests

• stubbles/date: To filter input params as date or datespan instances.
• stubbles/peer: To filter input params as instances of stubbles\peer\http\HttpUri

BSD-3-Clause

README

One of the most common task in applications is to read, validate and filter input data. stubbles/input provides means to do exactly that, by providing a Request API in order to validate and filter input values.

Build status

Installation

stubbles/input is distributed as Composer package. To install it as a dependency of your package use the following command:

composer require "stubbles/input": "^9.0"

Requirements

stubbles/input requires at least PHP 8.2.

Request parameters

The Request API provides access to request parameters in different ways:

getParamNames(): array

Returns a list of all parameter names.

paramErrors(): ParamErrors

Returns a list of all parameter errors that occurred during reading single request parameters.

hasParam(string $paramName): bool

Checks if a parameter with the given name is present in the current request.

validateParam(string $paramName): ValueValidator

Returns a value validator with methods that can be used to check if the parameter with the given name is valid.

See validate parameters details.

readParam(string $paramName): ValueReader

Returns a value reader that can be used to read the parameter with the given name. In case the parameter does not exist the reader will return null.

See read parameters details.