puli / manager

src/Api/Cache/CacheFile.php

<?php

/*
 * This file is part of the puli/manager Module.
 *
 * (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\Api\Cache;

use InvalidArgumentException;
use Puli\Manager\Api\Module\InstallInfo;
use Puli\Manager\Api\Module\ModuleFile;
use Puli\Manager\Assert\Assert;

/**
 * Stores combined Modules configuration.
 *
 * @since  1.0
 *
 * @author Mateusz Sojda <mateusz@sojda.pl>
 */
class CacheFile
{
    /**
     * @var string|null
     */
    private $path;

    /**
     * @var ModuleFile[]
     */
    private $moduleFiles = array();

    /**
     * @var InstallInfo[]
     */
    private $installInfos = array();

    /**
     * Creates new CacheFile.
     *
     * @param string|null $path The path where the cache file is stored.
     */
    public function __construct($path = null)
    {
        Assert::nullOrAbsoluteSystemPath($path);

        $this->path = $path;
    }

    /**
     * Returns the path to the cache file.
     *
     * @return string|null The path or `null` if this file is not stored on the
     *                     file system.
     */
    public function getPath()
    {
        return $this->path;
    }

    /**
     * Sets the Module files.
     *
     * @param ModuleFile[] $moduleFiles The Module files.
     */
    public function setModuleFiles(array $moduleFiles)
    {
        $this->moduleFiles = array();

        foreach ($moduleFiles as $moduleFile) {
            $this->addModuleFile($moduleFile);
        }
    }

    /**
     * Adds a Module to the cache file.
     *
     * @param ModuleFile $moduleFile The added Module file.
     */
    public function addModuleFile(ModuleFile $moduleFile)
    {
        $this->moduleFiles[$moduleFile->getModuleName()] = $moduleFile;

        ksort($this->moduleFiles);
    }

    /**
     * Removes a Module file from the cache file.
     *
     * @param string $moduleName The Module name.
     */
    public function removeModuleFile($moduleName)
    {
        unset($this->moduleFiles[$moduleName]);
    }

    /**
     * Removes all Module files from the cache file.
     */
    public function clearModuleFiles()
    {
        $this->moduleFiles = array();
    }

    /**
     * Returns the Module file with the given name.
     *
     * @param string $moduleName The Module name.
     *
     * @return ModuleFile The Module with the passed name.
     *
     * @throws InvalidArgumentException If the Module was not found.
     */
    public function getModuleFile($moduleName)

This method seems to be duplicated in your project.

    {
        Assert::ModuleName($moduleName);

        if (!isset($this->moduleFiles[$moduleName])) {
            throw new InvalidArgumentException(sprintf("Could not find a Module named %s.", $moduleName));

The string literal Could not find a Module named %s. does not require double quotes, as per coding-style, please use single quotes.

        }

        return $this->moduleFiles[$moduleName];
    }

    /**
     * Returns the Module files in the cache file.
     *
     * @return ModuleFile[] The Module files in the cache file.
     */
    public function getModuleFiles()
    {
        return $this->moduleFiles;
    }

    /**
     * Returns whether a Module with the given name exists.
     *
     * @param string $moduleName The Module name.
     *
     * @return bool Whether a Module with this name exists.
     */
    public function hasModuleFile($moduleName)
    {
        return isset($this->moduleFiles[$moduleName]);
    }

    /**
     * Returns whether a cache file contains any Module files.
     *
     * @return bool Whether a cache file contains any Module files.
     */
    public function hasModuleFiles()
    {
        return count($this->moduleFiles) > 0;
    }

    /**
     * Adds install info to the cache file.
     *
     * @param InstallInfo $installInfo The Module install info.
     */
    public function addInstallInfo(InstallInfo $installInfo)
    {
        $this->installInfos[$installInfo->getModuleName()] = $installInfo;

        ksort($this->installInfos);
    }

    /**
     * Removes install info file from the cache file.
     *
     * @param string $moduleName The Module name.
     */
    public function removeInstallInfo($moduleName)
    {
        unset($this->installInfos[$moduleName]);
    }

    /**
     * Removes all Module install info from the cache file.
     */
    public function clearInstallInfo()
    {
        $this->installInfos = array();
    }

    /**
     * Returns the install info with the given Module name.
     *
     * @param string $moduleName The Module name.
     *
     * @return InstallInfo The Module install info with the passed name.
     *
     * @throws InvalidArgumentException If the install info was not found.
     */
    public function getInstallInfo($moduleName)

This method seems to be duplicated in your project.

    {
        Assert::ModuleName($moduleName);

        if (!isset($this->installInfos[$moduleName])) {
            throw new InvalidArgumentException(sprintf("Could not find a Module named %s.", $moduleName));

The string literal Could not find a Module named %s. does not require double quotes, as per coding-style, please use single quotes.

        }

        return $this->installInfos[$moduleName];
    }

    /**
     * Returns the install info for all Modules in the cache file.
     *
     * @return InstallInfo[] The install info for all Modules in the cache file.
     */
    public function getInstallInfos()
    {
        return $this->installInfos;
    }

    /**
     * Returns whether install info for a Module with the given name exists.
     *
     * @param string $moduleName The Module name.
     *
     * @return bool Whether install info for a Module with this name exists.
     */
    public function hasInstallInfo($moduleName)
    {
        return isset($this->installInfos[$moduleName]);
    }

    /**
     * Returns whether a cache file contains any Module install info.
     *
     * @return bool Whether a cache file contains any Module install info.
     */
    public function hasInstallInfos()
    {
        return count($this->installInfos) > 0;
    }
}