Helix\DB\Record

Complexity

Total Complexity

41

Size/Duplication

Total Lines	305
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	getAll()	0	2	1
A	getEach()	0	12	4
A	fromClass()	0	24	6
A	getEav()	0	2	1
A	saveInsert()	0	11	1
A	__construct()	0	24	5
A	setProto()	0	3	1
A	load()	0	11	2
A	getProto()	0	2	1
A	saveUpdate()	0	7	1
A	save()	0	9	2
A	saveEav()	0	6	3
A	select()	0	8	2
A	setValues()	0	4	2
A	getValues()	0	6	2
A	loadEav()	0	6	4
A	find()	0	10	3

<?php

namespace Helix\DB;

use Generator;
use Helix\DB;
use LogicException;
use ReflectionClass;
use ReflectionException;
use ReflectionProperty;

/**
 * Represents an "active record" table, derived from an annotated class implementing {@link EntityInterface}.
 *
 * Class Annotations:
 *
 * - `@record TABLE`
 *
 * Property Annotations:
 *
 * - `@col` or `@column`
 * - `@eav TABLE`
 *
 * Property value types are preserved as long as they are annotated with `@var`.
 */
class Record extends Table {

    /**
     * `[property => EAV]`
     *
     * @var EAV[]
     */
    protected $eav = [];

    /**
     * `[property => ReflectionProperty]`
     *
     * @var ReflectionProperty[]
     */
    protected $properties = [];

    /**
     * A boilerplate instance of the class, to clone and populate.
     * This defaults to a naively created instance without invoking the constructor.
     *
     * @var EntityInterface
     */
    protected $proto;

    /**
     * `[property => type]`
     *
     * @var array
     */
    protected $types = [];

    /**
     * @param DB $db
     * @param string|EntityInterface $class
     * @return Record
     */
    public static function fromClass (DB $db, $class) {
        try {
            $rClass = new ReflectionClass($class);
        }
        catch (ReflectionException $exception) {
            throw new LogicException('Unexpected ReflectionException', 0, $exception);
        }
        $columns = [];
        $eav = [];
        foreach ($rClass->getProperties() as $rProp) {
            $doc = $rProp->getDocComment();
            $name = $rProp->getName();
            if (preg_match('/@col(umn)?[\s$]/', $doc)) {
                $columns[] = $name;
            }
            elseif (preg_match('/@eav\s+(?<table>\S+)/', $doc, $attr)) {
                $eav[$name] = new EAV($db, $attr['table']);
            }
        }
        preg_match('/@record\s+(?<table>\S+)/', $rClass->getDocComment(), $record);
        if (!is_object($class)) {
            $class = $rClass->newInstanceWithoutConstructor();
        }
        return new static($db, $class, $record['table'], $columns, $eav);
    }

    /**
     * @param DB $db
     * @param EntityInterface $proto
     * @param string $table
     * @param string[] $columns Property names.
     * @param EAV[] $eav Keyed by property name.
     */
    public function __construct (DB $db, EntityInterface $proto, string $table, array $columns, array $eav = []) {
        parent::__construct($db, $table, $columns);
        $this->proto = $proto;
        try {
            $rClass = new ReflectionClass($proto);
            foreach ($columns as $name) {
                $rProp = $rClass->getProperty($name);
                $rProp->setAccessible(true);
                $this->properties[$name] = $rProp;
                $this->types[$name] = 'string';
                if (preg_match('/@var\s+(?<type>[a-z]+)[\s$]/', $rProp->getDocComment(), $var)) {
                    $types[$name] = $var['type'];
                }
            }
            $this->types['id'] = 'int';
            $this->eav = $eav;
            foreach (array_keys($eav) as $name) {
                $rProp = $rClass->getProperty($name);
                $rProp->setAccessible(true);
                $this->properties[$name] = $rProp;
            }
        }
        catch (ReflectionException $exception) {
            throw new LogicException('Unexpected ReflectionException', 0, $exception);
        }
    }

    /**
     * Returns a {@link Select}.
     *
     * @see DB::match()
     *
     * @param array $match `[property => mixed]`
     * @param array[] $eavMatch `[eav property => attribute => mixed]`
     * @return Select
     */
    public function find (array $match, array $eavMatch = []) {
        $select = $this->select();
        foreach ($match as $a => $b) {
            $select->where($this->db->match($this[$a] ?? $a, $b));
        }
        foreach ($eavMatch as $property => $attributes) {
            $inner = $this->getEav($property)->find($attributes);
            $select->join($inner, $inner['entity']->isEqual($this['id']));
        }
        return $select;
    }

    /**
     * Fetches from a statement into clones of the entity prototype.
     *
     * @param Statement $statement
     * @return EntityInterface[] Enumerated
     */
    public function getAll (Statement $statement): array {
        return iterator_to_array($this->getEach($statement));
    }

    /**
     * Fetches in chunks and yields each loaded entity.
     * This is preferable over `fetchAll()` for iterating large result sets.
     *
     * @param Statement $statement
     * @return Generator
     */
    public function getEach (Statement $statement) {
        do {
            $entities = [];
            for ($i = 0; $i < 256 and false !== $row = $statement->fetch(); $i++) {
                $clone = clone $this->proto;
                $this->setValues($clone, $row);
                $entities[$row['id']] = $clone;
            }
            $this->loadEav($entities);
            yield from $entities;
        }
        while (!empty($entities));
    }

    /**
     * @param string $property
     * @return EAV
     */
    final public function getEav (string $property) {
        return $this->eav[$property];
    }

    /**
     * @return EntityInterface
     */
    public function getProto () {
        return $this->proto;
    }

    /**
     * @param EntityInterface $entity
     * @return array
     */
    protected function getValues (EntityInterface $entity): array {
        $values = [];
        foreach (array_keys($this->columns) as $name) {
            $values[$name] = $this->properties[$name]->getValue($entity);
        }
        return $values;
    }

    /**
     * Loads all data for a given ID into a clone of the prototype.
     *
     * @param int $id
     * @return null|EntityInterface
     */
    public function load (int $id) {
        $load = $this->cache(__FUNCTION__, function() {
            return $this->select(array_keys($this->columns))->where('id = ?')->prepare();
        });
        if ($values = $load([$id])->fetch()) {
            $entity = clone $this->proto;
            $this->setValues($entity, $values);
            $this->loadEav([$id => $entity]);
            return $entity;
        }
        return null;
    }

    /**
     * Loads and sets all EAV properties for an array of entities keyed by ID.
     *
     * @param EntityInterface[] $entities
     */
    protected function loadEav (array $entities): void {
        $ids = array_keys($entities);
        foreach ($this->eav as $name => $eav) {
            foreach ($eav->loadAll($ids) as $id => $values) {
                if (!empty($values)) {
                    $this->properties[$name]->setValue($entities[$id], $values);
                }
            }
        }
    }

    /**
     * Upserts record and EAV data.
     *
     * @param EntityInterface $entity
     * @return int ID
     */
    public function save (EntityInterface $entity): int {
        if (!$entity->getId()) {
            $this->saveInsert($entity);
        }
        else {
            $this->saveUpdate($entity);
        }
        $this->saveEav($entity);
        return $entity->getId();
    }

    /**
     * @param EntityInterface $entity
     */
    protected function saveEav (EntityInterface $entity): void {
        $id = $entity->getId();
        foreach ($this->eav as $name => $eav) {
            $values = $this->properties[$name]->getValue($entity);
            if (isset($values)) {
                $eav->save($id, $values);
            }
        }
    }

    /**
     * Inserts a new row and updates the entity's ID.
     *
     * @param EntityInterface $entity
     */
    protected function saveInsert (EntityInterface $entity): void {
        $insert = $this->cache(__FUNCTION__, function() {
            $slots = SQL::slots(array_keys($this->columns));
            unset($slots['id']);
            $columns = implode(',', array_keys($slots));
            $slots = implode(',', $slots);
            return $this->db->prepare("INSERT INTO {$this} ({$columns}) VALUES ({$slots})");
        });
        $values = $this->getValues($entity);
        unset($values['id']);
        $this->properties['id']->setValue($entity, $insert($values)->getId());
    }

    /**
     * Updates the existing row for the entity.
     *
     * @param EntityInterface $entity
     */
    protected function saveUpdate (EntityInterface $entity): void {
        $this->cache(__FUNCTION__, function() {
            $slots = SQL::slotsEqual(array_keys($this->columns));
            unset($slots['id']);
            $slots = implode(', ', $slots);
            return $this->db->prepare("UPDATE {$this} SET {$slots} WHERE id = :id");
        })->execute($this->getValues($entity));
    }

    /**
     * Sets the fetcher if the default columns are used.
     *
     * @param array $columns Defaults to all columns.
     * @return Select
     */
    public function select (array $columns = []) {
        $select = parent::select($columns);
        if (empty($columns)) {
            $select->setFetcher(function(Statement $statement) {
                yield from $this->getEach($statement);
            });
        }
        return $select;
    }

    /**
     * @param EntityInterface $proto
     * @return $this
     */
    public function setProto (EntityInterface $proto) {
        $this->proto = $proto;
        return $this;
    }

    /**
     * @param EntityInterface $entity
     * @param array $values
     */
    protected function setValues (EntityInterface $entity, array $values): void {
        foreach ($values as $name => $value) {
            settype($value, $this->types[$name]);
            $this->properties[$name]->setValue($entity, $value);
        }
    }
}