mirror of
https://github.com/Respect/Validation.git
synced 2026-03-15 06:45:44 +01:00
Makes it so the index looks more like a cheatsheet, condensing information instead of making long lists that require lots of scrolling to explore. Additionally, the happy path for each validator was also added, providing a quick reference use for comparison. The direct markdown links were replaced by titled markdown references, offering mouse-over tooltips over links that display the validator one-line description. To ensure a proper source of truth for these new index goodies, the AssertionMessageLinter was modified to verify that the first assertion in each doc is a single-line validator that passes (a happy path), further making our documentation conventions more solid.
57 lines
1.3 KiB
Markdown
57 lines
1.3 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: (c) Respect Project Contributors
|
|
SPDX-License-Identifier: MIT
|
|
-->
|
|
|
|
# Executable
|
|
|
|
- `Executable()`
|
|
|
|
Validates if a file is an executable.
|
|
|
|
```php
|
|
v::executable()->assert('/path/to/executable');
|
|
// Validation passes successfully
|
|
|
|
v::executable()->assert('/path/to/file');
|
|
// → "/path/to/file" must be an executable file
|
|
```
|
|
|
|
## Templates
|
|
|
|
### `Executable::TEMPLATE_STANDARD`
|
|
|
|
| Mode | Template |
|
|
| ---------: | :----------------------------------------- |
|
|
| `default` | {{subject}} must be an executable file |
|
|
| `inverted` | {{subject}} must not be an executable file |
|
|
|
|
## Template placeholders
|
|
|
|
| Placeholder | Description |
|
|
| ----------- | ---------------------------------------------------------------- |
|
|
| `subject` | The validated input or the custom validator name (if specified). |
|
|
|
|
## Categorization
|
|
|
|
- File system
|
|
|
|
## Changelog
|
|
|
|
| Version | Description |
|
|
| ------: | :---------- |
|
|
| 0.7.0 | Created |
|
|
|
|
## See Also
|
|
|
|
- [Directory](Directory.md)
|
|
- [Exists](Exists.md)
|
|
- [Extension](Extension.md)
|
|
- [File](File.md)
|
|
- [Image](Image.md)
|
|
- [Mimetype](Mimetype.md)
|
|
- [Readable](Readable.md)
|
|
- [Size](Size.md)
|
|
- [SymbolicLink](SymbolicLink.md)
|
|
- [Uploaded](Uploaded.md)
|
|
- [Writable](Writable.md)
|