Mcneely\Core\CoreObject

Complexity

Total Complexity

23

Size/Duplication

Total Lines	136
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	setRetriever()	0	5	1
A	unWrap()	0	12	2
A	getUnwrapped()	0	14	5
A	getObject()	0	5	2
A	bindRetriever()	0	8	4
A	hasRetriever()	0	3	1
A	unwrapObject()	0	8	6
A	setObject()	0	6	1

<?php

declare(strict_types=1);

namespace Mcneely\Core;

use ArrayIterator;

/**
 * Class CoreObject.
 *
 * @package Mcneely\Core
 */
class CoreObject
{
    /** @var mixed $object */
    protected $object;

    /** @var callable|false $retriever */
    protected $retriever = false;

    /** @var callable|false $boundObject */
    protected $boundObject = false;

    protected $unwrapSkipped = false;

    /**
     * CoreObject constructor.
     *
     * @param mixed $object
     */
    public function __construct($object)
    {
        $this->setObject($object);
    }

    /**
     * @param callable $retriever
     *
     * @return CoreObject
     */
    public function setRetriever(callable $retriever): self
    {
        $this->retriever = $retriever;

        return $this;
    }

    /**
     * @param string|null $instance
     * @param string|null $exclude
     *
     * @return \Traversable|mixed
     */
    public function unWrap(?string $instance = null, ?string $exclude = null)
    {
        $object = $this->getUnwrapped($instance, $exclude);

        if ($this->unwrapSkipped) {
            return $object;
        }

        $this->setObject($object);
        $this->retriever = false;

        return $object;
    }

    /**
     * @param string|null $instance
     * @param string|null $exclude
     *
     * @return \Traversable|mixed
     */
    public function getUnwrapped(?string $instance = null, ?string $exclude = null)
    {
        $object = $this->getObject();

        $exclude = ($exclude && $object instanceof $exclude);

        $this->unwrapSkipped = false;
        if ($instance && $object instanceof $instance && !$exclude) {
            $this->unwrapSkipped = true;

            return $object;
        }

        return $this->unwrapObject($object);
    }

    /**
     * @param mixed $object
     *
     * @return mixed|ArrayIterator
     */
    public function unwrapObject($object)
    {
        $object = ($object instanceof \IteratorAggregate) ? $object->getIterator() : $object;
        $object = ($object instanceof \IteratorIterator) ? $object->getInnerIterator() : $object;
        $object = ($object instanceof \Traversable) ? iterator_to_array($object) : $object;
        $object = (method_exists($object, 'toArray')) ? $object->toArray() : $object;

        return (is_array($object)) ? new ArrayIterator($object) : $object;
    }

    /**
     * @return mixed
     */
    protected function getObject()
    {
        $this->bindRetriever();

        return ($this->hasRetriever()) ? $this->boundObject : $this->object;
    }

    /**
     * @param mixed $object
     *
     * @return CoreObject
     */
    public function setObject($object): self
    {
        $this->object      = $object;
        $this->boundObject = false;

        return $this;
    }

    /**
     * @param bool|null $rebind
     *
     * @return CoreObject
     */
    public function bindRetriever(?bool $rebind = false): self
    {
        if ($this->hasRetriever() && ($rebind || !$this->boundObject)) {
            $retriever         = $this->retriever;

It seems like $this->retriever can also be of type boolean. However, the property $retriever is declared as type callable|false. Maybe add an additional type check?

            $this->boundObject = $retriever($this->object);
        }

        return $this;
    }

    /**
     * @return bool
     */
    public function hasRetriever(): bool
    {
        return (bool) $this->retriever;
    }
}