Helix\DB\Junction

Complexity

Total Complexity

10

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	unlink()	0	2	1
A	link()	0	16	2
A	fromInterface()	0	16	4
A	find()	0	8	2

<?php

namespace Helix\DB;

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

/**
 * Represents a junction table, derived from an annotated interface.
 *
 * Interface Annotations:
 *
 * - `@junction TABLE`
 * - `@foreign COLUMN CLASS` or `@for COLUMN CLASS`
 *
 * @method static static factory(DB $db, string $table, array $classes)
 */
class Junction extends Table {

    /**
     * `[column => class]`
     *
     * @var string[]
     */
    protected $classes = [];

    /**
     * @param DB $db
     * @param string $interface
     * @return Junction
     */
    public static function fromInterface (DB $db, string $interface) {
        try {
            $ref = new ReflectionClass($interface);
        }
        catch (ReflectionException $exception) {
            throw new LogicException('Unexpected ReflectionException', 0, $exception);
        }
        $doc = $ref->getDocComment();
        $classes = [];
        foreach (explode("\n", $doc) as $line) {
            if (preg_match('/@for(eign)?\s+(?<column>\S+)\s+(?<class>\S+)/', $line, $foreign)) {
                $classes[$foreign['column']] = $foreign['class'];
            }
        }
        preg_match('/@junction\s+(?<table>\S+)/', $doc, $junction);
        return static::factory($db, $junction['table'], $classes);
    }

    /**
     * @param DB $db
     * @param string $table
     * @param string[] $classes
     */
    public function __construct (DB $db, string $table, array $classes) {
        parent::__construct($db, $table, array_keys($classes));
        $this->classes = $classes;
    }

    /**
     * Returns a {@link Select} for entities referenced by a foreign key.
     *
     * The {@link Select} is literal and can be iterated directly.
     *
     * @param string $key The column referencing the class to collect.
     * @param array $match Keyed by junction column.
     * @return Select
     */
    public function find (string $key, array $match = []) {
        $record = $this->db->getRecord($this->classes[$key]);
        $select = $record->select();
        $select->join($this, $this[$key]->isEqual($record['id']));
        foreach ($match as $a => $b) {
            $select->where($this->db->match($this[$a], $b));
        }
        return $select;
    }

    /**
     * `INSERT IGNORE` to link entities.
     *
     * @param int[] $ids Keyed by column.
     * @return int Rows affected.
     */
    public function link (array $ids): int {
        $statement = $this->cache(__FUNCTION__, function() {
            $columns = implode(',', array_keys($this->columns));
            $slots = implode(',', SQL::slots(array_keys($this->columns)));
            if ($this->db->isSQLite()) {
                return $this->db->prepare(
                    "INSERT OR IGNORE INTO {$this} ({$columns}) VALUES ({$slots})"
                );
            }
            return $this->db->prepare(
                "INSERT IGNORE INTO {$this} ({$columns}) VALUES ({$slots})"
            );
        });
        $affected = $statement($ids)->rowCount();
        $statement->closeCursor();
        return $affected;
    }

    /**
     * Alias for {@link delete()}
     *
     * @param array $ids Keyed by Column
     * @return int Rows affected
     */
    public function unlink (array $ids): int {
        return $this->delete($ids);
    }
}