stubbles/input

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

v7.0.0 2016-07-31 10:35 UTC

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

Build Status Coverage Status

Latest Stable Version Latest Unstable Version

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": "^7.0"

Requirements

stubbles/input requires at least PHP 7.0.

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.