diff --git a/docs/book/validators/is-json-string.md b/docs/book/validators/is-json-string.md index e476e4b1..23a6b3e9 100644 --- a/docs/book/validators/is-json-string.md +++ b/docs/book/validators/is-json-string.md @@ -1,4 +1,4 @@ -# IsJsonString Validator +# IsJsonString `Laminas\Validator\IsJsonString` allows you to validate whether a given value is a string that will be successfully decoded by `json_decode`. @@ -15,7 +15,7 @@ if ($validator->isValid($input)) { } ``` -## Restricting Acceptable JSON types +## Restricting Acceptable JSON Types `json_decode` accepts numeric strings representing integers and floating point numbers, booleans, arrays and objects. You can restrict what is considered valid input using the `allow` option of the validator. @@ -32,9 +32,9 @@ $validator->isValid('true'); // false The `allow` option is a bit mask of the `ALLOW_*` constants in `IsJsonString`: -- `IsJsonString::ALLOW_INT` - Accept numeric such as "1" -- `IsJsonString::ALLOW_FLOAT` - Accept numeric strings such as "1.234" -- `IsJsonString::ALLOW_BOOL` - Accept "true" and "false" +- `IsJsonString::ALLOW_INT` - Accept integer such as `1` +- `IsJsonString::ALLOW_FLOAT` - Accept floating-point value such as `1.234` +- `IsJsonString::ALLOW_BOOL` - Accept `true` and `false` - `IsJsonString::ALLOW_ARRAY` - Accept JSON arrays such as `["One", "Two"]` - `IsJsonString::ALLOW_OBJECT` - Accept JSON objects such as `{"Some":"Object"}` - `IsJsonString::ALLOW_ALL` - A convenience constant allowing all of the above _(Also the default)_. @@ -46,7 +46,7 @@ use Laminas\Validator\IsJsonString; $validator = new IsJsonString(); $validator->setAllow(IsJsonString::ALLOW_ARRAY | IsJsonString::ALLOW_OBJECT); -$validator->isValid("1.234"); // false +$validator->isValid('1.234'); // false ``` ## Restricting Max Object or Array Nesting Level