Overview

Namespaces

  • Charcoal
    • App
      • Action
      • Config
      • Handler
      • Middleware
      • Module
      • Route
      • Script
      • ServiceProvider
      • Template

Classes

  • AbstractHandler
  • Error
  • HandlerConfig
  • NotAllowed
  • NotFound
  • PhpError
  • Shutdown

Interfaces

  • HandlerInterface
  • Overview
  • Namespace
  • Class

Class HandlerConfig

Charcoal\Config\AbstractConfig
Extended by Charcoal\App\Handler\HandlerConfig
Namespace: Charcoal\App\Handler
Located at Charcoal/App/Handler/HandlerConfig.php
Methods summary
public Charcoal\App\Handler\HandlerConfig
# setTemplate( string|null $template )

Parameters

$template
The template identifier.

Returns

Charcoal\App\Handler\HandlerConfig
Chainable

Throws

InvalidArgumentException
If the tempalte parameter is not null or not a string.
public string
# template( )

Returns

string
public RouteConfig
# setController( string $controller )

Set handler view controller classname

Set handler view controller classname

Parameters

$controller
Handler controller name.

Returns

RouteConfig
Chainable

Throws

InvalidArgumentException
If the handler view controller is not a string.
public string
# controller( )

Get the view controller classname

Get the view controller classname

Returns

string
public string
# defaultController( )

Returns

string
public Charcoal\App\Handler\HandlerConfig
# setEngine( string|null $engine )

Parameters

$engine
The engine identifier (mustache, php, or mustache-php).

Returns

Charcoal\App\Handler\HandlerConfig
Chainable

Throws

InvalidArgumentException
If the engine is not null or not a string.
public string
# engine( )

Returns

string
public string
# defaultEngine( )

Returns

string
public Charcoal\App\Handler\HandlerConfig
# setTemplateData( array $templateData )

Set the template data for the view.

Set the template data for the view.

Parameters

$templateData
The route template data.

Returns

Charcoal\App\Handler\HandlerConfig
Chainable
public array
# templateData( )

Get the template data for the view.

Get the template data for the view.

Returns

array
public Charcoal\App\Handler\HandlerConfig
# setCache( boolean $cache )

Parameters

$cache
The cache enabled flag.

Returns

Charcoal\App\Handler\HandlerConfig
Chainable
public boolean
# cache( )

Returns

boolean
public Charcoal\App\Handler\HandlerConfig
# setCacheTtl( integer $ttl )

Parameters

$ttl
The cache Time-To-Live, in seconds.

Returns

Charcoal\App\Handler\HandlerConfig
Chainable
public integer
# cacheTtl( )

Returns

integer
API documentation generated by ApiGen