GitIgnoreInterface

Interface
extends IteratorAggregate

Defines the contract for a .gitignore file with its path and entries.

Description

This interface MUST be implemented by any class that represents a .gitignore file. It SHALL allow iteration over entries and provide access to the file path.

Tags
extends

Table of Contents

Methods

entries()

Returns the list of entries from the .gitignore file.

 : array<int, string>
path()

Returns the file system path to the .gitignore file.

 : string
Methods

entries()

Public

Returns the list of entries from the .gitignore file.

public entries() : array<int, string>
Return values
array<int, string>

Description

the non-empty .gitignore entries

path()

Public

Returns the file system path to the .gitignore file.

public path() : string
Return values
string

Description

the absolute path to the .gitignore file