Spiral\Storage\Storage\WritableTrait

Complexity

Total Complexity

35

Size/Duplication

Total Lines	257
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	copy()	0	19	4
A	delete()	0	12	3
A	toFlysystemVisibility()	0	8	2
A	move()	0	23	4
A	hasFiles()	0	9	2
A	hasParentDirectory()	0	3	2
A	write()	0	26	6
A	create()	0	3	1
A	isStringable()	0	15	4
A	setVisibility()	0	14	2
A	deleteEmptyDirectories()	0	16	4
A	getParentDirectory()	0	3	1

<?php

/**
 * This file is part of Spiral Framework package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Spiral\Storage\Storage;

use JetBrains\PhpStorm\ExpectedValues;
use League\Flysystem\FilesystemException;
use League\Flysystem\FilesystemOperator;
use Spiral\Storage\Exception\FileOperationException;
use Spiral\Storage\FileInterface;
use Spiral\Storage\StorageInterface;
use Spiral\Storage\Visibility;

/**
 * @mixin WritableInterface
 */
trait WritableTrait
{
    /**
     * {@inheritDoc}
     */
    public function create(string $pathname, array $config = []): FileInterface
    {
        return $this->write($pathname, '', $config);
    }

    /**
     * {@inheritDoc}
     */
    public function write(string $pathname, $content, array $config = []): FileInterface
    {
        assert(\is_resource($content) || $this->isStringable($content));

        $fs = $this->getOperator();

        try {
            switch (true) {
                case \is_object($content):

is_object($content) is not reachable.

                case \is_string($content):
                    $fs->write($pathname, (string)$content, $config);
                    break;

                case \is_resource($content):
                    $fs->writeStream($pathname, $content, $config);
                    break;

                default:
                    $message = 'Content must be a resource stream or stringable type, but %s passed';
                    throw new \InvalidArgumentException(\sprintf($message, \get_debug_type($content)));
            }
        } catch (FilesystemException $e) {
            throw new FileOperationException($e->getMessage(), (int)$e->getCode(), $e);
        }

        return $this->file($pathname);

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

    }

    /**
     * {@inheritDoc}
     */
    public function setVisibility(
        string $pathname,
        #[ExpectedValues(valuesFromClass: Visibility::class)]
        string $visibility
    ): FileInterface {
        $fs = $this->getOperator();

        try {
            $fs->setVisibility($pathname, $this->toFlysystemVisibility($visibility));
        } catch (FilesystemException $e) {
            throw new FileOperationException($e->getMessage(), (int)$e->getCode(), $e);
        }

        return $this->file($pathname);
    }

    /**
     * {@inheritDoc}
     */
    public function copy(
        string $source,
        string $destination,
        StorageInterface $storage = null,
        array $config = []
    ): FileInterface {
        $fs = $this->getOperator();

        if ($storage === null || $storage === $this) {
            try {
                $fs->copy($source, $destination, $config);
            } catch (FilesystemException $e) {
                throw new FileOperationException($e->getMessage(), (int)$e->getCode(), $e);
            }

            return $this->file($destination);
        }

        return $storage->write($destination, $this->getStream($source), $config);

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

    }

    /**
     * {@inheritDoc}
     */
    public function move(
        string $source,
        string $destination,
        StorageInterface $storage = null,
        array $config = []
    ): FileInterface {
        $fs = $this->getOperator();

        if ($storage === null || $storage === $this) {
            try {
                $fs->move($source, $destination, $config);
            } catch (FilesystemException $e) {
                throw new FileOperationException($e->getMessage(), (int)$e->getCode(), $e);
            }

            return $this->file($destination);
        }

        $result = $storage->write($destination, $this->getStream($source), $config);

        $fs->delete($source);

        return $result;
    }

    /**
     * {@inheritDoc}
     */
    public function delete(string $pathname, bool $clean = false): void
    {
        $fs = $this->getOperator();

        try {
            $fs->delete($pathname);

            if ($clean) {
                $this->deleteEmptyDirectories($this->getParentDirectory($pathname));
            }
        } catch (FilesystemException $e) {
            throw new FileOperationException($e->getMessage(), (int)$e->getCode(), $e);
        }
    }
    /**
     * @return FilesystemOperator
     */
    abstract protected function getOperator(): FilesystemOperator;

    /**
     * @param string $visibility
     * @return string
     */
    #[ExpectedValues(valuesFromClass: \League\Flysystem\Visibility::class)]
    private function toFlysystemVisibility(
        #[ExpectedValues(valuesFromClass: Visibility::class)]
        string $visibility
    ): string {
        return ($visibility === Visibility::VISIBILITY_PUBLIC)
            ? \League\Flysystem\Visibility::PUBLIC
            : \League\Flysystem\Visibility::PRIVATE;
    }

    /**
     * Internal helper method that returns directory name of passed path.
     *
     * Please note that the use of the PHP {@see \dirname()} function depends
     * on the operating system and it MAY NOT return correct parent directory
     * in the case of slash character (`/` or `\`) incompatible with the
     * current runtime.
     *
     * @internal This is an internal method, please do not use it in your code.
     * @psalm-internal Spiral\Storage\Storage
     *
     * @param string $path
     * @return string
     */
    private function getParentDirectory(string $path): string
    {
        return \dirname(\str_replace(['\\', '/'], \DIRECTORY_SEPARATOR, $path));
    }

    /**
     * Internal helper method that returns bool {@see true} if the passed
     * directory is the root for the file.
     *
     * @internal This is an internal method, please do not use it in your code.
     * @psalm-internal Spiral\Storage\Storage
     *
     * @param string $directory
     * @return bool
     */
    private function hasParentDirectory(string $directory): bool
    {
        return $directory !== '' && $directory !== '.';
    }

    /**
     * Internal helper method that recursively deletes empty directories.
     *
     * @internal This is an internal method, please do not use it in your code.
     * @psalm-internal Spiral\Storage\Storage
     *
     * @param string $directory
     * @throws FileOperationException
     */
    private function deleteEmptyDirectories(string $directory): void
    {
        if (!$this->hasParentDirectory($directory)) {
            return;
        }

        $fs = $this->getOperator();

        try {
            if (!$this->hasFiles($directory)) {
                $fs->deleteDirectory($directory);

                $this->deleteEmptyDirectories($this->getParentDirectory($directory));
            }
        } catch (FilesystemException $e) {
            throw new FileOperationException($e->getMessage(), (int)$e->getCode(), $e);
        }
    }

    /**
     * Internal helper method that returns bool {@see true} if directory
     * not empty.
     *
     * Note: Be careful, this method can be quite slow as it asks for a
     * list of files from filesystem.
     *
     * @internal This is an internal method, please do not use it in your code.
     * @psalm-internal Spiral\Storage\Storage
     *
     * @param string $directory
     * @return bool
     * @throws FilesystemException
     */
    private function hasFiles(string $directory): bool
    {
        $fs = $this->getOperator();

        foreach ($fs->listContents($directory) as $_) {
            return true;
        }

        return false;
    }

    /**
     * Internal helper method that returns bool {@see true} if passed argument
     * can be converted to string.
     *
     * @param string|\Stringable $value
     * @return bool
     */
    private function isStringable($value): bool
    {
        if (\is_string($value)) {
            return true;
        }

        if (!\is_object($value)) {
            return false;
        }

        if (\PHP_VERSION_ID >= 80000) {
            return $value instanceof \Stringable;
        }

        return \method_exists($value, '__toString');
    }
}