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

Class ModelMetadata

Charcoal\Config\AbstractConfig
Extended by Charcoal\Model\AbstractMetadata implements Charcoal\Model\MetadataInterface
Extended by Charcoal\Model\ModelMetadata
Namespace: Charcoal\Model
Located at Charcoal/Model/ModelMetadata.php
Methods summary
public StructureMetadata
# setIdent( string $ident )

Set the metadata identifier.

Set the metadata identifier.

Parameters

$ident
The metadata identifier.

Returns

StructureMetadata
Chainable

Throws

InvalidArgumentException
If identifier is not a string.
public string
# ident( )

Retrieve the metadata identifier.

Retrieve the metadata identifier.

Returns

string
public Charcoal\Model\ModelMetadata
# setSources( array $sources )

Parameters

$sources
The available sources for this model.

Returns

Charcoal\Model\ModelMetadata
Chainable
public array
# sources( )

Returns

array
public Charcoal\Model\ModelMetadata
# addSource( string $sourceIdent, mixed $source )

Parameters

$sourceIdent
The source identifier.
$source
The source data.

Returns

Charcoal\Model\ModelMetadata
Chainable
public mixed
# source( string $sourceIdent )

Parameters

$sourceIdent
The source identifier to get.

Returns

mixed
public Charcoal\Model\ModelMetadata
# setDefaultSource( string $defaultSource )

Parameters

$defaultSource
The default source identifier.

Returns

Charcoal\Model\ModelMetadata
Chainable

Throws

InvalidArgumentException
If the argument is not a string.
public string
# defaultSource( )

Returns

string
Methods inherited from Charcoal\Model\AbstractMetadata
defaultData(), properties(), property(), propertyObject(), setDefaultData(), setProperties(), setPropertyObject()
Properties inherited from Charcoal\Model\AbstractMetadata
$defaultData, $properties, $propertiesObjects
API documentation generated by ApiGen