Overview

Namespaces

  • Charcoal
    • Ui
      • Dashboard
      • Form
      • FormGroup
      • FormInput
      • Layout
      • Menu
      • MenuItem
      • ServiceProvider

Classes

  • AbstractLayout
  • GenericLayout
  • LayoutBuilder
  • LayoutConfig
  • LayoutFactory

Interfaces

  • LayoutAwareInterface
  • LayoutInterface

Traits

  • LayoutAwareTrait
  • LayoutTrait
  • Overview
  • Namespace
  • Class

Trait LayoutAwareTrait

Provides an implementation of Charcoal\Ui\Layout\LayoutAwareInterface.

Direct Known Users

Charcoal\Ui\Dashboard\AbstractDashboard, Charcoal\Ui\Form\AbstractForm, Charcoal\Ui\FormGroup\AbstractFormGroup

Indirect Known Users

Charcoal\Ui\Dashboard\GenericDashboard, Charcoal\Ui\Form\GenericForm, Charcoal\Ui\FormGroup\GenericFormGroup
Namespace: Charcoal\Ui\Layout
Located at Charcoal/Ui/Layout/LayoutAwareTrait.php
Methods summary
public DashboardInterface
# setLayoutBuilder( Charcoal\Ui\Layout\LayoutBuilder $builder )

Parameters

$builder
The layout builder, to create customized layout object(s).

Returns

DashboardInterface
Chainable
public DashboardInterface
# setLayout( Charcoal\Ui\Layout\LayoutInterface|array $layout )

Parameters

$layout
The layout object or structure.

Returns

DashboardInterface
Chainable

Throws

InvalidArgumentException
If the layout argument is not an object or layout structure.
public Charcoal\Ui\Layout\LayoutInterface
# layout( )

Returns

Charcoal\Ui\Layout\LayoutInterface
Properties summary
protected Charcoal\Ui\Layout\LayoutBuilder $layoutBuilder

$layoutBuilder

$layoutBuilder

#
API documentation generated by ApiGen