Overview

Namespaces

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

Classes

  • AbstractUiItem
  • UiItemConfig

Interfaces

  • UiGroupingInterface
  • UiItemInterface

Traits

  • UiGroupingTrait
  • UiItemTrait
  • Overview
  • Namespace
  • Class

Class AbstractUiItem

An abstract UI Item.

Abstract implementation of Charcoal\Ui\UiItemInterface.

Charcoal\Config\AbstractEntity
Extended by Charcoal\Ui\AbstractUiItem implements Charcoal\User\AuthAwareInterface, Psr\Log\LoggerAwareInterface, Charcoal\Ui\UiItemInterface uses Charcoal\User\AuthAwareTrait (not available) Psr\Log\LoggerAwareTrait (not available) Charcoal\Translator\TranslatorAwareTrait (not available) Charcoal\Ui\UiItemTrait, Charcoal\View\ViewableTrait (not available)

Direct known subclasses

Charcoal\Ui\Dashboard\AbstractDashboard, Charcoal\Ui\Form\AbstractForm, Charcoal\Ui\FormGroup\AbstractFormGroup, Charcoal\Ui\FormInput\AbstractFormInput, Charcoal\Ui\Menu\AbstractMenu, Charcoal\Ui\MenuItem\AbstractMenuItem

Indirect known subclasses

Charcoal\Ui\Dashboard\GenericDashboard, Charcoal\Ui\Form\GenericForm, Charcoal\Ui\FormGroup\GenericFormGroup, Charcoal\Ui\FormInput\GenericFormInput, Charcoal\Ui\Menu\GenericMenu, Charcoal\Ui\MenuItem\GenericMenuItem
Abstract
Namespace: Charcoal\Ui
Located at Charcoal/Ui/AbstractUiItem.php
Methods summary
public
# __construct( array $data = null )

Return a new UI item.

Return a new UI item.

Parameters

$data
The class depdendencies.
public
# setDependencies( Pimple\Container $container )

Inject dependencies from a DI Container.

Inject dependencies from a DI Container.

Parameters

$container
A dependencies container instance.
public Charcoal\Ui\AbstractUiItem
# setActive( boolean $active )

Activates/deactivates the UI item.

Activates/deactivates the UI item.

Parameters

$active
Activate (TRUE) or deactivate (FALSE) the UI item.

Returns

Charcoal\Ui\AbstractUiItem
Chainable

Implementation of

Charcoal\Ui\UiItemInterface::setActive()
public boolean
# active( )

Determine if the UI item is active.

Determine if the UI item is active.

Returns

boolean

Implementation of

Charcoal\Ui\UiItemInterface::active()
Methods inherited from Charcoal\Ui\UiItemInterface
description(), notes(), setDescription(), setNotes(), setShowDescription(), setShowFooter(), setShowHeader(), setShowNotes(), setShowSubtitle(), setShowTitle(), setSubtitle(), setTemplate(), setTitle(), setType(), showDescription(), showFooter(), showHeader(), showNotes(), showSubtitle(), showTitle(), subtitle(), template(), title(), type()
Methods used from Charcoal\Ui\UiItemTrait
description(), icon(), notes(), setDescription(), setIcon(), setNotes(), setShowDescription(), setShowFooter(), setShowHeader(), setShowNotes(), setShowSubtitle(), setShowTitle(), setSubtitle(), setTemplate(), setTitle(), setType(), showDescription(), showFooter(), showHeader(), showNotes(), showSubtitle(), showTitle(), subtitle(), template(), title(), translator(), type()
API documentation generated by ApiGen