WorkingProjectPathResolver

Class
Final: Yes

Provides canonical repository-root paths that are not part of the managed workspace.

Table of Contents

Constants

TOOLING_EXCLUDED_DIRECTORIES
 = ['.dev-tools', 'backup', 'cache', 'public', 'resources', 'tmp', 'vendor', '*/vendor', '*/vendor/*', '**/vendor', '**/vendor/*']

Methods

getProjectPath()

Returns the current working project directory or a path under it.

 : string
getToolingExcludedDirectories()

Returns the project directories that static-analysis and coding-style tooling SHOULD skip.

 : array<int, string>
getToolingSourcePaths()

Returns PHP source files that tooling SHOULD inspect without traversing generated directories.

 : array<int, string>
getToolingExcludedDirectoryNames()

Returns repository-relative directories ignored by tooling.

 : array<int, string>
Constants

Constants

TOOLING_EXCLUDED_DIRECTORIES

Public
public array<int, string> TOOLING_EXCLUDED_DIRECTORIES = ['.dev-tools', 'backup', 'cache', 'public', 'resources', 'tmp', 'vendor', '*/vendor', '*/vendor/*', '**/vendor', '**/vendor/*']

Description

repository-local directories ignored by tooling

Methods

getProjectPath()

Public Static

Returns the current working project directory or a path under it.

public static getProjectPath([ string  $path = '']) : string
Parameters
$path : string = ''

Description

the optional relative segment to append under the project directory

Return values
string

getToolingExcludedDirectories()

Public Static

Returns the project directories that static-analysis and coding-style tooling SHOULD skip.

public static getToolingExcludedDirectories([ string  $baseDir = '']) : array<int, string>
Parameters
$baseDir : string = ''

Description

the optional repository base directory used to materialize absolute paths

Return values
array<int, string>

getToolingSourcePaths()

Public Static

Returns PHP source files that tooling SHOULD inspect without traversing generated directories.

public static getToolingSourcePaths([ string  $baseDir = '']) : array<int, string>
Parameters
$baseDir : string = ''

Description

the optional repository base directory used to materialize absolute paths

Return values
array<int, string>

getToolingExcludedDirectoryNames()

Private Static

Returns repository-relative directories ignored by tooling.

private static getToolingExcludedDirectoryNames([ string  $baseDir = '']) : array<int, string>
Parameters
$baseDir : string = ''

Description

the optional repository base directory used to relativize a custom workspace

Return values
array<int, string>