mindplay\sql\model\components\Mappers

Complexity

Total Complexity

3

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Test Coverage

Coverage

33.33%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	map()	0	5	1
A	mapBatches()	0	5	1
A	mapRecords()	0	5	1

<?php

namespace mindplay\sql\model\components;

use mindplay\sql\framework\Mapper;
use mindplay\sql\framework\mappers\BatchMapper;
use mindplay\sql\framework\mappers\RecordMapper;

/**
 * This trait implements support for mapping of results.
 */
trait Mappers
{
    /**
     * @var Mapper[] list of Mappers
     */
    protected array $mappers = [];

    /**
     * Append a Mapper instance to apply when each batch of a record-set is fetched.
     *
     * @param Mapper $mapper
     *
     * @see mapRecords() to map an anonymous function against every record
     * @see mapBatches() to map an anonymous function against each batch of records
     *                   
     * @return $this
     */
    public function map(Mapper $mapper): static
    {
        $this->mappers[] = $mapper;
        
        return $this;
    }

    /**
     * Map an anonymous function against every record.
     *
     * @param callable $mapper function (mixed $record) : mixed
     *
     * @see mapBatches() to map an anonymous function against each batch of records
     *                   
     * @return $this
     */
    public function mapRecords(callable $mapper): static
    {
        $this->mappers[] = new RecordMapper($mapper);
        
        return $this;
    }

    /**
     * Map an anonymous function against each batch of records.
     *
     * @param callable $mapper function (array $record_set) : array
     *
     * @see mapRecords() to map an anonymous function against every record
     *                   
     * @return $this
     */
    public function mapBatches(callable $mapper): static
    {
        $this->mappers[] = new BatchMapper($mapper);
        
        return $this;
    }
}