Overview

Namespaces

  • DcGeneral
    • Clipboard
    • Contao
      • Callback
      • Compatibility
      • DataDefinition
        • Definition
      • Dca
        • Builder
          • Legacy
        • Definition
        • Palette
        • Populator
      • Event
      • View
        • Contao2BackendView
          • Event
    • Controller
    • Data
    • DataDefinition
      • Builder
      • Definition
        • Properties
        • View
          • Panel
      • ModelRelationship
      • Palette
        • Builder
          • Event
        • Condition
          • Palette
          • Property
    • EnvironmentPopulator
    • Event
    • Exception
    • Factory
      • Event
    • Panel
    • View
      • Event

Classes

  • BaseButtonEvent
  • BaseGetButtonsEvent
  • BuildWidgetEvent
  • DecodePropertyValueForWidgetEvent
  • EditModelBeforeSaveEvent
  • EncodePropertyValueFromWidgetEvent
  • GetBreadcrumbEvent
  • GetEditModeButtonsEvent
  • GetGlobalButtonEvent
  • GetGlobalButtonsEvent
  • GetGroupHeaderEvent
  • GetOperationButtonEvent
  • GetParentHeaderEvent
  • GetPasteButtonEvent
  • GetPasteRootButtonEvent
  • GetPropertyOptionsEvent
  • GetSelectModeButtonsEvent
  • ManipulateWidgetEvent
  • ModelToLabelEvent
  • ParentViewChildRecordEvent
  • ResolveWidgetErrorMessageEvent
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class ModelToLabelEvent

Class ModelToLabelEvent.

This event gets emitted when a model shall be translated to an html representation.

Symfony\Component\EventDispatcher\Event
Extended by DcGeneral\Event\AbstractEnvironmentAwareEvent implements DcGeneral\EnvironmentAwareInterface
Extended by DcGeneral\Event\AbstractModelAwareEvent implements DcGeneral\ModelAwareInterface
Extended by DcGeneral\Contao\View\Contao2BackendView\Event\ModelToLabelEvent
Namespace: DcGeneral\Contao\View\Contao2BackendView\Event
Package: DcGeneral\Contao\View\Contao2BackendView\Event
Located at Contao/View/Contao2BackendView/Event/ModelToLabelEvent.php
Methods summary
public DcGeneral\Contao\View\Contao2BackendView\Event\ModelToLabelEvent
# setArgs( array $args )

Set the arguments to use when generating the final string representation using the format string.

Set the arguments to use when generating the final string representation using the format string.

Parameters

$args
array
$args The arguments.

Returns

DcGeneral\Contao\View\Contao2BackendView\Event\ModelToLabelEvent
public array
# getArgs( )

Retrieve the arguments to use when generating the final string representation using the format string.

Retrieve the arguments to use when generating the final string representation using the format string.

Returns

array
public DcGeneral\Contao\View\Contao2BackendView\Event\ModelToLabelEvent
# setLabel( string $label )

Set the label for the model.

Set the label for the model.

This is a format string to use in vsprintf().

Parameters

$label
string
$label The label string.

Returns

DcGeneral\Contao\View\Contao2BackendView\Event\ModelToLabelEvent
public string
# getLabel( )

Get the label for the model.

Get the label for the model.

This is a format string to use in vsprintf().

Returns

string
public DcGeneral\Contao\View\Contao2BackendView\Event\ModelToLabelEvent
# setFormatter( DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface $listLabel )

Set the label information instance.

Set the label information instance.

Parameters

$listLabel
DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface
$listLabel The label information instance.

Returns

DcGeneral\Contao\View\Contao2BackendView\Event\ModelToLabelEvent
public DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface
# getFormatter( )

Retrieve the label information instance.

Retrieve the label information instance.

Returns

DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface
Methods inherited from DcGeneral\Event\AbstractModelAwareEvent
__construct(), getModel()
Methods inherited from DcGeneral\Event\AbstractEnvironmentAwareEvent
getEnvironment()
Constants summary
string NAME 'dc-general.view.contao2backend.model-to-label'
#
Properties summary
protected string $label
#

The label for the model.

The label for the model.

This is a format string to use in vsprintf().

protected DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface $listLabel
#

The label information instance.

The label information instance.

protected array $args
#

The arguments to use when building the label from the format string.

The arguments to use when building the label from the format string.

Properties inherited from DcGeneral\Event\AbstractModelAwareEvent
$model
Properties inherited from DcGeneral\Event\AbstractEnvironmentAwareEvent
$environment
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0