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 DescribableInterface

Defines a model having metadata that allows the customization of objects.

Direct known implementers

Charcoal\Model\AbstractModel

Indirect known implementers

Charcoal\Model\Model
Namespace: Charcoal\Model
Located at Charcoal/Model/DescribableInterface.php
Methods summary
public Charcoal\Model\DescribableInterface
# setData( array $data )

Parameters

$data
The object data.

Returns

Charcoal\Model\DescribableInterface
Chainable
public Charcoal\Model\DescribableInterface
# setMetadataLoader( Charcoal\Model\Service\MetadataLoader $loader )

Parameters

$loader
The loader instance, used to load metadata.

Returns

Charcoal\Model\DescribableInterface
Chainable
public Charcoal\Model\DescribableInterface
# setMetadata( array|Charcoal\Model\MetadataInterface $metadata )

Parameters

$metadata
The matadata.

Returns

Charcoal\Model\DescribableInterface
Chainable
public Charcoal\Model\MetadataInterface
# metadata( )

Returns

Charcoal\Model\MetadataInterface
public Charcoal\Model\MetadataInterface
# loadMetadata( string $metadataIdent = null )

Parameters

$metadataIdent
The metadata ident to load. If null, generate from object.

Returns

Charcoal\Model\MetadataInterface
public Charcoal\Model\DescribableInterface
# setMetadataIdent( string $metadataIdent )

Parameters

$metadataIdent
Explicitely set the metadata ident.

Returns

Charcoal\Model\DescribableInterface
Chainable
public string
# metadataIdent( )

Returns

string
API documentation generated by ApiGen