puli / manager

src/Api/Cache/CacheFile.php

<?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\Api\Cache;

use InvalidArgumentException;
use Puli\Manager\Api\Package\InstallInfo;
use Puli\Manager\Api\Package\PackageFile;
use Puli\Manager\Assert\Assert;

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

    /**
     * @var PackageFile[]
     */
    private $packageFiles = 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 package files.
     *
     * @param PackageFile[] $packageFiles The package files.
     */
    public function setPackageFiles(array $packageFiles)
    {
        $this->packageFiles = $packageFiles;
    }

    /**
     * Adds a package to the cache file.
     *
     * @param PackageFile $packageFile The added package file.
     */
    public function addPackageFile(PackageFile $packageFile)
    {
        $this->packageFiles[$packageFile->getPackageName()] = $packageFile;

        ksort($this->packageFiles);
    }

    /**
     * Removes a package file from the cache file.
     *
     * @param string $packageName The package name.
     */
    public function removePackageFile($packageName)
    {
        unset($this->packageFiles[$packageName]);
    }

    /**
     * Removes all package files from the cache file.
     */
    public function clearPackageFiles()
    {
        $this->packageFiles = array();
    }

    /**
     * Returns the package file with the given name.
     *
     * @param string $packageName The package name.
     *
     * @return PackageFile The package with the passed name.
     *
     * @throws InvalidArgumentException If the package was not found.
     */
    public function getPackageFile($packageName)

This method seems to be duplicated in your project.

    {
        Assert::packageName($packageName);

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

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

        }

        return $this->packageFiles[$packageName];
    }

    /**
     * Returns the package files in the cache file.
     *
     * @return PackageFile[] The package files in the cache file.
     */
    public function getPackageFiles()
    {
        return $this->packageFiles;
    }

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

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

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

        ksort($this->installInfos);
    }

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

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

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

This method seems to be duplicated in your project.

    {
        Assert::packageName($packageName);

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

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

        }

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

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

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

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