Spatie\Backup\Tasks\Backup\Zip

Complexity

Total Complexity

23

Size/Duplication

Total Lines	151
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	createForManifest()	0	16	2
A	determineNameOfFileInZip()	0	12	2
A	formatZipFilename()	0	4	1
A	__construct()	0	8	1
A	path()	0	4	1
A	size()	0	8	2
A	humanReadableSize()	0	4	1
A	open()	0	4	1
A	close()	0	4	1
A	setPassword()	0	6	1
A	passwordProtectFile()	0	12	3
B	add()	0	23	6
A	count()	0	4	1

<?php

namespace Spatie\Backup\Tasks\Backup;

use ZipArchive;
use Illuminate\Support\Str;
use Spatie\Backup\Helpers\Format;

class Zip
{
    /** @var \ZipArchive */
    protected $zipFile;

    /** @var int */
    protected $fileCount = 0;

    /** @var string */
    protected $pathToZip;

    /** @var string */
    protected $password;

    public static function createForManifest(Manifest $manifest, string $pathToZip): self
    {
        $zip = new static($pathToZip);

        $zip->open();

        $zip->setPassword(config('backup.backup.password', null));

        foreach ($manifest->files() as $file) {
            $zip->add($file, self::determineNameOfFileInZip($file, $pathToZip));
        }

        $zip->close();

        return $zip;
    }

    protected static function determineNameOfFileInZip(string $pathToFile, string $pathToZip)
    {
        $zipDirectory = pathinfo($pathToZip, PATHINFO_DIRNAME);

        $fileDirectory = pathinfo($pathToFile, PATHINFO_DIRNAME);

        if (Str::startsWith($fileDirectory, $zipDirectory)) {
            return str_replace($zipDirectory, '', $pathToFile);
        }

        return $pathToFile;
    }

    public static function formatZipFilename(string $filename): string
    {
        return ltrim($filename, DIRECTORY_SEPARATOR);
    }

    public function __construct(string $pathToZip)
    {
        $this->zipFile = new ZipArchive();

        $this->pathToZip = $pathToZip;

        $this->open();
    }

    public function path(): string
    {
        return $this->pathToZip;
    }

    public function size(): int
    {
        if ($this->fileCount === 0) {
            return 0;
        }

        return filesize($this->pathToZip);
    }

    public function humanReadableSize(): string
    {
        return Format::humanReadableSize($this->size());
    }

    public function open()
    {
        $this->zipFile->open($this->pathToZip, ZipArchive::CREATE);
    }

    public function close()
    {
        $this->zipFile->close();
    }

    /**
     * @param string|null $password
     * @return Zip
     */
    public function setPassword(?string $password): self
    {
        $this->password = $password;

        return $this;
    }

    /**
     * @param string $nameInZip
     *
     * @return Zip
     */
    protected function passwordProtectFile(string $nameInZip): self
    {
        if (empty($this->password)) {
            return $this;
        }

        if (!$this->zipFile->setEncryptionName($nameInZip, ZipArchive::EM_AES_256, $this->password)) {
            consoleOutput()->warn('Cannot password protect ' . $nameInZip);

The method warn does not exist on object<Spatie\Backup\Helpers\ConsoleOutput>? Since you implemented __call, maybe consider adding a @method annotation.

        }

        return $this;
    }

    /**
     * @param string|array $files
     * @param string $nameInZip
     *
     * @return \Spatie\Backup\Tasks\Backup\Zip
     */
    public function add($files, string $nameInZip = null): self
    {
        if (is_array($files)) {
            $nameInZip = null;
        }

        if (is_string($files)) {
            $files = [$files];
        }

        foreach ($files as $file) {
            if (file_exists($file)) {
                $localName = self::formatZipFilename($nameInZip ?? $file);

                if ($this->zipFile->addFile($file, $localName).PHP_EOL) {
                    $this->passwordProtectFile($localName);
                }
            }
            $this->fileCount++;
        }

        return $this;
    }

    public function count(): int
    {
        return $this->fileCount;
    }
}