Overview

Namespaces

  • Charcoal
    • Loader
    • Model
      • Service
      • ServiceProvider
    • Source
      • Database
    • Validator

Classes

  • AbstractMetadata
  • AbstractModel
  • Collection
  • Model
  • ModelMetadata
  • ModelValidator

Interfaces

  • CollectionInterface
  • DescribableInterface
  • MetadataInterface
  • ModelInterface

Traits

  • DescribableTrait
  • Overview
  • Namespace
  • Class

Interface MetadataInterface

Defines a metadata container.

Metadata is typically used to describe an object.

Charcoal\Model\MetadataInterface implements Charcoal\Config\ConfigInterface

Direct known implementers

Charcoal\Model\AbstractMetadata

Indirect known implementers

Charcoal\Model\ModelMetadata
Namespace: Charcoal\Model
Located at Charcoal/Model/MetadataInterface.php
Methods summary
public Charcoal\Model\MetadataInterface
# setDefaultData( array $defaultData )

Set the object's default values.

Set the object's default values.

Parameters

$defaultData
An associative array.

Returns

Charcoal\Model\MetadataInterface
Chainable
public array
# defaultData( )

Retrieve the default values.

Retrieve the default values.

Returns

array
public array
# properties( )

Retrieve the properties.

Retrieve the properties.

Returns

array
public array|null
# property( string $propertyIdent )

Retrieve the given property.

Retrieve the given property.

Parameters

$propertyIdent
The property identifier.

Returns

array|null
public Charcoal\Model\MetadataInterface
# setPropertyObject( string $propertyIdent, Charcoal\Property\PropertyInterface $propertyObject )

Assign an instance of Charcoal\Property\PropertyInterface to the given property.

Assign an instance of Charcoal\Property\PropertyInterface to the given property.

Parameters

$propertyIdent
The property indentifer.
$propertyObject
The property, as object.

Returns

Charcoal\Model\MetadataInterface
Chainable
public Charcoal\Property\PropertyInterface|null
# propertyObject( string $propertyIdent )

Retrieve the given property as an object.

Retrieve the given property as an object.

Parameters

$propertyIdent
The property (identifier) to return, as an object.

Returns

Charcoal\Property\PropertyInterface|null
API documentation generated by ApiGen