SimpleImageManager\Managers\CanDelete

Complexity

Total Complexity

10

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setDeletedFormats()	0	5	1
A	filesToDelete()	0	21	4
A	truncateDirectory()	0	16	4
A	truncateDir()	0	5	1

<?php

namespace SimpleImageManager\Managers;

trait CanDelete
{
    /**
     * List of deleted configuration formats.
     * Useful if you deleted some configuration but still files exists for old created files
     * and you need do delete these formats on delete file.
     *
     * @var array
     */
    public array $deletedFormats = [];

    /**
     * Clear empty directory after deletion files.
     * Warning: this function is memory and time-consuming when there can be too many files.
     *
     * @var bool
     */
    public bool $truncateDir = false;

    /**
     * @param array $formats
     *
     * @return $this
     */
    public function setDeletedFormats(array $formats = []): static
    {
        $this->deletedFormats = $formats;

        return $this;
    }

    /**
     * @param bool $truncateDir
     * @return $this
     */
    public function truncateDir(bool $truncateDir = true): static
    {
        $this->truncateDir = $truncateDir;

        return $this;
    }

    /**
     * Get files list with all formats to delete.
     *
     * @param string $fileName
     * @return array
     */
    protected function filesToDelete(string $fileName): array
    {
        if (!$fileName) {
            return [];
        }

        $filesToDelete = [
            $fileName,
        ];

        [$name, $extension] = $this->explodeFilename($fileName);

It seems like explodeFilename() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        foreach (array_keys($this->formats) as $format) {
            $filesToDelete[] = "{$name}-{$format}.{$extension}";
        }

        foreach ($this->deletedFormats as $format) {
            $filesToDelete[] = "{$name}-{$format}.{$extension}";
        }

        return array_unique($filesToDelete);
    }

    /**
     * Clear empty directory if this is required.
     *
     * @param string $fileName
     * @return bool
     */
    protected function truncateDirectory(string $fileName): bool
    {
        if (!$this->truncateDir) {
            return false;
        }

        $directoryName = dirname($fileName);

        if (
            !$directoryName ||
            !empty($this->storage()->allFiles($directoryName))

It seems like storage() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        ) {
            return false;
        }

        return $this->storage()->deleteDirectory($directoryName);
    }
}