CandidateProviderInterface

Interface

Provides the canonical list of candidate paths for export-ignore rules.

Description

This interface defines the contract for classes that provide the baseline set of files and directories that should typically be excluded from Composer package archives.

Table of Contents

Methods

all()

Returns all candidates as a combined list with folders first, then files.

 : array<int, string>
files()

Returns the list of file paths that are candidates for export-ignore.

 : array<int, string>
folders()

Returns the list of folder paths that are candidates for export-ignore.

 : array<int, string>
Methods

all()

Public

Returns all candidates as a combined list with folders first, then files.

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

Description

All candidates in deterministic order

files()

Public

Returns the list of file paths that are candidates for export-ignore.

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

Description

File paths in canonical form (e.g., "/.editorconfig")

folders()

Public

Returns the list of folder paths that are candidates for export-ignore.

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

Description

Folder paths in canonical form (e.g., "/.github/")