jobtech-dev / laravel-chunky

src/ChunkySettings.php

<?php

namespace Jobtech\LaravelChunky;

use Illuminate\Contracts\Config\Repository;
use Illuminate\Support\Arr;
use Illuminate\Support\Str;
use Jobtech\LaravelChunky\Contracts\MergeHandler;
use Jobtech\LaravelChunky\Exceptions\ChunkyException;

class ChunkySettings
{
    /** @var int */
    const INDEX_ZERO = 0;

    /** @var int */
    const INDEX_ONE = 1;

    private ?MergeHandler $handler = null;

    /** @var array */
    private $config;

    public function __construct(Repository $config)
    {
        $this->config = $config->get('chunky');
    }

    /**
     * Retrieve the chunky configurations.
     *
     * @return array
     */
    public function config(): array
    {
        return $this->config;
    }

    /**
     * Retrieve the default chunks disk.
     *
     * @return string|null
     */
    public function chunksDisk(): ?string
    {
        return Arr::get($this->config, 'disks.chunks.disk');
    }

    /**
     * Retrieve the chunks destination folder.
     *
     * @return string
     */
    public function chunksFolder(): string
    {
        $folder = Arr::get($this->config, 'disks.chunks.folder');

        if ($folder === null) {
            return '';
        }

        if (! Str::endsWith($folder, '/')) {
            $folder .= DIRECTORY_SEPARATOR;
        }

        return $folder;
    }

    /**
     * Retrieve the default merge file disk.
     *
     * @return string|null
     */
    public function mergeDisk(): ?string
    {
        return Arr::get($this->config, 'disks.merge.disk');
    }

    /**
     * Retrieve the merge file destination folder.
     *
     * @return string
     */
    public function mergeFolder(): string
    {
        $folder = Arr::get($this->config, 'disks.merge.folder');

        if ($folder === null) {
            return '';
        }

        if (! Str::endsWith($folder, '/')) {
            $folder .= DIRECTORY_SEPARATOR;
        }

        return $folder;
    }

    /**
     * Retrieve the default index value for chunks.
     *
     * @return int
     */
    public function defaultIndex(): int
    {
        return Arr::get($this->config, 'index', self::INDEX_ZERO)
            ?: self::INDEX_ZERO;
    }

    /**
     * Retrieve the additional options for chunk store.
     *
     * @return array
     */
    public function additionalChunksOptions(): array
    {
        return Arr::get($this->config, 'options.chunks', []);
    }

    /**
     * Retrieve the additional options for merge store.
     *
     * @return array
     */
    public function additionalMergeOptions(): array
    {
        return Arr::get($this->config, 'options.merge', []);
    }

    /**
     * Retrieve the auto merge option.
     *
     * @return bool
     */
    public function autoMerge(): bool
    {
        return Arr::get($this->config, 'auto_merge', false);
    }

    /**
     * Retrieve the default merge handler.
     *
     * @return MergeHandler
     */
    public function mergeHandler(): MergeHandler
    {
        if ($this->handler === null) {
            $handler = Arr::get($this->config, 'merge.handler');

            if (! class_exists($handler)) {
                throw new ChunkyException("Undefined handler $handler");
            }

            $this->handler = $handler::instance();
        }

        return $this->handler;

The expression return $this->handler could return the type null which is incompatible with the type-hinted return Jobtech\LaravelChunky\Contracts\MergeHandler. Consider adding an additional type-check to rule them out.

    }

    /**
     * Retrieve the queue connection for the merge job.
     *
     * @return string
     */
    public function connection()
    {
        return Arr::get($this->config, 'merge.connection');
    }

    /**
     * Retrieve the queue for the merge job.
     *
     * @return array|\ArrayAccess|mixed
     */
    public function queue()
    {
        return Arr::get($this->config, 'merge.queue');
    }
}