bytic / MediaLibrary

src/FileAdder/Traits/HasFileTrait.php

<?php

namespace ByTIC\MediaLibrary\FileAdder\Traits;

use Nip\Logger\Exception;
use Symfony\Component\HttpFoundation\File\File as SymfonyFile;
use Symfony\Component\HttpFoundation\File\UploadedFile;

/**
 * Trait HasFileTrait
 * @package ByTIC\MediaLibrary\FileAdder\Traits
 */
trait HasFileTrait
{
    /** @var string|\Symfony\Component\HttpFoundation\File\File */
    protected $file;

    /** @var string */
    protected $fileName;

    /** @var string */
    protected $pathToFile;

    /**
     * @return string|SymfonyFile
     */
    public function getFile()
    {
        return $this->file;
    }

    /**
     * @return string
     */
    public function getPathToFile(): string
    {
        return $this->pathToFile;
    }

    /**
     * @param string $pathToFile
     */
    public function setPathToFile(string $pathToFile)
    {
        $this->pathToFile = $pathToFile;
    }

    /**
     * @param $file
     *
     * @throws Exception
     *
     * @return $this
     */
    public function setFile($file)
    {
        if (is_string($file)) {
            $file = new SymfonyFile($file, true);
        }
        if ($file instanceof UploadedFile) {
            return $this->setFileFromUploadedFile($file);
        }
        if ($file instanceof SymfonyFile) {
            return $this->setFileFromSymfonyFile($file);
        }

        throw new Exception('Invalid File');
    }

    /**
     * @param SymfonyFile $file
     *
     * @throws Exception
     *
     * @return $this
     */
    public function setFileFromSymfonyFile($file)
    {
        $this->file = $file;
        $this->setPathToFile($file->getPath() . '/' . $file->getFilename());
        $this->setFileName(pathinfo($file->getFilename(), PATHINFO_BASENAME));

It seems like pathinfo($file->getFilename(), ByTIC\MediaLibrary\FileAdder\Traits\PATHINFO_BASENAME) can also be of type array; however, parameter $fileName of ByTIC\MediaLibrary\FileAdder\Traits\HasFileTrait::setFileName() does only seem to accept string, maybe add an additional type check?

        $this->mediaName = pathinfo($file->getFilename(), PATHINFO_FILENAME);

The property mediaName does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $this;
    }

    /**
     * @param UploadedFile $file
     *
     * @return $this
     */
    public function setFileFromUploadedFile($file)
    {
        $this->file = $file;
        $this->setPathToFile($file->getPath() . '/' . $file->getFilename());
        $this->setFileName($file->getClientOriginalName());
        $this->mediaName = pathinfo($file->getClientOriginalName(), PATHINFO_FILENAME);

The property mediaName does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $this;
    }

    /**
     * Set the name of the file that is stored on disk.
     *
     * @param string $fileName
     *
     * @return $this
     */
    public function setFileName(string $fileName)
    {
        $this->fileName = $this->sanitizeFileName($fileName);

        return $this;
    }

    /**
     * @param $fileName
     *
     * @return string
     */
    protected function sanitizeFileName(string $fileName): string
    {
        return str_replace(['#', '/', '\\'], '-', $fileName);
    }
}