Spatie\PersonalDataExport\PersonalDataSelection

Complexity

Total Complexity

11

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	files()	0	4	1
A	forUser()	0	6	1
A	add()	0	16	2
A	addFile()	0	6	2
A	copyLocalFile()	0	14	1
A	copyFileFromDisk()	0	14	1
A	ensureDoesNotOverwriteExistingFile()	0	6	2

<?php

namespace Spatie\PersonalDataExport;

use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Facades\Storage;
use Spatie\PersonalDataExport\Exceptions\CouldNotAddToPersonalDataSelection;
use Spatie\TemporaryDirectory\TemporaryDirectory;

class PersonalDataSelection
{
    /** @var \Spatie\TemporaryDirectory\TemporaryDirectory */
    protected $temporaryDirectory;

    /** @var array */
    protected $files = [];

    /** @var \Illuminate\Database\Eloquent\Model */
    public $user;

    public function __construct(TemporaryDirectory $temporaryDirectory)
    {
        $this->temporaryDirectory = $temporaryDirectory;
    }

    public function files(): array
    {
        return $this->files;
    }

    public function forUser(ExportsPersonalData $user)
    {
        $this->user = $user;

$user is of type object<Spatie\PersonalDataExport\ExportsPersonalData>, but the property $user was declared to be of type object<Illuminate\Database\Eloquent\Model>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

        return $this;
    }

    /**
     * @param string $nameInDownload
     * @param array|string $content
     *
     * @return \Spatie\PersonalDataExport\PersonalDataSelection
     */
    public function add(string $nameInDownload, $content)
    {
        if (! is_string($content)) {
            $content = json_encode($content, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT);
        }

        $path = $this->temporaryDirectory->path($nameInDownload);

        $this->ensureDoesNotOverwriteExistingFile($path);

        $this->files[] = $path;

        file_put_contents($path, $content);

        return $this;
    }

    public function addFile(string $pathToFile, string $diskName = null)
    {
        return is_null($diskName)
            ? $this->copyLocalFile($pathToFile)
            : $this->copyFileFromDisk($pathToFile, $diskName);
    }

    protected function copyLocalFile(string $pathToFile)
    {
        $fileName = pathinfo($pathToFile, PATHINFO_BASENAME);

        $destination = $this->temporaryDirectory->path($fileName);

        $this->ensureDoesNotOverwriteExistingFile($destination);

        (new Filesystem())->copy($pathToFile, $destination);

        $this->files[] = $destination;

        return $this;
    }

    protected function copyFileFromDisk(string $pathOnDisk, string $diskName)
    {
        $stream = Storage::disk($diskName)->readStream($pathOnDisk);

        $pathInTemporaryDirectory = $this->temporaryDirectory->path($pathOnDisk);

        $this->ensureDoesNotOverwriteExistingFile($pathInTemporaryDirectory);

        file_put_contents($pathInTemporaryDirectory, stream_get_contents($stream), FILE_APPEND);

        $this->files[] = $pathInTemporaryDirectory;

        return $this;
    }

    protected function ensureDoesNotOverwriteExistingFile(string $path)
    {
        if (file_exists($path)) {
            throw CouldNotAddToPersonalDataSelection::fileAlreadyAddedToPersonalDataSelection($path);
        }
    }
}