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

  • Legend
  • Palette
  • PaletteCollection
  • PaletteFactory
  • Property

Interfaces

  • LegendInterface
  • PaletteCollectionInterface
  • PaletteInterface
  • PropertyInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class Property

A property contained within a palette.

DcGeneral\DataDefinition\Palette\Property implements DcGeneral\DataDefinition\Palette\PropertyInterface
Namespace: DcGeneral\DataDefinition\Palette
Package: DcGeneral\DataDefinition\Palette
Located at DataDefinition/Palette/Property.php
Methods summary
public
# __construct( string $name )

Create a new instance.

Create a new instance.

Parameters

$name
string
$name The name of the property.
public DcGeneral\DataDefinition\Palette\PropertyInterface
# setName( string $name )

Set the name of the property.

Set the name of the property.

Parameters

$name
string
$name The name of the property.

Returns

DcGeneral\DataDefinition\Palette\PropertyInterface

Implementation of

DcGeneral\DataDefinition\Palette\PropertyInterface::setName()
public string
# getName( )

Return the name of the property.

Return the name of the property.

Returns

string

Implementation of

DcGeneral\DataDefinition\Palette\PropertyInterface::getName()
public boolean
# isVisible( DcGeneral\Data\ModelInterface $model = null, DcGeneral\Data\PropertyValueBag $input = null )

Check the conditions, if this property is visible.

Check the conditions, if this property is visible.

Parameters

$model
DcGeneral\Data\ModelInterface|null
$model If given, sub palettes will be evaluated depending on the model. If no model is given, all properties will be returned, including sub palette properties.
$input
DcGeneral\Data\PropertyValueBag
$input If given, sub palettes will be evaluated depending on the input data. If no model and no input data is given, all properties will be returned, including sub palette properties.

Returns

boolean

Implementation of

DcGeneral\DataDefinition\Palette\PropertyInterface::isVisible()
public boolean
# isEditable( DcGeneral\Data\ModelInterface $model = null, DcGeneral\Data\PropertyValueBag $input = null )

Check the conditions, if this property is editable.

Check the conditions, if this property is editable.

Parameters

$model
DcGeneral\Data\ModelInterface|null
$model If given, sub palettes will be evaluated depending on the model. If no model is given, all properties will be returned, including sub palette properties.
$input
DcGeneral\Data\PropertyValueBag
$input If given, sub palettes will be evaluated depending on the input data. If no model and no input data is given, all properties will be returned, including sub palette properties.

Returns

boolean

Implementation of

DcGeneral\DataDefinition\Palette\PropertyInterface::isEditable()
public DcGeneral\DataDefinition\Palette\PropertyInterface
# setVisibleCondition( DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface $condition = null )

Set the visible condition for this property.

Set the visible condition for this property.

Parameters

$condition
DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface
$condition The condition.

Returns

DcGeneral\DataDefinition\Palette\PropertyInterface

Implementation of

DcGeneral\DataDefinition\Palette\PropertyInterface::setVisibleCondition()
public DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface
# getVisibleCondition( )

Get the visible condition for this property.

Get the visible condition for this property.

Returns

DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface

Implementation of

DcGeneral\DataDefinition\Palette\PropertyInterface::getVisibleCondition()
public DcGeneral\DataDefinition\Palette\PropertyInterface
# setEditableCondition( DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface $condition = null )

Set the editable condition for this property.

Set the editable condition for this property.

Parameters

$condition
DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface
$condition The condition.

Returns

DcGeneral\DataDefinition\Palette\PropertyInterface

Implementation of

DcGeneral\DataDefinition\Palette\PropertyInterface::setEditableCondition()
public DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface
# getEditableCondition( )

Get the editable condition for this property.

Get the editable condition for this property.

Returns

DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface

Implementation of

DcGeneral\DataDefinition\Palette\PropertyInterface::getEditableCondition()
public
# __clone( )

Create a deep clone of the property.

Create a deep clone of the property.

Implementation of

DcGeneral\DataDefinition\Palette\PropertyInterface::__clone()
Properties summary
protected string $name
#

The name of the property.

The name of the property.

protected DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface $visibleCondition
#

The condition to be examined to determine if this property is visible.

The condition to be examined to determine if this property is visible.

protected DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface $editableCondition
#

The condition to be examined to determine if this property is editable.

The condition to be examined to determine if this property is editable.

contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0