Uploader Class Reference

Public Member Functions
	__construct (\Magento\Framework\Filesystem $filesystem, \Magento\Framework\HTTP\Adapter\FileTransferFactory $adapterFactory, \Magento\Framework\File\UploaderFactory $uploaderFactory)
	uploadPreviewImage ($scope, $destinationPath)

Protected Attributes
	$_allowedExtensions = ['jpg', 'jpeg', 'gif', 'png', 'xbm', 'wbmp']
	$_filesystem
	$_transferAdapter
	$_uploaderFactory

Detailed Description

Theme Image Uploader

Definition at line 11 of file Uploader.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Filesystem	$filesystem,
		\Magento\Framework\HTTP\Adapter\FileTransferFactory	$adapterFactory,
		\Magento\Framework\File\UploaderFactory	$uploaderFactory
	)

Constructor

Parameters

\Magento\Framework\Filesystem	$filesystem
\Magento\Framework\HTTP\Adapter\FileTransferFactory	$adapterFactory
\Magento\Framework\File\UploaderFactory	$uploaderFactory

Definition at line 48 of file Uploader.php.

      {
        $this->_filesystem = $filesystem;
        $this->_transferAdapter = $adapterFactory->create();
        $this->_uploaderFactory = $uploaderFactory;
    }

Member Function Documentation

uploadPreviewImage()

uploadPreviewImage	(		$scope,
			$destinationPath
	)

Upload preview image

Parameters

string	$scope	the request key for file
string	$destinationPath	path to upload directory

Returns

bool

Exceptions

Definition at line 66 of file Uploader.php.

    {
        if (!$this->_transferAdapter->isUploaded($scope)) {
            return false;
        }
        if (!$this->_transferAdapter->isValid($scope)) {
            throw new \Magento\Framework\Exception\LocalizedException(
                new \Magento\Framework\Phrase('Uploaded image is not valid')
            );
        }
        $upload = $this->_uploaderFactory->create(['fileId' => $scope]);
        $upload->setAllowCreateFolders(true);
        $upload->setAllowedExtensions($this->_allowedExtensions);
        $upload->setAllowRenameFiles(true);
        $upload->setFilesDispersion(false);

        if (!$upload->checkAllowedExtension($upload->getFileExtension())) {
            throw new \Magento\Framework\Exception\LocalizedException(
                new \Magento\Framework\Phrase('Invalid image file type.')
            );
        }
        if (!$upload->save($destinationPath)) {
            throw new \Magento\Framework\Exception\LocalizedException(
                new \Magento\Framework\Phrase('Image can not be saved.')
            );
        }
        return $destinationPath . '/' . $upload->getUploadedFileName();
    }

Field Documentation

$_allowedExtensions

$_allowedExtensions = ['jpg', 'jpeg', 'gif', 'png', 'xbm', 'wbmp']

protected

Definition at line 18 of file Uploader.php.

$_filesystem

$_filesystem

protected

Definition at line 25 of file Uploader.php.

$_transferAdapter

$_transferAdapter

protected

Definition at line 32 of file Uploader.php.

$_uploaderFactory

$_uploaderFactory

protected

Definition at line 39 of file Uploader.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/View/Design/Theme/Image/Uploader.php