Puli\Manager\Cache\CacheFileStorage

Complexity

Total Complexity

4

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	loadCacheFile()	0	6	1
A	saveCacheFile()	0	6	1
A	cacheFileExists()	0	4	1

<?php

/*
 * This file is part of the puli/manager package.
 *
 * (c) Bernhard Schussek <bschussek@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Puli\Manager\Cache;

use Puli\Manager\Api\Cache\CacheFile;
use Puli\Manager\Api\Cache\CacheFileSerializer;
use Puli\Manager\Api\FileNotFoundException;
use Puli\Manager\Api\InvalidConfigException;
use Puli\Manager\Api\Storage\ReadException;
use Puli\Manager\Api\Storage\Storage;
use Puli\Manager\Api\Storage\WriteException;

/**
 * Loads and saves cache files.
 *
 * @since  1.0
 *
 * @author Mateusz Sojda <mateusz@sojda.pl>
 */
class CacheFileStorage
{
    /**
     * @var Storage
     */
    private $storage;

    /**
     * @var CacheFileSerializer
     */
    private $serializer;

    /**
     * Creates a new storage.
     *
     * @param Storage              $storage     The file storage.
     * @param CacheFileSerializer  $serializer  The cache file serializer.
     */
    public function __construct(Storage $storage, CacheFileSerializer $serializer)
    {
        $this->storage = $storage;
        $this->serializer = $serializer;
    }

    /**
     * Loads a cache file from a file path.
     *
     * @param string $path The path to the cache file.
     *
     * @return CacheFile The loaded cache file.
     *
     * @throws FileNotFoundException       If the file does not exist.
     * @throws ReadException               If the file cannot be read.
     * @throws InvalidConfigException      If the file contains invalid
     *                                     configuration.
     */
    public function loadCacheFile($path)
    {
        $serialized = $this->storage->read($path);

        return $this->serializer->unserializeCacheFile($serialized, $path);
    }

    /**
     * Saves a cache file.
     *
     * The cache file is saved to the same path that it was read from.
     *
     * @param CacheFile $cacheFile The cache file to save.
     *
     * @throws WriteException If the file cannot be written.
     */
    public function saveCacheFile(CacheFile $cacheFile)
    {
        $serialized = $this->serializer->serializeCacheFile($cacheFile);

        $this->storage->write($cacheFile->getPath(), $serialized);
    }

    /**
     * Returns whether a cache file exists.
     *
     * @param string $path The cache file path.
     *
     * @return bool Returns `true` if the cache file exists and `false` otherwise.
     */
    public function cacheFileExists($path)
    {
        return $this->storage->exists($path);
    }
}