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

Class LayoutBuilder

Layout Builder

Namespace: Charcoal\Ui\Layout
Located at Charcoal/Ui/Layout/LayoutBuilder.php
Methods summary
public
# __construct( Charcoal\Factory\FactoryInterface $factory, Pimple\Container $container )

Return a new layout builder.

Return a new layout builder.

Parameters

$factory
A layout factory.
$container
The DI container.
public Charcoal\Ui\Layout\LayoutInterface
# build( array|ArrayAccess $options )

Build and return a new layout.

Build and return a new layout.

Parameters

$options
The layout build options.

Returns

Charcoal\Ui\Layout\LayoutInterface
Constants summary
string DEFAULT_TYPE

The default, concrete, layout model.

The default, concrete, layout model.

Const

string
# 'charcoal/ui/layout/generic'
Properties summary
protected Charcoal\Factory\FactoryInterface $factory

Store the layout factory instance.

Store the layout factory instance.

#
protected Pimple\Container $container

Store the dependency-injection container to fulfill the required services.

Store the dependency-injection container to fulfill the required services.

#
API documentation generated by ApiGen