ReaderInterface

Interface

Defines the contract for reading .gitignore files from a storage location.

Description

Implementations MUST load a .gitignore resource from the provided filesystem path and SHALL return a GitIgnoreInterface representation of its contents. Implementations SHOULD delegate parsing and normalization responsibilities to a dedicated domain object or parser when appropriate.

Table of Contents

Methods

read()

Reads a .gitignore file from the specified filesystem path.

 : GitIgnoreInterface
Methods

read()

Public

Reads a .gitignore file from the specified filesystem path.

public read( string  $gitignorePath) : GitIgnoreInterface

Description

The provided path MUST identify a readable .gitignore file. Implementations SHALL return a GitIgnoreInterface instance representing the contents read from that path.

Parameters
$gitignorePath : string

Description

The filesystem path to the .gitignore file.

Return values

Description

The loaded .gitignore representation.