As3\Modlr\Metadata\Cache\CacheWarmer

Complexity

Total Complexity

11

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	clear()	0	7	2
A	warm()	0	7	2
A	doClear()	0	15	2
A	doWarm()	0	10	2
A	getTypes()	0	7	2

<?php

namespace As3\Modlr\Metadata\Cache;

use As3\Modlr\Metadata\MetadataFactory;

/**
 * Warms up the metadata cache objects by placing all known entities into the cache source.
 * Only functions if the MetadataFactory has cache implemented.
 *
 * @author Jacob Bare <jacob.bare@gmail.com>
 */
class CacheWarmer
{
    /**
     * The metadata factory for loading and caching metadata objects.
     *
     * @var MetadataFactory
     */
    private $mf;

    /**
     * Constructor.
     *
     * @param   MetadataFactory     $mf
     */
    public function __construct(MetadataFactory $mf)
    {
        $this->mf = $mf;
    }

    /**
     * Clears metadata objects from the cache.
     *
     * @param   string|array|null   $type
     * @return  array
     */
    public function clear($type = null)
    {
        if (false === $this->mf->hasCache()) {
            return [];
        }
        return $this->doClear($this->getTypes($type));
    }

    /**
     * Warms up metadata objects into the cache.
     *
     * @param   string|array|null   $type
     * @return  array
     */
    public function warm($type = null)
    {
        if (false === $this->mf->hasCache()) {
            return [];
        }
        return $this->doWarm($this->getTypes($type));
    }

    /**
     * Clears metadata objects for the provided model types.
     *
     * @param   array   $types
     * @return  array
     */
    private function doClear(array $types)
    {
        $cleared = [];
        $this->mf->enableCache(false);

        foreach ($types as $type) {
            $metadata = $this->mf->getMetadataForType($type);
            $this->mf->getCache()->evictMetadataFromCache($metadata);
            $cleared[] = $type;
        }

        $this->mf->enableCache(true);
        $this->mf->clearMemory();
        return $cleared;
    }

    /**
     * Warms up the metadata objects for the provided model types.
     *
     * @param   array   $types
     * @return  array
     */
    private function doWarm(array $types)
    {
        $warmed = [];
        $this->doClear($types);
        foreach ($types as $type) {
            $this->mf->getMetadataForType($type);
            $warmed[] = $type;
        }
        return $warmed;
    }

    /**
     * Gets the model types based on an array, string, or null type value.
     *
     * @param   string|array|null
     * @return  array
     */
    private function getTypes($type = null)
    {
        if (null === $type) {
            return $this->mf->getAllTypeNames();
        }
        return (array) $type;
    }
}