Config class - Documentation for Pelzini

Search documentation

Info Page:

Page options:

Inherited members

class Config

Stores the processor configuration

File: /processor/config.php
Namespace: processor
Available since:

Authors

Josh Heidenreich

Variables

Name	Visibility	Description
`$base_directory`
`$docs_directory`
`$exclude_directories`
`$license_text`
`$outputters`
`$project_code`
`$project_name`
`$transformers`

Functions

Name	Visibility	Description
getBaseDirectory	public
getDocsDirectory	public
getExcludeDirectories	public
getLicenseText	public
getOutputters	public
getProjectCode	public
getProjectName	public
getTransformers	public
load	public	Load and validate a config file
loadSharedDatabaseConfig	private	If no outputters have been specified, load the common "database.config.php" file

public getBaseDirectory

string $Config->getBaseDirectory ( );

This function does not have a description

public getDocsDirectory

string $Config->getDocsDirectory ( );

This function does not have a description

public getExcludeDirectories

string $Config->getExcludeDirectories ( );

This function does not have a description

public getLicenseText

string $Config->getLicenseText ( );

This function does not have a description

public getOutputters

array $Config->getOutputters ( );

This function does not have a description

public getProjectCode

string $Config->getProjectCode ( );

This function does not have a description

public getProjectName

string $Config->getProjectName ( );

This function does not have a description

public getTransformers

array $Config->getTransformers ( );

This function does not have a description

public load

bool $Config->load ( string $filename );

Load and validate a config file

private loadSharedDatabaseConfig

Outputter|null $Config->loadSharedDatabaseConfig ( );

If no outputters have been specified, load the common "database.config.php" file
and use the settings in there to create one