respect-validation/docs/rules/Readable.md

# Readable

- `Readable()`

Validates if the given data is a file exists and is readable.

```php
v::readable()->validate('file.txt'); // true
```

## Categorization

- File system

## Changelog

Version | Description
--------|-------------
  2.1.0 | Add PSR-7 support
  0.5.0 | Created

***
See also:

- [Directory](Directory.md)
- [Executable](Executable.md)
- [Exists](Exists.md)
- [Extension](Extension.md)
- [File](File.md)
- [Image](Image.md)
- [Mimetype](Mimetype.md)
- [Size](Size.md)
- [SymbolicLink](SymbolicLink.md)
- [Uploaded](Uploaded.md)
- [Writable](Writable.md)
Update documentation 2015-01-30 09:40:06 +01:00			`# Readable`

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			- `Readable()`
Update documentation 2015-01-30 09:40:06 +01:00
			`Validates if the given data is a file exists and is readable.`

			```php
Update documentation with code that works Some codes in the documentation were not code that actually works which can lead to some confusion of how to use Validation. Signed-off-by: Henrique Moody <henriquemoody@gmail.com> 2018-06-07 11:24:09 +02:00			`v::readable()->validate('file.txt'); // true`
Update documentation 2015-01-30 09:40:06 +01:00			```
Documentation improvements - Add a space after comments with `//`; - Add missing "See also" sections in some files 2015-10-20 02:53:25 +02:00
Add "Categorization" section to rule documentations Signed-off-by: Henrique Moody <henriquemoody@gmail.com> 2019-05-11 18:32:13 +02:00			`## Categorization`

			`- File system`

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`
			`--------\|-------------`
Allow file-related rules to validate PSR-7 interfaces The PSR-7 has two interfaces that allow us to validate them as files. This commit will allow some rules to validate those interfaces. Co-authored-by: Henrique Moody <henriquemoody@gmail.com> Signed-off-by: Henrique Moody <henriquemoody@gmail.com> 2019-06-06 22:09:12 +02:00			`2.1.0 \| Add PSR-7 support`
Add changelog to rules' documentation Also: - Create documentation for `Base` rule; - Increase number of rules 2017-03-27 22:04:13 +02:00			`0.5.0 \| Created`

Documentation improvements - Add a space after comments with `//`; - Add missing "See also" sections in some files 2015-10-20 02:53:25 +02:00			`***`
			`See also:`

Uniform Markdown lists on documentation 2017-03-28 11:53:14 +02:00			`- [Directory](Directory.md)`
			`- [Executable](Executable.md)`
			`- [Exists](Exists.md)`
			`- [Extension](Extension.md)`
			`- [File](File.md)`
Merge branch '1.1' 2018-12-11 13:31:50 +01:00			`- [Image](Image.md)`
Uniform Markdown lists on documentation 2017-03-28 11:53:14 +02:00			`- [Mimetype](Mimetype.md)`
			`- [Size](Size.md)`
			`- [SymbolicLink](SymbolicLink.md)`
			`- [Uploaded](Uploaded.md)`
			`- [Writable](Writable.md)`