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 * This file is part of fast-forward/dev-tools.
7 *
8 * This source file is subject to the license bundled
9 * with this source code in the file LICENSE.
10 *
11 * @copyright Copyright (c) 2026 Felipe SayĆ£o Lobato Abreu <github@mentordosnerds.com>
12 * @license   https://opensource.org/licenses/MIT MIT License
13 *
14 * @see       https://github.com/php-fast-forward/dev-tools
15 * @see       https://github.com/php-fast-forward
16 * @see       https://datatracker.ietf.org/doc/html/rfc2119
17 */
18
19namespace FastForward\DevTools\GitAttributes;
20
21/**
22 * Defines the contract for reading .gitattributes files from persistent storage.
23 *
24 * Implementations MUST load the raw textual content from the provided path and
25 * SHALL return an empty string when the target file does not exist.
26 */
27interface ReaderInterface
28{
29    /**
30     * Reads the .gitattributes content from the specified filesystem path.
31     *
32     * @param string $gitattributesPath The filesystem path to the .gitattributes file.
33     *
34     * @return string The raw .gitattributes content, or an empty string when absent.
35     */
36    public function read(string $gitattributesPath): string;
37}