Storeman\VaultLayout\LazyLoadedIndex

Complexity

Total Complexity

9

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	addObject()	0	6	1
A	getObjectByPath()	0	6	1
A	getObjectByBlobId()	0	6	1
A	count()	0	6	1
A	getIterator()	0	6	1
A	loadIndex()	0	14	3

<?php

namespace Storeman\VaultLayout;

use Storeman\Index\Index;
use Storeman\Index\IndexObject;

/**
 * Allows for an index to be lazy-loaded when its actually required using a provided loader callback.
 * This might be used in situations where you don't know in advance if the index content is actually needed and helps
 * to reduce the runtime.
 */
class LazyLoadedIndex extends Index
{
    /**
     * @var callable
     */
    protected $indexLoader;

    public function __construct(callable $indexLoader)
    {
        parent::__construct();

        $this->rootNode = null;
        $this->indexLoader = $indexLoader;
    }

    /**
     * {@inheritdoc}
     */
    public function addObject(IndexObject $indexObject): Index
    {
        $this->loadIndex();

        return parent::addObject($indexObject);
    }

    /**
     * {@inheritdoc}
     */
    public function getObjectByPath(string $path): ?IndexObject
    {
        $this->loadIndex();

        return parent::getObjectByPath($path);
    }

    /**
     * {@inheritdoc}
     */
    public function getObjectByBlobId(string $blobId): ?IndexObject
    {
        $this->loadIndex();

        return parent::getObjectByBlobId($blobId);
    }

    /**
     * {@inheritdoc}
     */
    public function count(): int
    {
        $this->loadIndex();

        return parent::count();
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator(): \Traversable
    {
        $this->loadIndex();

        return parent::getIterator();
    }

    /**
     * Lazy-loads the actual index from the injected loader.
     */
    protected function loadIndex()
    {
        if ($this->rootNode === null)
        {
            $index = call_user_func($this->indexLoader);

            if (!($index instanceof Index))
            {
                throw new \LogicException();
            }

            $this->rootNode = $index->rootNode;
        }
    }
}