SignpostMarv\DaftObject\AbstractDaftObjectEasyDBRepository

Complexity

Total Complexity

28

Size/Duplication

Total Lines	237
Duplicated Lines	0 %

Test Coverage

Coverage

94.96%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	DaftObjectRepositoryByType()	0	21	3
A	__construct()	0	4	1
A	DaftObjectRepositoryByDaftObject()	0	9	2
A	DaftObjectExistsInDatabase()	0	19	2
B	RecallDaftObjectFromData()	0	34	4
C	RememberDaftObjectData()	0	93	12
B	RemoveDaftObjectById()	0	29	4

<?php
/**
* Base daft objects.
*
* @author SignpostMarv
*/
declare(strict_types=1);

namespace SignpostMarv\DaftObject;

use ParagonIE\EasyDB\EasyDB;
use RuntimeException;
use Throwable;

abstract class AbstractDaftObjectEasyDBRepository extends DaftObjectMemoryRepository
{
    /**
    * @var EasyDB
    */
    protected $db;

    protected function __construct(string $type, EasyDB $db)
    {
        parent::__construct($type);
        $this->db = $db;
    }

    public static function DaftObjectRepositoryByType(
        string $type,
        ? EasyDB $db = null
    ) : DaftObjectRepository {
        if (class_exists($type) === false) {
            throw new DaftObjectRepositoryTypeException(
                'Argument 1 passed to ' .

The call to SignpostMarv\DaftObject\DaftObjectRepositoryTypeException::__construct() has too many arguments starting with 'Argument 1 passed to ' . static::class . '::' . __FUNCTION__ . '() must be an implementation of ' . SignpostMarv\DaftObject\DefinesOwnIdPropertiesInterface::class . ', ' . $type . ' given.'.

                static::class .
                '::' .
                __FUNCTION__ .
                '() must be an implementation of ' .
                DefinesOwnIdPropertiesInterface::class .
                ', ' .
                $type .
                ' given.'
            );
        } elseif (($db instanceof EasyDB) === false) {
            throw new RuntimeException('Database connection not specified!');
        }

        return new static($type, $db);

It seems like $db can also be of type null; however, parameter $db of SignpostMarv\DaftObject\AbstractDaftObjectEasyDBRepository::__construct() does only seem to accept ParagonIE\EasyDB\EasyDB, maybe add an additional type check?

    }

    public static function DaftObjectRepositoryByDaftObject(
        DefinesOwnIdPropertiesInterface $object,
        ? EasyDB $db = null
    ) : DaftObjectRepository {
        if (($db instanceof EasyDB) === true) {
            return static::DaftObjectRepositoryByType(get_class($object), $db);
        }

        throw new RuntimeException('Database connection not specified!');
    }

    /**
    * @param mixed $id
    */
    public function RemoveDaftObjectById($id) : void
    {
        $id = array_values(is_array($id) ? $id : [$id]);
        $type = $this->type;
        $idkv = [];

        foreach (
            array_values($type::DaftObjectIdProperties()) as $i => $prop
        ) {
            $idkv[$prop] = $id[$i];
        }

        $where = [];
        foreach (array_keys($idkv) as $col) {
            $where[] = $this->db->escapeIdentifier($col) . ' = ?';
        }

        $query = (
            'DELETE FROM ' .
            $this->db->escapeIdentifier(
                $this->DaftObjectDatabaseTable()
            ) .
            ' WHERE ' .
            implode(' AND ', $where)
        );

        $this->db->safeQuery($query, array_values($idkv));

        $this->ForgetDaftObjectById($id);
    }

    abstract protected function DaftObjectDatabaseTable() : string;

    protected function RememberDaftObjectData(
        DefinesOwnIdPropertiesInterface $object
    ) : void {
        $id = [];

        foreach ($object::DaftObjectIdProperties() as $prop) {
            $id[$prop] = $object->$prop;
        }

        $autoStartTransaction = ($this->db->inTransaction() === false);

        if ($autoStartTransaction === true) {
            $this->db->beginTransaction();
        }

        try {
            $exists = $this->DaftObjectExistsInDatabase($id);
            if ($exists === false) {
                $cols = [];
                $values = [];

                foreach ($object::DaftObjectProperties() as $col) {
                    if (
                        method_exists(
                            $object,
                            'Get' . ucfirst($col)
                        ) === false
                    ) {
                        continue;
                    }
                    $cols[] = $this->db->escapeIdentifier($col);
                    $values[] = $object->$col;
                }

                $this->db->safeQuery(
                    (
                        'INSERT INTO ' .
                        $this->db->escapeIdentifier(
                            $this->DaftObjectDatabaseTable()
                        ) .
                        ' (' .
                        implode(', ', $cols) .
                        ') VALUES (' .
                        implode(', ', array_fill(0, count($cols), '?')) .
                        ')'
                    ),
                    $values
                );
            } else {
                $changed = $object->ChangedProperties();
                if (count($changed) > 0) {
                    $cols = [];
                    $values = [];

                    foreach ($changed as $col) {
                        $values[] = $object->$col;
                        $cols[] =
                            $this->db->escapeIdentifier($col) .
                            ' = ?';
                    }

                    $query =
                        'UPDATE ' .
                        $this->db->escapeIdentifier(
                            $this->DaftObjectDatabaseTable()
                        ) .
                        ' SET ' .
                        implode(', ', $cols);

                    $cols = [];

                    foreach ($id as $col => $value) {
                        $values[] = $value;
                        $cols[] =
                            $this->db->escapeIdentifier($col) .
                            ' = ?';
                    }

                    $query .= ' WHERE ' . implode(' AND ', $cols);

                    $this->db->safeQuery($query, $values);
                }
            }

            if ($autoStartTransaction === true) {
                $this->db->commit();
            }
        } catch (Throwable $e) {
            if ($autoStartTransaction === true) {
                $this->db->rollBack();
            }

            throw $e;
        }
    }

    /**
    * @param mixed $id
    */
    protected function RecallDaftObjectFromData($id) : ? DaftObject
    {
        $type = $this->type;
        $idkv = [];

        foreach (
            array_values($type::DaftObjectIdProperties()) as $i => $prop
        ) {
            $idkv[$prop] = $id[$i];
        }

        if ($this->DaftObjectExistsInDatabase($idkv) === true) {
            $where = [];
            foreach (array_keys($idkv) as $col) {
                $where[] = $this->db->escapeIdentifier($col) . ' = ?';
            }

            $data = $this->db->safeQuery(
                (
                    'SELECT * FROM ' .
                    $this->db->escapeIdentifier(
                        $this->DaftObjectDatabaseTable()
                    ) .
                    ' WHERE ' .
                    implode(' AND ', $where) .
                    ' LIMIT 1'
                ),
                array_values($idkv)
            );

            return new $type($data[0]);

The expression return new $type($data[0]) returns the type object which includes types incompatible with the type-hinted return null|SignpostMarv\DaftObject\DaftObject.

        }

        return null;
    }

    private function DaftObjectExistsInDatabase(array $id) : bool
    {
        $where = [];
        foreach (array_keys($id) as $col) {
            $where[] = $this->db->escapeIdentifier($col) . ' = ?';
        }

        return
            (int) $this->db->single(
                (
                    'SELECT COUNT(*) FROM ' .
                    $this->db->escapeIdentifier(
                        $this->DaftObjectDatabaseTable()
                    ) .
                    ' WHERE ' .
                    implode(' AND ', $where)
                ),
                array_values($id)
            ) >= 1;
    }
}