Zip::createForPersonalData() - Code Metrics - spatie/laravel-personal-data-export - Measure and Improve Code Quality continuously with Scrutinizer

Zip::createForPersonalData() A
last analyzed 2020-08-06 10:02 UTC

↳ Parent: Zip

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	18
rs	9.6666
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?php

namespace Spatie\PersonalDataExport;

use Illuminate\Support\Str;
use Spatie\TemporaryDirectory\TemporaryDirectory;
use ZipArchive;

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

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

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

    public static function createForPersonalData(
        PersonalDataSelection $personalDataSelection,
        TemporaryDirectory $temporaryDirectory): self
    {
        $zipFilenameParts = [
            $personalDataSelection->user->getKey(),
            now()->timestamp,
            Str::random(64),
        ];

        $zipFilename = implode('_', $zipFilenameParts).'.zip';

        $pathToZip = $temporaryDirectory->path($zipFilename);

        return (new static($pathToZip))
            ->add($personalDataSelection->files(), $temporaryDirectory->path())
            ->close();
    }

    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 open(): self
    {
        $this->zipFile->open($this->pathToZip, ZipArchive::CREATE);

        return $this;
    }

    /**
     * @param string|array $files
     * @param string $rootPath
     *
     * @return \Spatie\PersonalDataExport\Zip
     */
    public function add($files, $rootPath): self
    {
        foreach ($files as $file) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (file_exists($file)) {
                $nameInZip = Str::after($file, $rootPath.'/');

                $this->zipFile->addFile($file, ltrim($nameInZip, DIRECTORY_SEPARATOR));
            }
            $this->fileCount++;
        }

        return $this;
    }

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

        return $this;
    }
}


1			<?php
2
3			namespace Spatie\PersonalDataExport;
4
5			use Illuminate\Support\Str;
6			use Spatie\TemporaryDirectory\TemporaryDirectory;
7			use ZipArchive;
8
9			class Zip
10			{
11			/** @var \ZipArchive */
12			protected $zipFile;
13
14			/** @var int */
15			protected $fileCount = 0;
16
17			/** @var string */
18			protected $pathToZip;
19
20			public static function createForPersonalData(
21			PersonalDataSelection $personalDataSelection,
22			TemporaryDirectory $temporaryDirectory): self
23			{
24			$zipFilenameParts = [
25			$personalDataSelection->user->getKey(),
26			now()->timestamp,
27			Str::random(64),
28			];
29
30			$zipFilename = implode('_', $zipFilenameParts).'.zip';
31
32			$pathToZip = $temporaryDirectory->path($zipFilename);
33
34			return (new static($pathToZip))
35			->add($personalDataSelection->files(), $temporaryDirectory->path())
36			->close();
37			}
38
39			public function __construct(string $pathToZip)
40			{
41			$this->zipFile = new ZipArchive();
42
43			$this->pathToZip = $pathToZip;
44
45			$this->open();
46			}
47
48			public function path(): string
49			{
50			return $this->pathToZip;
51			}
52
53			public function size(): int
54			{
55			if ($this->fileCount === 0) {
56			return 0;
57			}
58
59			return filesize($this->pathToZip);
60			}
61
62			public function open(): self
63			{
64			$this->zipFile->open($this->pathToZip, ZipArchive::CREATE);
65
66			return $this;
67			}
68
69			/**
70			* @param string\|array $files
71			* @param string $rootPath
72			*
73			* @return \Spatie\PersonalDataExport\Zip
74			*/
75			public function add($files, $rootPath): self
76			{
77			foreach ($files as $file) {
			0 ignored issues – show Bug introduced 2019-03-10 16:00 UTC by Report Bug Copy Issue Report The expression `$files` of type `string\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
78			if (file_exists($file)) {
79			$nameInZip = Str::after($file, $rootPath.'/');
80
81			$this->zipFile->addFile($file, ltrim($nameInZip, DIRECTORY_SEPARATOR));
82			}
83			$this->fileCount++;
84			}
85
86			return $this;
87			}
88
89			public function close(): self
90			{
91			$this->zipFile->close();
92
93			return $this;
94			}
95			}
96

spatie / laravel-personal-data-export

Zip::createForPersonalData() A last analyzed 2020-08-06 10:02 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Zip::createForPersonalData() A
last analyzed 2020-08-06 10:02 UTC