Sfneal\Helpers\Aws\S3\Utils\CloudStorage

Complexity

Total Complexity

7

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setDisk()	0	5	1
A	storageDisk()	0	3	1
A	disableStreaming()	0	5	1
A	getKey()	0	3	1
A	__construct()	0	5	1
A	isStreamingEnabled()	0	3	1
A	enableStreaming()	0	5	1

<?php

namespace Sfneal\Helpers\Aws\S3\Utils;

use Illuminate\Contracts\Filesystem\Filesystem;
use Illuminate\Filesystem\FilesystemAdapter;
use Illuminate\Support\Facades\Storage;

class CloudStorage
{
    /**
     * @var string AWS S3 file key
     */
    protected $s3Key;

    /**
     * @var string Storage S3 cloud disk name
     */
    protected $disk;

    /**
     * @var bool Enable/disable upload & download streaming
     */
    protected $streaming;

    /**
     * S3 constructor.
     *
     * @param string $s3Key
     */
    public function __construct(string $s3Key)
    {
        $this->s3Key = $s3Key;
        $this->disk = config('filesystem.cloud', 's3');
        $this->streaming = config('s3-helpers.streaming', true);
    }

    /**
     * Retrieve a Filesystem instance for the specified disk.
     *
     * @return Filesystem|FilesystemAdapter
     */
    protected function storageDisk(): FilesystemAdapter
    {
        return Storage::disk($this->disk);
    }

    /**
     * Determine if upload/download streaming is enabled.
     *
     * @return bool
     */
    protected function isStreamingEnabled(): bool
    {
        return $this->streaming;
    }

    /**
     * Retrieve the S3 key (useful in conjunctions with `autocompletePath()` method).
     *
     * @return string
     */
    public function getKey(): string
    {
        return $this->s3Key;
    }

    /**
     * Set the filesystem disk.
     *
     * @param string $disk
     * @return $this
     */
    public function setDisk(string $disk): self
    {
        $this->disk = $disk;

        return $this;
    }

    /**
     * Enable upload/download streaming regardless of config setting.
     *
     * @return $this
     */
    public function enableStreaming(): self
    {
        $this->streaming = true;

        return $this;
    }

    /**
     * Disable upload/download streaming regardless of config setting.
     *
     * @return $this
     */
    public function disableStreaming(): self
    {
        $this->streaming = false;

        return $this;
    }
}