Scrawler\Arca\Model

Complexity

Total Complexity

68

Size/Duplication

Total Lines	578
Duplicated Lines	0 %

Importance

Changes	15
Bugs	6	Features	0

39 Methods

Rating	Name	Duplication	Size	Complexity
A	equals()	0	3	2
A	getDataType()	0	9	1
A	beforeDelete()	0	2	1
A	determineIdType()	0	3	2
A	getRelationTable()	0	11	3
A	hasForeign()	0	5	1
A	hasIdError()	0	3	1
A	__unset()	0	3	1
A	getDefaultTableName()	0	4	1
A	unset()	0	5	1
A	afterDelete()	0	2	1
A	setRegularProperty()	0	6	1
A	getDbValue()	0	7	3
A	handleOwnRelation()	0	18	2
A	handleComplexRelation()	0	26	3
A	get()	0	25	5
A	isLoaded()	0	3	1
A	__construct()	0	10	1
A	with()	0	7	2
A	save()	0	6	1
A	validateRelationType()	0	4	2
A	set()	0	27	5
A	handleModelRelation()	0	11	2
A	delete()	0	5	1
A	createCollection()	0	15	4
A	beforeSave()	0	2	1
A	cleanModel()	0	7	1
A	__get()	0	3	1
A	handleSharedRelation()	0	37	3
A	__set()	0	3	1
A	initialize()	0	2	1
A	__isset()	0	3	1
A	afterSave()	0	2	1
A	extractRelationIds()	0	7	1
A	initializeProperties()	0	17	1
A	isset()	0	3	1
A	handleRelationalKey()	0	11	3
A	refresh()	0	7	2
A	determineIdsType()	0	11	2

<?php

/*
 * This file is part of the Scrawler package.
 *
 * (c) Pranjal Pandey <its.pranjalpandey@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Scrawler\Arca;

use Doctrine\DBAL\ArrayParameterType;
use Doctrine\DBAL\Connection;
use Doctrine\DBAL\ParameterType;
use Doctrine\DBAL\Types\Type;
use Scrawler\Arca\Manager\RecordManager;
use Scrawler\Arca\Manager\TableManager;
use Scrawler\Arca\Manager\WriteManager;
use Scrawler\Arca\Traits\Model\ArrayAccess;
use Scrawler\Arca\Traits\Model\Getter;
use Scrawler\Arca\Traits\Model\Iterator;
use Scrawler\Arca\Traits\Model\Setter;
use Scrawler\Arca\Traits\Model\Stringable;

/**
 * Model class that represents single record in database.
 *
 * @property int|string                        $id
 * @property array<string,array<string,mixed>> $__properties
 * @property array<string,mixed>               $__meta
 */
class Model implements \Stringable, \IteratorAggregate, \ArrayAccess
{
    use Iterator;
    use Stringable;
    use ArrayAccess;
    use Getter;
    use Setter;

    /**
     * Relation type constants.
     */
    private const RELATION_ONE_TO_MANY = 'otm';
    private const RELATION_ONE_TO_ONE = 'oto';
    private const RELATION_MANY_TO_MANY = 'mtm';

    /**
     * Property type constants.
     */
    private const TYPE_JSON = 'json_document';
    private const TYPE_TEXT = 'text';
    private const TYPE_FLOAT = 'float';

    /**
     * Relation keywords.
     */
    private const KEYWORD_OWN = 'own';
    private const KEYWORD_SHARED = 'shared';
    private const KEYWORD_LIST = 'list';

    /**
     * Valid relation types.
     */
    private const RELATION_TYPES = [
        self::RELATION_ONE_TO_MANY,
        self::RELATION_ONE_TO_ONE,
        self::RELATION_MANY_TO_MANY,
    ];

    /**
     * @var array<string,array<string,mixed>>
     */
    private array $__properties = [];

    /**
     * @var array<string,mixed>
     */
    private array $__meta = [];

    /**
     * Cache for relation table names.
     *
     * @var array<string,string>
     */
    private array $relationTableCache = [];

    private string $table;

    /**
     * Get table name from class name if not specified
     */
    public function __construct(
        ?string $table = null,
        private Connection $connection,
        private RecordManager $recordManager,
        private TableManager $tableManager,
        private WriteManager $writeManager,
    ) {
        $this->table = $table ?? $this->getDefaultTableName();
        $this->initializeProperties();
        $this->initialize();
    }

    /**
     * Get default table name from class name
     */
    private function getDefaultTableName(): string
    {
        $className = (new \ReflectionClass($this))->getShortName();
        return strtolower($className);
    }

    /**
     * Hook called after model initialization
     */
    protected function initialize(): void
    {
        // Override in child class if needed
    }

    /**
     * Hook called before saving the model
     */
    protected function beforeSave(): void
    {
        // Override in child class if needed
    }

    /**
     * Hook called after saving the model
     */
    protected function afterSave(): void
    {
        // Override in child class if needed
    }

    /**
     * Hook called before deleting the model
     */
    protected function beforeDelete(): void
    {
        // Override in child class if needed
    }

    /**
     * Hook called after deleting the model
     */
    protected function afterDelete(): void
    {
        // Override in child class if needed
    }

    /**
     * Initialize model properties and metadata.
     */
    private function initializeProperties(): void
    {
        $this->__properties = [
            'all' => [],
            'self' => [],
            'type' => [],
        ];

        $this->__meta = [
            'is_loaded' => false,
            'id_error' => false,
            'foreign_models' => [
                self::RELATION_ONE_TO_MANY => null,
                self::RELATION_ONE_TO_ONE => null,
                self::RELATION_MANY_TO_MANY => null,
            ],
            'id' => 0,
        ];
    }

    /**
     * adds the key to properties.
     */
    public function __set(string $key, mixed $val): void
    {
        $this->set($key, $val);
    }

    /**
     * Adds the key to properties.
     */
    public function set(string $key, mixed $val): void
    {
        // Handle ID setting
        if ('id' === $key) {
            $this->__meta['id'] = $val;
            $this->__meta['id_error'] = true;
            $this->setRegularProperty('id', $val);

            return;
        }

        // Handle model relations
        if ($val instanceof Model) {
            $this->handleModelRelation($key, $val);

            return;
        }

        // Handle complex relations (own/shared)
        if (0 !== \Safe\preg_match('/[A-Z]/', $key)) {
            if ($this->handleComplexRelation($key, $val)) {
                return;
            }
        }

        // Handle regular properties
        $this->setRegularProperty($key, $val);
    }

    private function handleRelationalKey(string $key, array $parts): mixed
    {
        if (self::KEYWORD_OWN === strtolower((string) $parts[0])) {
            return $this->handleOwnRelation($key, $parts);
        }

        if (self::KEYWORD_SHARED === strtolower((string) $parts[0])) {
            return $this->handleSharedRelation($key, $parts);
        }

        return null;
    }

    private function handleOwnRelation(string $key, array $parts): mixed
    {
        if (self::KEYWORD_LIST !== strtolower((string) $parts[2])) {
            return null;
        }

        $db = $this->recordManager->find(strtolower((string) $parts[1]));
        $db->where($this->getName() . '_id = :id')
            ->setParameter(
                'id',
                $this->__meta['id'],
                $this->determineIdType($this->__meta['id'])
            );

        $result = $db->get();
        $this->set($key, $result);

        return $result;
    }

    private function handleSharedRelation(string $key, array $parts): mixed
    {
        if ('list' !== strtolower((string) $parts[2])) {
            return null;
        }

        $targetTable = strtolower((string) $parts[1]);
        $relTable = $this->getRelationTable($targetTable);

        $db = $this->recordManager->find($relTable);
        $db->where($this->getName() . '_id = :id')
            ->setParameter(
                'id',
                $this->__meta['id'],
                $this->determineIdType($this->__meta['id'])
            );

        $relations = $db->get();
        $relIds = $this->extractRelationIds($relations, $targetTable);

        if (empty($relIds)) {
            return Collection::fromIterable([]);
        }

        $db = $this->recordManager->find($targetTable);
        $db->where('id IN (:ids)')
            ->setParameter(
                'ids',
                $relIds,
                $this->determineIdsType($relIds)
            );

        $result = $db->get();

        $this->set($key, $result);

        return $result;
    }

    private function getRelationTable(string $targetTable): string
    {
        $cacheKey = $this->table . '_' . $targetTable;

        if (!isset($this->relationTableCache[$cacheKey])) {
            $this->relationTableCache[$cacheKey] = $this->tableManager->tableExists($cacheKey)
                ? $cacheKey
                : $targetTable . '_' . $this->table;
        }

        return $this->relationTableCache[$cacheKey];
    }

    private function extractRelationIds(Collection $relations, string $targetTable): array
    {
        return $relations->map(function ($relation) use ($targetTable) {
            $key = $targetTable . '_id';

            return $relation->$key;
        })->toArray();
    }

    /**
     * Get a key from properties, keys can be relational
     * like sharedList,ownList or foreign table.
     */
    public function __get(string $key): mixed
    {
        return $this->get($key);
    }

    /**
     * Get a key from properties, keys can be relational
     * like sharedList,ownList or foreign table.
     */
    public function get(string $key): mixed
    {
        // Early return for cached properties
        if (array_key_exists($key, $this->__properties['all'])) {
            return $this->__properties['all'][$key];
        }

        // Handle foreign key relations
        if (array_key_exists($key . '_id', $this->__properties['self'])) {
            $result = $this->recordManager->getById($key, $this->__properties['self'][$key . '_id']);
            $this->set($key, $result);

            return $result;
        }

        // Handle complex relations (own/shared)
        if (0 !== \Safe\preg_match('/[A-Z]/', $key)) {
            $parts = \Safe\preg_split('/(?=[A-Z])/', $key, -1, PREG_SPLIT_NO_EMPTY);
            $result = $this->handleRelationalKey($key, $parts);
            if (null !== $result) {
                return $result;
            }
        }

        throw new Exception\KeyNotFoundException();
    }

    /**
     * Eager Load relation variable.
     *
     * @param array<string> $relations
     */
    public function with(array $relations): Model
    {
        foreach ($relations as $relation) {
            $this->get($relation);
        }

        return $this;
    }

    /**
     * Refresh the current model from database.
     */
    public function refresh(): void
    {
        $model = $this->recordManager->getById($this->getName(), $this->getId());
        if (!is_null($model)) {
            $this->cleanModel();
            $this->setLoadedProperties($model->getSelfProperties());
            $this->setLoaded();
        }
    }

    /**
     * Unset a property from model.
     */
    public function __unset(string $key): void
    {
        $this->unset($key);
    }

    /**
     * Unset a property from model.
     */
    public function unset(string $key): void
    {
        unset($this->__properties['self'][$key]);
        unset($this->__properties['all'][$key]);
        unset($this->__properties['type'][$key]);
    }

    /**
     * Check if property exists.
     */
    public function __isset(string $key): bool
    {
        return $this->isset($key);
    }

    /**
     * Check if property exists.
     */
    public function isset(string $key): bool
    {
        return array_key_exists($key, $this->__properties['all']);
    }

    /**
     * check if model loaded from db.
     */
    public function isLoaded(): bool
    {
        return $this->__meta['is_loaded'];
    }

    /**
     * Check if model has id error.
     */
    public function hasIdError(): bool
    {
        return $this->__meta['id_error'];
    }

    /**
     * Save model to database.
     */
    public function save(): mixed
    {
        $this->beforeSave();
        $this->id = $this->writeManager->save($this);
        $this->afterSave();
        return $this->getId();
    }

    /**
     * Cleans up model internal state to be consistent after save.
     */
    public function cleanModel(): void
    {
        $this->__properties['all'] = $this->__properties['self'];
        $this->__meta['id_error'] = false;
        $this->__meta['foreign_models']['otm'] = null;
        $this->__meta['foreign_models']['oto'] = null;
        $this->__meta['foreign_models']['mtm'] = null;
    }

    /**
     * Delete model data.
     */
    public function delete(): void
    {
        $this->beforeDelete();
        $this->recordManager->delete($this);
        $this->afterDelete();
    }

    /**
     * Function used to compare to models.
     */
    public function equals(self $other): bool
    {
        return $this->getId() === $other->getId() && $this->toString() === $other->toString();
    }

    /**
     * Get the type of value.
     */
    private function getDataType(mixed $value): string
    {
        $type = gettype($value);

        return match ($type) {
            'array', 'object' => self::TYPE_JSON,
            'string' => self::TYPE_TEXT,
            'double' => self::TYPE_FLOAT,
            default => $type,
        };
    }

    /**
     * Check if array passed is instance of model.
     *
     * @param array<mixed>|Collection $models
     *
     * @throws Exception\InvalidModelException
     */
    private function createCollection(?Collection $collection, array|Collection $models): Collection
    {
        if (is_null($collection)) {
            $collection = Collection::fromIterable([]);
        }

        if ($models instanceof Collection) {

$models is never a sub-type of Scrawler\Arca\Collection.

            return $collection->merge($models);
        }

        if ([] !== array_filter($models, fn($d): bool => !$d instanceof Model)) {
            throw new Exception\InvalidModelException();
        }

        return $collection->merge(Collection::fromIterable($models));
    }

    /**
     * Get the database value from PHP value.
     */
    private function getDbValue(mixed $val, string $type): mixed
    {
        if ('boolean' === $type) {
            return ($val) ? 1 : 0;
        }

        return Type::getType($type)->convertToDatabaseValue($val, $this->connection->getDatabasePlatform());
    }

    private function handleModelRelation(string $key, Model $val): void
    {
        if (isset($this->__properties['all'][$key . '_id'])) {
            unset($this->__properties['all'][$key . '_id']);
        }

        $this->__meta['foreign_models']['oto'] = $this->createCollection(
            $this->__meta['foreign_models']['oto'],
            Collection::fromIterable([$val])
        );
        $this->__properties['all'][$key] = $val;
    }

    private function handleComplexRelation(string $key, mixed $val): bool
    {
        $parts = \Safe\preg_split('/(?=[A-Z])/', $key, -1, PREG_SPLIT_NO_EMPTY);
        $type = strtolower((string) $parts[0]);

        if (self::KEYWORD_OWN === $type) {
            $this->__meta['foreign_models'][self::RELATION_ONE_TO_MANY] = $this->createCollection(
                $this->__meta['foreign_models'][self::RELATION_ONE_TO_MANY],
                $val
            );
            $this->__properties['all'][$key] = $val;

            return true;
        }

        if (self::KEYWORD_SHARED === $type) {
            $this->__meta['foreign_models'][self::RELATION_MANY_TO_MANY] = $this->createCollection(
                $this->__meta['foreign_models'][self::RELATION_MANY_TO_MANY],
                $val
            );
            $this->__properties['all'][$key] = $val;

            return true;
        }

        return false;
    }

    private function setRegularProperty(string $key, mixed $val): void
    {
        $type = $this->getDataType($val);
        $this->__properties['self'][$key] = $this->getDbValue($val, $type);
        $this->__properties['all'][$key] = $val;
        $this->__properties['type'][$key] = $type;
    }

    /**
     * Determines the ParameterType for an ID value.
     */
    private function determineIdType(int|string $id): ParameterType
    {
        return is_int($id) ? ParameterType::INTEGER : ParameterType::STRING;
    }

    /**
     * Get all properties of model.
     */
    private function determineIdsType(array $ids): ArrayParameterType
    {
        if (empty($ids)) {
            return ArrayParameterType::STRING;
        }

        $firstIdType = $this->determineIdType($ids[0]);

        return match ($firstIdType) {
            ParameterType::INTEGER => ArrayParameterType::INTEGER,
            ParameterType::STRING => ArrayParameterType::STRING,
        };
    }

    /**
     * Validates if the given relation type is valid.
     *
     * @throws Exception\InvalidRelationTypeException
     */
    private function validateRelationType(string $type): void
    {
        if (!in_array($type, self::RELATION_TYPES, true)) {
            throw new Exception\InvalidRelationTypeException($type);

The type Scrawler\Arca\Exception\InvalidRelationTypeException was not found. Maybe you did not declare it correctly or list all dependencies?

        }
    }

    public function hasForeign(string $type): bool
    {
        $this->validateRelationType($type);

        return !is_null($this->__meta['foreign_models'][$type]);
    }
}