yahoojapan / ConfigCacheBundle

ConfigCache/RestorablePhpFileCache.php

<?php

/*
 * This file is part of the ConfigCacheBundle package.
 *
 * Copyright (c) 2015-2016 Yahoo Japan Corporation
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace YahooJapan\ConfigCacheBundle\ConfigCache;

use Doctrine\Common\Cache\PhpFileCache;

/**
 * RestorablePhpFileCache restores by re-creating the caches to the temporary directory or cache directory.
 */
class RestorablePhpFileCache extends PhpFileCache
{
    const TAG_RESTORABLE_CACHE = 'config_cache.restorable';

    protected $builder;
    protected $restoringDirectory;

    /**
     * Saves the cache to the temporary directory.
     *
     * @param string $id
     */
    public function saveToTemp($id)

This method seems to be duplicated in your project.

    {
        if ($this->contains($id)) {
            $data = $this->fetch($id);
            $this->prepareTemporaryDirectory();
            $this->save($id, $data);
            $this->restoreDirectory();
        }
    }

    /**
     * Restores the cache to the cache directory.
     *
     * @param string $id
     */
    public function restore($id)

This method seems to be duplicated in your project.

    {
        $this->prepareTemporaryDirectory();
        if ($this->contains($id)) {
            $data = $this->fetch($id);
            $this->restoreDirectory();
            $this->save($id, $data);
        } else {
            $this->restoreDirectory();
        }
    }

    /**
     * Sets a SaveAreaBuilder.
     *
     * @param SaveAreaBuilder $builder
     *
     * @return RestorablePhpFileCache
     */
    public function setBuilder(SaveAreaBuilder $builder)
    {
        $this->builder = $builder;

        return $this;
    }

    /**
     * Sets a directory.
     *
     * @param string $directory
     *
     * @return RestorablePhpFileCache
     */
    protected function setDirectory($directory)
    {
        $this->directory = realpath($directory);

        return $this;
    }

    /**
     * Sets an original restoring directory.
     *
     * @param string $directory
     *
     * @return RestorablePhpFileCache
     */
    protected function setRestoringDirectory($directory)
    {
        $this->restoringDirectory = $directory;

        return $this;
    }

    /**
     * Prepares temporary directory to re-create cache.
     *
     * @return RestorablePhpFileCache
     */
    protected function prepareTemporaryDirectory()
    {
        $currentDirectory = $this->getDirectory();
        $this->setRestoringDirectory($currentDirectory);

        // mkdir before setDirectory()
        $temporaryDirectory = $this->builder->build($currentDirectory);

        return $this->setDirectory($temporaryDirectory);
    }

    /**
     * Restores an original directory.
     *
     * @return RestorablePhpFileCache
     */
    protected function restoreDirectory()
    {
        return $this->setDirectory($this->restoringDirectory);
    }
}