Overview

Namespaces

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

Classes

  • AbstractTemplate
  • AbstractWidget
  • WidgetBuilder

Interfaces

  • TemplateInterface
  • WidgetInterface
  • Overview
  • Namespace
  • Class

Interface WidgetInterface

Direct known implementers

Charcoal\App\Template\AbstractWidget
Namespace: Charcoal\App\Template
Located at Charcoal/App/Template/WidgetInterface.php
Methods summary
public
# setDependencies( Pimple\Container $container )

Give an opportunity to children classes to inject dependencies from a Pimple Container.

Give an opportunity to children classes to inject dependencies from a Pimple Container.

Does nothing by default, reimplement in children classes.

The $container DI-container (from Pimple) should not be saved or passed around, only to be used to inject dependencies (typically via setters).

Parameters

$container
A dependencies container instance.
public Charcoal\App\Template\WidgetInterface
# setData( array $data )

Parameters

$data
The template data to set.

Returns

Charcoal\App\Template\WidgetInterface
Chainable
public Charcoal\App\Template\WidgetInterface
# setActive( boolean $active )

Parameters

$active
The active flag.

Returns

Charcoal\App\Template\WidgetInterface
Chainable
public boolean
# active( )

Returns

boolean
API documentation generated by ApiGen