ARecord::offsetCheck() - Code Metrics - alex-kalanis/kw_mapper - Measure and Improve Code Quality continuously with Scrutinizer

ARecord::offsetCheck() A
last analyzed 2025-05-11 16:44 UTC

↳ Parent: ARecord
Complexity

Conditions	2
Paths	2
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	3
CRAP Score	2
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	2
c	1
b	0
f	0
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
cc	2
nc	2
nop	1
crap	2
<?php

namespace kalanis\kw_mapper\Records;


use ArrayAccess;
use Iterator;
use kalanis\kw_mapper\Interfaces\ICanFill;
use kalanis\kw_mapper\Interfaces\IEntryType;
use kalanis\kw_mapper\MapperException;
use ReflectionClass;
use ReflectionException;


/**
 * Class ARecord
 * @package kalanis\kw_mapper\Records
 * Class to map entries to their respective values
 * The level of "obstruction" to accessing properties is necessary
 * or it could not be possible to guarantee content values.
 * The children must stay too simple to avoid some usual problems which came with multilevel extending
 */
abstract class ARecord implements ArrayAccess, Iterator
{
    use TMapper;

    /** @var string|int|null */
    private $key = null;
    /** @var Entry[] */
    protected array $entries = [];

    /** @var int[] */
    protected static array $types = [IEntryType::TYPE_BOOLEAN,
                               IEntryType::TYPE_INTEGER, IEntryType::TYPE_FLOAT,
                               IEntryType::TYPE_STRING,
                               IEntryType::TYPE_SET, IEntryType::TYPE_ARRAY, IEntryType::TYPE_OBJECT];

    /**
     * Mapper constructor.
     * @throws MapperException
     */
    public function __construct()
    {
        $this->addEntries();
    }

    /**
     * @throws MapperException
     */
    abstract protected function addEntries(): void;

    /**
     * @param string $name
     * @param int $type
     * @param string|int|array<string|int, string|int>|null $defaultParam
     * @throws MapperException
     */
    final protected function addEntry($name, int $type, $defaultParam = null): void
    {
        $this->checkDefault($type, $defaultParam);
        $this->entries[$name] = Entry::getInstance()->setType($type)->setParams($defaultParam);
    }

    /**
     * @param iterable<string|int, string|int|float|object> $data
     */
    public function loadWithData(iterable $data): void
    {
        foreach ($data as $key => $value) {
            if ($this->offsetExists($key)) {
                $this->offsetSet($key, $value);
            }
        }
    }

    /**
     * @param string|int $name
     * @throws MapperException
     * @return Entry
     */
    final public function getEntry($name): Entry
    {
        $this->offsetCheck($name);
        return $this->entries[$name];
    }

    final public function __clone()
    {
        $entries = [];
        foreach ($this->entries as $key => $entry) {
            $entries[$key] = clone $entry;
        }
        $this->entries = $entries;
    }

    /**
     * @param string|int $name
     * @param mixed $value
     */
    final public function __set($name, $value): void
    {
        $this->offsetSet($name, $value);
    }

    /**
     * @param string|int $name
     * @throws MapperException
     * @return int|ICanFill|string|null
     */
    #[\ReturnTypeWillChange]
    final public function __get($name)
    {
        return $this->offsetGet($name);
    }

    /**
     * @throws MapperException
     * @return int|ICanFill|string|null
     */
    #[\ReturnTypeWillChange]
    final public function current()
    {
        return $this->valid() ? $this->offsetGet($this->key) : null ;
    }

    final public function next(): void
    {
        next($this->entries);
        $this->key = key($this->entries);
    }

    #[\ReturnTypeWillChange]
    final public function key()
    {
        return $this->key;
    }

    final public function valid(): bool
    {
        return $this->offsetExists($this->key);
    }

    final public function rewind(): void
    {
        reset($this->entries);
        $this->key = key($this->entries);
    }

    final public function offsetExists($offset): bool
    {
        return isset($this->entries[$offset]);
    }

    /**
     * @param mixed $offset
     * @throws MapperException
     * @return int|ICanFill|mixed|string|null
     */
    #[\ReturnTypeWillChange]
    final public function offsetGet($offset)
    {
        $this->offsetCheck($offset);
        $data = & $this->entries[$offset];

        switch ($data->getType()) {
            case IEntryType::TYPE_BOOLEAN:
            case IEntryType::TYPE_INTEGER:
            case IEntryType::TYPE_FLOAT:
            case IEntryType::TYPE_STRING:
            case IEntryType::TYPE_SET:
            case IEntryType::TYPE_ARRAY:
                return $data->getData();
            case IEntryType::TYPE_OBJECT:
                if (empty($data->getData())) {
                    return null;
                }
                /** @var ICanFill $class */
                $class = $data->getData();
                return $class->dumpData();
            default:
                // @codeCoverageIgnoreStart
                // happens only when someone is evil enough and change type directly on entry
                throw new MapperException(sprintf('Unknown type *%d*', $data->getType()));
                // @codeCoverageIgnoreEnd
        }
    }

    /**
     * @param mixed $offset
     * @throws MapperException
     */
    final public function offsetUnset($offset): void
    {
        throw new MapperException(sprintf('Key %s removal denied', $offset));
    }

    /**
     * @param mixed $offset
     * @throws MapperException
     */
    final protected function offsetCheck($offset): void
    {
        if (!$this->offsetExists($offset)) {
            throw new MapperException(sprintf('Unknown key *%s*', $offset));
        }
    }

    /**
     * @param Entry $data
     * @throws MapperException
     */
    final protected function reloadClass(Entry $data): void
    {
        if (empty($data->getData())) {
            $dataClass = $data->getParams();
            try {
                /** @var class-string $dataClass */
                $reflect = new ReflectionClass($dataClass);
                $reflect = new ReflectionClass(/** @scrutinizer ignore-type */ $dataClass);
                $classInstance = $reflect->newInstance();
            } catch (ReflectionException $ex) {
                throw new MapperException($ex->getMessage(), $ex->getCode(), $ex);
            }
            /** @var ICanFill $classInstance */
            $data->setData($classInstance);
        }
    }

    /**
     * @param int $type
     * @param string|int|float|object|array<string|int|float|object> $default
     * @throws MapperException
     */
    private function checkDefault(int $type, $default): void
    {
        switch ($type) {
            case IEntryType::TYPE_INTEGER:
            case IEntryType::TYPE_FLOAT:
            case IEntryType::TYPE_STRING:
                $this->checkLengthNumeric($default, $type);
                return;
            case IEntryType::TYPE_BOOLEAN:
            case IEntryType::TYPE_ARRAY:
            case IEntryType::TYPE_SET:
                return;
            case IEntryType::TYPE_OBJECT:
                $this->checkObjectString($default, $type);
                $this->checkObjectInstance($default, $type);
                return;
            default:
                throw new MapperException(sprintf('Unknown type *%d*', $type));
        }
    }

    /**
     * @param mixed $value
     * @param int $type
     * @throws MapperException
     */
    private function checkLengthNumeric($value, int $type): void
    {
        if (!is_numeric($value)) {
            throw new MapperException(sprintf('You must set length as number for type *%d*', $type));
        }
    }

    /**
     * @param mixed $value
     * @param int $type
     * @throws MapperException
     */
    private function checkObjectString($value, int $type): void
    {
        if (!is_string($value)) {
            throw new MapperException(sprintf('You must set available string representing object for type *%d*', $type));
        }
    }

    /**
     * @param mixed $value
     * @param int $type
     * @throws MapperException
     */
    private function checkObjectInstance($value, int $type): void
    {
        try {
            /** @var class-string $value */
            $reflect = new ReflectionClass($value);
            $classForTest = $reflect->newInstance();
        } catch (ReflectionException $ex) {
            throw new MapperException($ex->getMessage(), $ex->getCode(), $ex);
        }
        if (!$classForTest instanceof ICanFill) {
            throw new MapperException(sprintf('When you set string representing object for type *%d*, it must be stdClass or have ICanFill interface', $type));
        }
    }

    /**
     * From trait TMapper - map this record as one to processing
     * @return ARecord
     */
    final protected function getSelf(): ARecord
    {
        return $this;
    }
}

alex-kalanis / kw_mapper

ARecord::offsetCheck() A last analyzed 2025-05-11 16:44 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ARecord::offsetCheck() A
last analyzed 2025-05-11 16:44 UTC
