PHP Класс Todaymade\Daux\Daux

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$internal_base string
$local_base string
$options Config
$tree Todaymade\Daux\Tree\Root

Защищенные свойства (Protected)

Свойство Тип Описание
$generator Todaymade\Daux\Format\Base\Generator
$processor Todaymade\Daux\Processor
$typeHandler Todaymade\Daux\ContentTypes\ContentTypeHandler
$validExtensions string[]

Открытые методы

Метод Описание
__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 )

Защищенные методы

Метод Описание
loadBaseConfiguration ( ) Load and validate the global configuration
loadConfiguration ( string $config_file, boolean $optional = true )

Описание методов

__construct() публичный Метод

public __construct ( string $mode )
$mode string

finalizeTree() публичный Метод

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

generateTree() публичный Метод

Generate the tree that will be used
public generateTree ( )

getConfigurationOverride() публичный Метод

public getConfigurationOverride ( $override_file )

getContentExtensions() публичный Метод

Get all content file extensions
public getContentExtensions ( ) : string[]
Результат string[]

getContentTypeHandler() публичный Метод

public getContentTypeHandler ( )

getGenerator() публичный Метод

public getGenerator ( ) : Todaymade\Daux\Format\Base\Generator
Результат Todaymade\Daux\Format\Base\Generator

getGenerators() публичный Метод

public getGenerators ( )

getParams() публичный Метод

public getParams ( ) : Config
Результат Config

getProcessor() публичный Метод

public getProcessor ( ) : Todaymade\Daux\Processor
Результат Todaymade\Daux\Processor

getProcessorClass() публичный Метод

public getProcessorClass ( )

initializeConfiguration() публичный Метод

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

loadBaseConfiguration() защищенный Метод

Load and validate the global configuration
protected loadBaseConfiguration ( )

loadConfiguration() защищенный Метод

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

normalizeDocumentationPath() публичный Метод

public normalizeDocumentationPath ( $path )

normalizeThemePath() публичный Метод

public normalizeThemePath ( $path )

setProcessor() публичный Метод

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

sortTree() публичный Метод

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

Описание свойств

$generator защищенное свойство

protected Generator,Todaymade\Daux\Format\Base $generator
Результат Todaymade\Daux\Format\Base\Generator

$internal_base публичное свойство

public string $internal_base
Результат string

$local_base публичное свойство

public string $local_base
Результат string

$options публичное свойство

public Config,Todaymade\Daux $options
Результат Config

$processor защищенное свойство

protected Processor,Todaymade\Daux $processor
Результат Todaymade\Daux\Processor

$tree публичное свойство

public Root,Todaymade\Daux\Tree $tree
Результат Todaymade\Daux\Tree\Root

$typeHandler защищенное свойство

protected ContentTypeHandler,Todaymade\Daux\ContentTypes $typeHandler
Результат Todaymade\Daux\ContentTypes\ContentTypeHandler

$validExtensions защищенное свойство

protected string[] $validExtensions
Результат string[]