respect-validation/docs/rules/Optional.md

# Optional

- `Optional(Validatable $rule)`

Validates if the given input is optional or not. By _optional_ we consider `null`
or an empty string (`''`).

```php
v::optional(v::alpha())->validate(''); // true
v::optional(v::digit())->validate(null); // true
```

## Categorization

- Nesting

## Changelog

Version | Description
--------|-------------
  1.0.0 | Created

***
See also:

- [NoWhitespace](NoWhitespace.md)
- [NotBlank](NotBlank.md)
- [NotEmpty](NotEmpty.md)
- [NotOptional](NotOptional.md)
- [NullType](NullType.md)
- [Nullable](Nullable.md)
Create "Optional" rule 2015-10-07 07:41:38 +02:00			`# Optional`

Change how documentation of rules are presented Rules are not always used from the alias `v`, neither called staticaly. 2017-03-27 14:47:07 +02:00			- `Optional(Validatable $rule)`
Create "Optional" rule 2015-10-07 07:41:38 +02:00
Remove user-defined optional values Since we have NotOptional rule now, we must keep the same opposite behaviour between these two rules. This commit also improve and increase tests from Optional rule and updates the documentation. No tests was made for messages on MODE_DEFAULT because it's not possible for a while since we don't have such much granularity control, but after some fixes on Not rule, maybe we will be able to do that, that's why I kept the messages on OptionalException. 2015-10-15 16:10:47 +02:00			Validates if the given input is optional or not. By _optional_ we consider `null`
			or an empty string (`''`).
Create "Optional" rule 2015-10-07 07:41:38 +02:00
			```php
			`v::optional(v::alpha())->validate(''); // true`
			`v::optional(v::digit())->validate(null); // true`
			```

Add "Categorization" section to rule documentations Signed-off-by: Henrique Moody <henriquemoody@gmail.com> 2019-05-11 18:32:13 +02:00			`## Categorization`

			`- Nesting`

Add changelog to rules' documentation Also: - Create documentation for `Base` rule; - Increase number of rules 2017-03-27 22:04:13 +02:00			`## Changelog`

			`Version \| Description`
			`--------\|-------------`
			`1.0.0 \| Created`
Create "Optional" rule 2015-10-07 07:41:38 +02:00
			`***`
			`See also:`

Uniform Markdown lists on documentation 2017-03-28 11:53:14 +02:00			`- [NoWhitespace](NoWhitespace.md)`
			`- [NotBlank](NotBlank.md)`
			`- [NotEmpty](NotEmpty.md)`
			`- [NotOptional](NotOptional.md)`
			`- [NullType](NullType.md)`
Merge branch '1.1' 2018-12-11 13:31:50 +01:00			`- [Nullable](Nullable.md)`