Skip to content

Class Config

Class \Klitsche\Dog\Config

Methods

__construct()

public __construct ( 
    array $parameters, 
    string $workingDir
 ):
Parameters
parameters array
workingDir string

fromYamlFile()

public static fromYamlFile ( 
    string $file, 
    string $workingDir
 ): self
Parameters
file string
workingDir string
Returns
self

getCacheDir()

public getCacheDir (  ): string
Returns
string

getEnrichers()

public getEnrichers (  ): array
Returns
array

getOutputDir()

public getOutputDir (  ): string
Returns
string Absolute path to the output directory. Usually used by the Printer.

getPrinterClass()

public getPrinterClass (  ): string
Returns
string Full qualified class namespace of the used Printer

getPrinterConfig()

public getPrinterConfig (  ): array
Returns
array Generic assoc array [key => value, …]. Optionally used by the Printer.

getRules()

public getRules (  ): array
Returns
array Configuration map [Rule Class => issue Level, …]

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

getTitle()

public getTitle (  ): string
Returns
string Title of your project

getWorkingDir()

public getWorkingDir (  ): string
Returns
string Path to the current working directory

isDebugEnabled()

public isDebugEnabled (  ): bool
Returns
bool Whether debug is enabled or not. Usually useful when tweaking twig templates to throw errors.

Test Coverage 💚

  • 💚 Lines: 100% (35 / 35)
  • 💚 Methods: 100% (12 / 12)