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

  • DefaultBasicDefinition
  • DefaultDataProviderDefinition
  • DefaultModelRelationshipDefinition
  • DefaultPalettesDefinition
  • DefaultPropertiesDefinition

Interfaces

  • BasicDefinitionInterface
  • DataProviderDefinitionInterface
  • DefinitionInterface
  • ModelRelationshipDefinitionInterface
  • PalettesDefinitionInterface
  • PropertiesDefinitionInterface
  • ViewDefinitionInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class DefaultPropertiesDefinition

Interface BasicDefinitionInterface

DcGeneral\DataDefinition\Definition\DefaultPropertiesDefinition implements DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface
Namespace: DcGeneral\DataDefinition\Definition
Package: DcGeneral\DataDefinition\Definition
Located at DataDefinition/Definition/DefaultPropertiesDefinition.php
Methods summary
public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface[]|array
# getProperties( )

Get all properties.

Get all properties.

Returns

DcGeneral\DataDefinition\Definition\Properties\PropertyInterface[]|array

Implementation of

DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface::getProperties()
public string[]|array
# getPropertyNames( )

Get all property names.

Get all property names.

Returns

string[]|array

Implementation of

DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface::getPropertyNames()
public DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface
# addProperty( DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $property )

Add a property information to the definition.

Add a property information to the definition.

Parameters

$property
DcGeneral\DataDefinition\Definition\Properties\PropertyInterface
$property The property information to add.

Returns

DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface

Throws

DcGeneral\Exception\DcGeneralInvalidArgumentException
When an invalid property has been passed or a property with the given name has already been registered.

Implementation of

DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface::addProperty()
public DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface
# removeProperty( DcGeneral\DataDefinition\Definition\Properties\PropertyInterface|string $property )

Remove a property information from the definition.

Remove a property information from the definition.

Parameters

$property
DcGeneral\DataDefinition\Definition\Properties\PropertyInterface|string
$property The information or the name of the property to remove.

Returns

DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface

Throws

DcGeneral\Exception\DcGeneralInvalidArgumentException
When an a property with the given name has not been registered.

Implementation of

DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface::removeProperty()
public boolean
# hasProperty( string $name )

Check if a property exists.

Check if a property exists.

Parameters

$name
string
$name The name of the property.

Returns

boolean

Implementation of

DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface::hasProperty()
public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface
# getProperty( string $name )

Get a property by name.

Get a property by name.

Parameters

$name
string
$name The name of the property.

Returns

DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Throws

DcGeneral\Exception\DcGeneralInvalidArgumentException
When an a property with the given name has not been registered.

Implementation of

DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface::getProperty()
public
# getIterator( )
Constants inherited from DcGeneral\DataDefinition\Definition\PropertiesDefinitionInterface
NAME
Properties summary
protected DcGeneral\DataDefinition\Definition\Properties\PropertyInterface[] $properties array()
#

The property definitions contained.

The property definitions contained.

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