PHP Class Todaymade\Daux\Daux

Mostra file Open project: justinwalsh/daux.io Class Usage Examples

Public Properties

Property Type Description
$internal_base string
$local_base string
$options Config
$tree Todaymade\Daux\Tree\Root

Protected Properties

Property Type Description
$generator Todaymade\Daux\Format\Base\Generator
$processor Todaymade\Daux\Processor
$typeHandler Todaymade\Daux\ContentTypes\ContentTypeHandler
$validExtensions string[]

Public Methods

Method Description
__construct ( string $mode )
finalizeTree ( Directory $current, $prev = null )
generateTree ( ) Generate the tree that will be used
getConfigurationOverride ( $override_file )
getContentExtensions ( ) : string[] Get all content file extensions
getContentTypeHandler ( )
getGenerator ( ) : Todaymade\Daux\Format\Base\Generator
getGenerators ( )
getParams ( ) : Config
getProcessor ( ) : Todaymade\Daux\Processor
getProcessorClass ( )
initializeConfiguration ( string $override_file = null )
normalizeDocumentationPath ( $path )
normalizeThemePath ( $path )
setProcessor ( Todaymade\Daux\Processor $processor )
sortTree ( Directory $current )

Protected Methods

Method Description
loadBaseConfiguration ( ) Load and validate the global configuration
loadConfiguration ( string $config_file, boolean $optional = true )

Method Details

__construct() public method

public __construct ( string $mode )
$mode string

finalizeTree() public method

public finalizeTree ( Directory $current, $prev = null )
$current Todaymade\Daux\Tree\Directory

generateTree() public method

Generate the tree that will be used
public generateTree ( )

getConfigurationOverride() public method

public getConfigurationOverride ( $override_file )

getContentExtensions() public method

Get all content file extensions
public getContentExtensions ( ) : string[]
return string[]

getContentTypeHandler() public method

public getContentTypeHandler ( )

getGenerator() public method

public getGenerator ( ) : Todaymade\Daux\Format\Base\Generator
return Todaymade\Daux\Format\Base\Generator

getGenerators() public method

public getGenerators ( )

getParams() public method

public getParams ( ) : Config
return Config

getProcessor() public method

public getProcessor ( ) : Todaymade\Daux\Processor
return Todaymade\Daux\Processor

getProcessorClass() public method

public getProcessorClass ( )

initializeConfiguration() public method

public initializeConfiguration ( string $override_file = null )
$override_file string

loadBaseConfiguration() protected method

Load and validate the global configuration
protected loadBaseConfiguration ( )

loadConfiguration() protected method

protected loadConfiguration ( string $config_file, boolean $optional = true )
$config_file string
$optional boolean

normalizeDocumentationPath() public method

public normalizeDocumentationPath ( $path )

normalizeThemePath() public method

public normalizeThemePath ( $path )

setProcessor() public method

public setProcessor ( Todaymade\Daux\Processor $processor )
$processor Todaymade\Daux\Processor

sortTree() public method

public sortTree ( Directory $current )
$current Todaymade\Daux\Tree\Directory

Property Details

$generator protected_oe property

protected Generator,Todaymade\Daux\Format\Base $generator
return Todaymade\Daux\Format\Base\Generator

$internal_base public_oe property

public string $internal_base
return string

$local_base public_oe property

public string $local_base
return string

$options public_oe property

public Config,Todaymade\Daux $options
return Config

$processor protected_oe property

protected Processor,Todaymade\Daux $processor
return Todaymade\Daux\Processor

$tree public_oe property

public Root,Todaymade\Daux\Tree $tree
return Todaymade\Daux\Tree\Root

$typeHandler protected_oe property

protected ContentTypeHandler,Todaymade\Daux\ContentTypes $typeHandler
return Todaymade\Daux\ContentTypes\ContentTypeHandler

$validExtensions protected_oe property

protected string[] $validExtensions
return string[]