jobtech-dev / laravel-chunky

src/Chunk.php

<?php

namespace Jobtech\LaravelChunky;

use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;
use Illuminate\Contracts\Support\Responsable;
use Illuminate\Http\Resources\Json\JsonResource;

The type Illuminate\Http\Resources\Json\JsonResource was not found. Maybe you did not declare it correctly or list all dependencies?

use Illuminate\Http\UploadedFile;

The type Illuminate\Http\UploadedFile was not found. Maybe you did not declare it correctly or list all dependencies?

use Illuminate\Support\Arr;
use Illuminate\Support\Str;
use Illuminate\Support\Traits\ForwardsCalls;
use Jobtech\LaravelChunky\Http\Resources\ChunkResource;
use Symfony\Component\HttpFoundation\File\File;

The type Symfony\Component\HttpFoundation\File\File was not found. Maybe you did not declare it correctly or list all dependencies?

class Chunk implements Arrayable, Jsonable, Responsable
{
    use ForwardsCalls;

    /** @var bool */
    private $show_file_info = true;

    /** @var int */
    private $index;

    /** @var \Symfony\Component\HttpFoundation\File\File|string */
    private $path;

    /** @var string|null */
    private $disk;

    /** @var bool */
    private $last;

    public function __construct(int $index, $path, $disk = null, $last = false)
    {
        $this->index = $index;
        $this->path = $path;
        $this->disk = $disk;
        $this->last = $last;
    }

    /**
     * @return int
     */
    public function getIndex(): int
    {
        return $this->index;
    }

    /**
     * @return string
     */
    public function getPath(): string
    {
        if ($this->path instanceof File) {
            return $this->path->getRealPath();
        }

        return $this->path;
    }

    /**
     * @return mixed
     */
    public function getOriginalPath()
    {
        return $this->path;
    }

    /**
     * @param $path
     */
    public function setPath($path)
    {
        $this->path = $path;
    }

    /**
     * @param string|null $suffix
     * @return string
     */
    public function getFilename($suffix = null): string
    {
        if ($this->path instanceof UploadedFile) {
            return basename($this->path->getClientOriginalName(), $suffix);
        }

        if ($this->path instanceof File) {

$this->path is never a sub-type of Symfony\Component\HttpFoundation\File\File.

            return $this->path->getBasename($suffix);
        }

        return basename($this->path, $suffix);
    }

    /**
     * @return string
     */
    public function getName(): string
    {
        return pathinfo(
            $this->getFilename($this->getExtension()),

It seems like $this->getExtension() can also be of type string[]; however, parameter $suffix of Jobtech\LaravelChunky\Chunk::getFilename() does only seem to accept null|string, maybe add an additional type check?

            PATHINFO_FILENAME
        );
    }

    /**
     * @return string|string[]
     */
    public function getExtension()
    {
        return pathinfo($this->getFilename(), PATHINFO_EXTENSION);
    }

    /**
     * @return string
     */
    public function getSlug(): string
    {
        return $this->index.'_'.Str::slug($this->getName()).'.'.$this->getExtension();

Are you sure $this->getExtension() of type string|string[] can be used in concatenation?

    }

    /**
     * Retrieve the chunk file disk.
     *
     * @return string|null
     */
    public function getDisk(): ?string
    {
        return $this->disk;
    }

    /**
     * Set the chunk file disk.
     *
     * @param string|null $disk
     */
    public function setDisk($disk = null)
    {
        $this->disk = $disk;
    }

    /**
     * @return bool
     */
    public function isLast(): bool
    {
        return $this->last;
    }

    /**
     * @param bool $last
     */
    public function setLast(bool $last): void
    {
        $this->last = $last;
    }

    /**
     * If this method is called, when a chunk is turned to array, the file path and real path
     * will be omitted.
     *
     * @return $this
     */
    public function hideFileInfo()
    {
        $this->show_file_info = false;

        return $this;
    }

    /**
     * If this method is called, when a chunk is turned to array, the file path and real path
     * will be included.
     *
     * @return $this
     */
    public function showFileInfo()
    {
        $this->show_file_info = true;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function toArray(): array
    {
        $extension = $this->getExtension();

        $data = [
            'name'      => $this->getName(),
            'extension' => $extension,
            'index'     => $this->getIndex(),
            'last'      => $this->isLast(),
        ];

        if ($this->show_file_info) {
            $data['file'] = $this->getFilename();
            $data['path'] = $this->getPath();
        }

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function toJson($options = 0): string
    {
        return json_encode($this->toArray(), $options);
    }

    /**
     * {@inheritdoc}
     */
    public function toResponse($request)
    {
        return $this->toResource()
            ->toResponse($request);
    }

    /**
     * Transforms the current model into a json resource.
     */
    public function toResource(): JsonResource
    {
        /** @var \Illuminate\Http\Resources\Json\JsonResource $resource */
        $resource = config('chunky.resource', ChunkResource::class);

The function config was not found. Maybe you did not declare it correctly or list all dependencies?

        return new $resource($this);
    }

    /**
     * @param \Symfony\Component\HttpFoundation\File\File|string $file
     * @param int $index
     * @param array $options
     *
     * @return \Jobtech\LaravelChunky\Chunk
     */
    public static function create($file, int $index, $options = [])
    {
        return new static($index, $file, Arr::pull($options, 'disk'));
    }
}