interface mapper_interface

Interface Mapper.

Contract for Data Mappers that convert between Database Records (stdClass) and Domain Entities.

Methods

db_to_domain(stdClass $record, array $metadata)

Convert a raw DB record (and optional metadata) into a Domain Entity.

domain_to_db(entity_interface $entity)

Convert a Domain Entity into a raw DB record for persistence.

Details

at line 41
entity_interface db_to_domain(stdClass $record, array $metadata)

Convert a raw DB record (and optional metadata) into a Domain Entity.

Parameters

stdClass $record

The raw row from the database (e.g., from $DB->get_record)

array $metadata

Key-value array of related metadata

Return Value

entity_interface

The hydrated Domain Entity

at line 51
stdClass domain_to_db(entity_interface $entity)

Convert a Domain Entity into a raw DB record for persistence.

Note: This usually returns the record for the main table only.

Parameters

entity_interface $entity

Return Value

stdClass