-
-
Notifications
You must be signed in to change notification settings - Fork 0
Reader
github-actions edited this page Apr 9, 2026
·
1 revision
Reads .gitignore files and returns domain representations for them.
This reader SHALL provide a minimal abstraction for loading a .gitignore file from a filesystem path. The implementation MUST delegate file parsing to the GitIgnore value object and MUST return a GitIgnoreInterface-compatible result.
- Full name:
\FastForward\DevTools\GitIgnore\Reader - This class is marked as final and can't be subclassed
- This class implements:
\FastForward\DevTools\GitIgnore\ReaderInterface - This class is a Final class
Reads a .gitignore file from the specified filesystem path.
public read(string $gitignorePath): \FastForward\DevTools\GitIgnore\GitIgnoreInterfaceThe provided path MUST reference a readable .gitignore file. This method SHALL delegate object creation to GitIgnore::fromFile() and MUST return the resulting GitIgnoreInterface implementation.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$gitignorePath |
string | The filesystem path to the .gitignore file. |
Return Value:
The loaded .gitignore representation.