Overview

Namespaces

  • Charcoal
    • View
      • Mustache
      • Php
      • Twig

Classes

  • AbstractEngine
  • AbstractLoader
  • AbstractView
  • GenericView
  • Renderer
  • ViewConfig
  • ViewServiceProvider

Interfaces

  • EngineInterface
  • LoaderInterface
  • ViewableInterface
  • ViewInterface

Traits

  • ViewableTrait
  • Overview
  • Namespace
  • Class

Class ViewConfig

View configuration.

Charcoal\Config\AbstractConfig
Extended by Charcoal\View\ViewConfig
Namespace: Charcoal\View
Located at Charcoal/View/ViewConfig.php
Methods summary
public array
# defaults( )

Returns

array
public Charcoal\View\ViewConfig
# setPaths( array $paths )

Parameters

$paths
The paths to search into.

Returns

Charcoal\View\ViewConfig
Chainable
public Charcoal\View\ViewConfig
# addPath( string $path )

Parameters

$path
A path to add to the paths list.

Returns

Charcoal\View\ViewConfig
Chainable

Throws

InvalidArgumentException
If the path is not a string.
public array
# paths( )

Returns

array
public Charcoal\View\ViewConfig
# setEngines( array $engines )

Parameters

$engines
The various engines configuration.

Returns

Charcoal\View\ViewConfig
Chainable
public Charcoal\View\ViewConfig
# addEngine( string $engineIdent, array $engineConfig )

Parameters

$engineIdent
The engine identifier.
$engineConfig
The engine configuration data.

Returns

Charcoal\View\ViewConfig
Chainable

Throws

InvalidArgumentException
If the engine ident is not a string.
public array
# engines( )

Returns

array
public array
# engine( string|null $engineIdent = null )

Get an engine's configuration.

Get an engine's configuration.

Parameters

$engineIdent
The engine identifier to get the configuration of.

Returns

array

Throws

InvalidArgumentException
If the engine ident is not a string or does not match any engines.
public Charcoal\View\ViewConfig
# setDefaultEngine( string $engineIdent )

Parameters

$engineIdent
The default engine (identifier).

Returns

Charcoal\View\ViewConfig
Chainable

Throws

InvalidArgumentException
If the engine ident is not a string.
public string
# defaultEngine( )

Returns

string
API documentation generated by ApiGen