Majora\Framework\Model\LazyPropertiesTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	57
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

0%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	registerLoader()	0	8	2
A	registerLoaders()	0	6	2
A	load()	0	14	4

<?php

namespace Majora\Framework\Model;

/**
 * Trait which provides lazy load delegates call on fields.
 */
trait LazyPropertiesTrait
{
    /**
     * @var EntityCollection
     */
    private $delegatesCollection;

    /**
     * @see LazyPropertiesInterface::registerLoader()
     */
    public function registerLoader($field, \Closure $delegate)
    {
        if (!$this->delegatesCollection instanceof EntityCollection) {
            $this->delegatesCollection = new EntityCollection();
        }

        $this->delegatesCollection->set(strtolower($field), $delegate);
    }

    /**
     * @see LazyPropertiesInterface::registerLoaders()
     */
    public function registerLoaders(array $loaders)
    {
        foreach ($loaders as $field => $closure) {
            $this->registerLoader($field, $closure);
        }
    }

    /**
     * Load given field if able to, define his value and return it.
     *
     * @example
     *   public function getRelatedEntity()
     *   {
     *       return $this->load('relatedEntity');
     *   }
     *
     * @param string $field
     *
     * @return mixed|null field value if retrieved
     */
    protected function load($field)
    {
        if (!is_null($this->$field)
            || !$this->delegatesCollection
            || !$this->delegatesCollection->containsKey($key = strtolower($field))
        ) {
            return $this->$field;
        }

        $loader = $this->delegatesCollection->get($key);
        $this->delegatesCollection->remove($key);

        return $this->$field = $loader($this);
    }
}