Interface ConfigInterface

Interface \Klitsche\Dog\ConfigInterface

Methods

getWorkingDir()

public getWorkingDir (  ): string

Returns

string Absolute path to the current working directory

getSrcPaths()

public getSrcPaths (  ): array

Get a list of absolute paths to a source directory mapped to a list of matching (true) or not matching (false) patterns (regexp or string)

Returns

array Map of [baseDirectory => [ regexOrStringPattern => true (include) or false (exclude), ... ]]

See also

• \Klitsche\Dog\FilesCollector

• https://symfony.com/doc/current/components/finder.html

• Patterns to include or exclude paths

getTitle()

public getTitle (  ): string

Returns

string Title of your project

getPrinterClass()

public getPrinterClass (  ): string

Returns

string Full qualified class namespace of the used Printer

getOutputDir()

public getOutputDir (  ): string

Returns

string Absolute path to the output directory. Usually used by the Printer.

getPrinterConfig()

public getPrinterConfig (  ): array

Returns

array Generic assoc array [key => value, …]. Optionally used by the Printer.

isDebugEnabled()

public isDebugEnabled (  ): bool

Returns

bool Whether debug is enabled or not. Usually useful when tweaking twig templates to throw errors.

getRules()

public getRules (  ): array

Returns

array Configuration map [Rule Class => issue Level, …]

getCacheDir()

public getCacheDir (  ): string

Returns

string Path to cache dir. Usually used by the Printer for precompiled templates. Default: system tmp directory.

getEnrichers()

public getEnrichers (  ): array

Returns

array Generic assoc array [enricherClass => [key => value, …]] per enricher.

Implemented by

• \Klitsche\Dog\Config