BuildContextInterface
Exposes the minimal surface of Builder needed by Steps and Generators.
Making Builder implement this interface and typing dependencies against it reduces coupling and simplifies testing.
Table of Contents
Methods
- getAssetsList() : array<string|int, mixed>
- Returns list of assets path.
- getBuildOptions() : array<string|int, mixed>
- Returns build options.
- getConfig() : Config
- Returns configuration.
- getData() : array<string|int, mixed>
- Returns data collection.
- getLogger() : LoggerInterface
- Returns the logger instance.
- getPages() : Collection|null
- Returns pages collection.
- getPagesFiles() : Finder|null
- Returns pages files.
- getRenderer() : Twig
- Returns Renderer object.
- getTaxonomies() : Collection|null
- Returns taxonomies collection, for a language.
- isDebug() : bool
- Returns debug mode state.
- setData() : void
- Set collected data.
- setMenus() : void
- Set menus collection.
- setPages() : void
- Set/update Pages collection.
- setPagesFiles() : void
- Set collected pages files.
- setRenderer() : void
- Set renderer object.
- setStatic() : void
- Set collected static files.
- setTaxonomies() : void
- Set taxonomies collection.
Methods
getAssetsList()
Returns list of assets path.
public
getAssetsList() : array<string|int, mixed>
Return values
array<string|int, mixed>getBuildOptions()
Returns build options.
public
getBuildOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getConfig()
Returns configuration.
public
getConfig() : Config
Return values
ConfiggetData()
Returns data collection.
public
getData([string|null $language = null ]) : array<string|int, mixed>
Parameters
- $language : string|null = null
Return values
array<string|int, mixed>getLogger()
Returns the logger instance.
public
getLogger() : LoggerInterface
Return values
LoggerInterfacegetPages()
Returns pages collection.
public
getPages() : Collection|null
Return values
Collection|nullgetPagesFiles()
Returns pages files.
public
getPagesFiles() : Finder|null
Return values
Finder|nullgetRenderer()
Returns Renderer object.
public
getRenderer() : Twig
Return values
TwiggetTaxonomies()
Returns taxonomies collection, for a language.
public
getTaxonomies(string $language) : Collection|null
Parameters
- $language : string
Return values
Collection|nullisDebug()
Returns debug mode state.
public
isDebug() : bool
Return values
boolsetData()
Set collected data.
public
setData(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
setMenus()
Set menus collection.
public
setMenus(array<string|int, mixed> $menus) : void
Parameters
- $menus : array<string|int, mixed>
setPages()
Set/update Pages collection.
public
setPages(Collection $pages) : void
Parameters
- $pages : Collection
setPagesFiles()
Set collected pages files.
public
setPagesFiles(Finder $content) : void
Parameters
- $content : Finder
setRenderer()
Set renderer object.
public
setRenderer(Twig $renderer) : void
Parameters
- $renderer : Twig
setStatic()
Set collected static files.
public
setStatic(array<string|int, mixed> $static) : void
Parameters
- $static : array<string|int, mixed>
setTaxonomies()
Set taxonomies collection.
public
setTaxonomies(array<string|int, mixed> $taxonomies) : void
Parameters
- $taxonomies : array<string|int, mixed>