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

  • RenderReadablePropertyValueEvent
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class RenderReadablePropertyValueEvent

This event is emitted when a property value of a model shall be transformed into a readable string representation.

Symfony\Component\EventDispatcher\Event
Extended by DcGeneral\Event\AbstractEnvironmentAwareEvent implements DcGeneral\EnvironmentAwareInterface
Extended by DcGeneral\Event\AbstractModelAwareEvent implements DcGeneral\ModelAwareInterface
Extended by DcGeneral\View\Event\RenderReadablePropertyValueEvent
Namespace: DcGeneral\View\Event
Package: DcGeneral\View\Event
Located at View/Event/RenderReadablePropertyValueEvent.php
Methods summary
public
# __construct( DcGeneral\EnvironmentInterface $environment, DcGeneral\Data\ModelInterface $model, DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $property, mixed $value )

Create a new instance.

Create a new instance.

Parameters

$environment
DcGeneral\EnvironmentInterface
$environment The environment in use.
$model
DcGeneral\Data\ModelInterface
$model The model the value originates from.
$property
DcGeneral\DataDefinition\Definition\Properties\PropertyInterface
$property The property to transform.
$value
mixed
$value The value to transform.

Overrides

DcGeneral\Event\AbstractModelAwareEvent::__construct()
public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface
# getProperty( )

Retrieve the property.

Retrieve the property.

Returns

DcGeneral\DataDefinition\Definition\Properties\PropertyInterface
public mixed
# getValue( )

Retrieve the value.

Retrieve the value.

Returns

mixed
public DcGeneral\View\Event\RenderReadablePropertyValueEvent
# setRendered( null|string $rendered )

Set the rendered value.

Set the rendered value.

Parameters

$rendered
null|string
$rendered The rendered string representation or null to clear the representation.

Returns

DcGeneral\View\Event\RenderReadablePropertyValueEvent
public null|string
# getRendered( )

Retrieve the rendered string representation.

Retrieve the rendered string representation.

Returns

null|string
Methods inherited from DcGeneral\Event\AbstractModelAwareEvent
getModel()
Methods inherited from DcGeneral\Event\AbstractEnvironmentAwareEvent
getEnvironment()
Constants summary
string NAME 'dc-general.view.contao2backend.render-readable-property-value'
#
Properties summary
protected DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $property
#

The property that shall be transformed.

The property that shall be transformed.

protected mixed $value
#

The value that shall be transformed.

The value that shall be transformed.

protected string|null $rendered null
#

The transformed string representation.

The transformed string representation.

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