API Documentation
\
Charcoal
Admin
Action
Account
Object
System
Widget
Table
Object
Property
Display
Input
Selectize
Script
Notification
Object
Table
Translation
User
AclRole
Service
ServiceProvider
Template
Account
Object
System
Ui
Sidemenu
User
Widget
Dialog
FormGroup
Graph

\Charcoal\Admin\UiStructureContainerTrait

An implementation, as Trait, of the {@see \Charcoal\Admin\Ui\StructureContainerInterface}.

Summary

Methods
Properties
Constants
setDisplay()
display()
displays()
setShowEmpty()
showEmpty()
No public properties found
No constants found
supportedDisplayLayouts()
defaultDisplay()
$display
$showEmpty
N/A
No private methods found
No private properties found
N/A

Properties

$display

$display : string|null

How to display the structure properties.

Type

string|null

$showEmpty

$showEmpty : boolean

How to display an empty structure.

Type

boolean

Methods

setDisplay()

setDisplay(string  $display) : self

Set the property's display layout.

Parameters

string $display

The layout for the tickable elements.

Throws

\InvalidArgumentException

If the given layout is invalid.

\OutOfBoundsException

If the given layout is unsupported.

Returns

self

display()

display() : string|null

Retrieve the property's display layout.

Returns

string|null

displays()

displays() : array

Retrieve the display layouts; for templating.

Returns

array

setShowEmpty()

setShowEmpty(boolean  $show) : self

Show/hide the notice when the structure is empty.

Parameters

boolean $show

Show (TRUE) or hide (FALSE) the notice.

Returns

self

showEmpty()

showEmpty() : boolean

Determine if a notice should be displayed when the structure is empty.

Returns

boolean

supportedDisplayLayouts()

supportedDisplayLayouts() : array

Retrieve the supported display layouts.

Returns

array

defaultDisplay()

defaultDisplay() : array

Retrieve the default display layout.

Returns

array