irishdan / ResponsiveImageBundle

Uploader.php

<?php
/**
 * This file is part of the IrishDan\ResponsiveImageBundle package.
 *
 * (c) Daniel Byrne <danielbyrne@outlook.com>
 *
 * For the full copyright and license information, please view the LICENSE file that was distributed with this source
 * code.
 */

namespace IrishDan\ResponsiveImageBundle;

use IrishDan\ResponsiveImageBundle\Event\UploaderEvent;
use IrishDan\ResponsiveImageBundle\Event\UploaderEvents;
use IrishDan\ResponsiveImageBundle\File\FilenameTransliteratorInterface;
use IrishDan\ResponsiveImageBundle\File\FileValidatorInterface;
use IrishDan\ResponsiveImageBundle\FileSystem\PrimaryFileSystemWrapper;
use League\Flysystem\AdapterInterface;
use League\Flysystem\FilesystemInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\HttpFoundation\File\Exception\FileException;
use Symfony\Component\HttpFoundation\File\UploadedFile;

/**
 * Class Uploader
 *
 * @package ResponsiveImageBundle
 */
class Uploader implements UploaderInterface
{
    /**
     * @var FilesystemInterface $fileSystem
     */
    protected $fileSystem;
    /**
     * @var UploadedFile $file
     */
    protected $file;
    /**
     * @var
     */
    protected $error;
    /**
     * @var FilenameTransliteratorInterface
     */
    protected $transliterator;
    /**
     * @var FileValidatorInterface
     */
    protected $fileValidator;

    /**
     * Uploader constructor.
     *
     * @param PrimaryFileSystemWrapper             $PrimaryFileSystemWrapper
     * @param FilenameTransliteratorInterface|null $transliterator
     * @param FileValidatorInterface|null          $fileValidator
     * @param EventDispatcherInterface|null        $eventDispatcher
     */
    public function __construct(
        PrimaryFileSystemWrapper $PrimaryFileSystemWrapper,
        FilenameTransliteratorInterface $transliterator = null,
        FileValidatorInterface $fileValidator = null,
        EventDispatcherInterface $eventDispatcher = null
    ) {
        $this->fileSystem      = $PrimaryFileSystemWrapper->getFileSystem();
        $this->transliterator  = $transliterator;
        $this->fileValidator   = $fileValidator;
        $this->eventDispatcher = $eventDispatcher;

The property eventDispatcher does not exist. Did you maybe forget to declare it?

    }

    public function upload(ResponsiveImageInterface $image)
    {
        // Dispatch pre-upload event.
        if (!empty($this->eventDispatcher)) {
            $uploaderEvent = new UploaderEvent($this);
            $this->eventDispatcher->dispatch(UploaderEvents::UPLOADER_PRE_UPLOAD, $uploaderEvent);
        }

        $this->file = $image->getFile();

        // Use UploadedFile's inbuilt validation and allow
        // implementation specific custom checks on uploaded file
        if ($this->file->isValid() && $this->isValid()) {

            // Alter name for uniqueness
            $path = $this->formatPath();

            $info = getimagesize($this->file);
            list($length, $height) = $info;

            // Save the actual file to the filesystem.
            $stream = fopen($this->file->getRealPath(), 'r+');
            $this->fileSystem->writeStream($path, $stream);
            fclose($stream);

            $image->setPath($path);
            $image->setHeight($length);
            $image->setWidth($height);

            // If the image has a setFileSystem method set the filesystem data.
            if (method_exists($image, 'setFileSystem')) {
                $storageData = $this->getStorageDataFormFileSystem();
                if (!empty($storageData)) {
                    $image->setFileSystem(serialize($storageData));

The method setFileSystem() does not exist on IrishDan\ResponsiveImageBundle\ResponsiveImageInterface. Did you maybe mean setFile()?

                }
            }

            // Clean up the file property as you won't need it anymore.
            $this->file = null;
            $image->setFile(null);

null is of type null, but the function expects a object<Symfony\Component\HttpFoundation\File\UploadedFile>.

            // Dispatch uploaded event
            if (!empty($uploaderEvent)) {
                $this->eventDispatcher->dispatch(UploaderEvents::UPLOADER_UPLOADED, $uploaderEvent);
            }
        }
        else {
            $error = empty($this->error) ? $this->file->getErrorMessage() : $this->error;
            throw new FileException(
                $error
            );
        }
    }

    protected function getStorageDataFormFileSystem()
    {
        $adapter     = $this->fileSystem->getAdapter();
        $adapterType = $this->getAdapterType($adapter);

        // @TODO: This should be part of the urlEncoders
        switch ($adapterType) {
            case 'AwsS3Adapter':
                $prefix = $adapter->getPathPrefix();
                $bucket = $adapter->getBucket();
                $region = $adapter->getClient()->getRegion();

                return [
                    'adapter' => $adapterType,
                    'prefix'  => $prefix,
                    'bucket'  => $bucket,
                    'region'  => $region,
                ];

                break;

break is not strictly necessary here and could be removed.

            case 'Local':
                return [
                    'adapter' => $adapterType,
                    'prefix'  => 'test/images', // @TODO: what is this?
                ];

                break;

break is not strictly necessary here and could be removed.

        }

        return [];
    }

    protected function getAdapterType(AdapterInterface $adapter)

This method seems to be duplicated in your project.

    {
        $class          = get_class($adapter);
        $namespaceArray = explode("\\", $class);

        return array_pop($namespaceArray);
    }

    protected function formatPath()
    {
        $path = $this->file->getClientOriginalName();
        if ($this->transliterator instanceof FilenameTransliteratorInterface) {
            $path = $this->transliterator->transliterate($path);
        }

        return $path;
    }

    protected function isValid()
    {
        if ($this->fileValidator instanceof FileValidatorInterface) {
            return $this->fileValidator->validate($this->file);
        }

        return true;
    }
}