\Charcoal\ModelMetadataInterface

Defines a metadata container.

Metadata is typically used to describe an object.

Summary

Methods

Constants

setDefaultData()
defaultData()
properties()
property()
setPropertyObject()
propertyObject()

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

setDefaultData()

setDefaultData(array  $defaultData) : \Charcoal\Model\MetadataInterface

Set the object's default values.

Parameters

array

$defaultData

An associative array.

Returns

\Charcoal\Model\MetadataInterface —

Chainable

defaultData()

defaultData() : array

Retrieve the default values.

Returns

array

properties()

properties() : array

Retrieve the properties.

Returns

array

property()

property(string  $propertyIdent) : array|null

Retrieve the given property.

Parameters

string

$propertyIdent

The property identifier.

Returns

array|null

setPropertyObject()

setPropertyObject(string  $propertyIdent, \Charcoal\Property\PropertyInterface  $propertyObject) : \Charcoal\Model\MetadataInterface

Assign an instance of {@see PropertyInterface} to the given property.

Parameters

string	$propertyIdent	The property indentifer.
\Charcoal\Property\PropertyInterface	$propertyObject	The property, as object.

Returns

\Charcoal\Model\MetadataInterface —

Chainable

propertyObject()

propertyObject(string  $propertyIdent) : \Charcoal\Property\PropertyInterface|null

Retrieve the given property as an object.

Parameters

string

$propertyIdent

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

Returns

\Charcoal\Property\PropertyInterface|null