Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Fast Forward Development Tools for PHP projects.
7 *
8 * This file is part of fast-forward/dev-tools project.
9 *
10 * @author   Felipe SayĆ£o Lobato Abreu <github@mentordosnerds.com>
11 * @license  https://opensource.org/licenses/MIT MIT License
12 *
13 * @see      https://github.com/php-fast-forward/
14 * @see      https://github.com/php-fast-forward/dev-tools
15 * @see      https://github.com/php-fast-forward/dev-tools/issues
16 * @see      https://php-fast-forward.github.io/dev-tools/
17 * @see      https://datatracker.ietf.org/doc/html/rfc2119
18 */
19
20namespace FastForward\DevTools\GitAttributes;
21
22/**
23 * Defines the contract for reading .gitattributes files from persistent storage.
24 *
25 * Implementations MUST load the raw textual content from the provided path and
26 * SHALL return an empty string when the target file does not exist.
27 */
28interface ReaderInterface
29{
30    /**
31     * Reads the .gitattributes content from the specified filesystem path.
32     *
33     * @param string $gitattributesPath The filesystem path to the .gitattributes file.
34     *
35     * @return string The raw .gitattributes content, or an empty string when absent.
36     */
37    public function read(string $gitattributesPath): string;
38}