ImageUploader Class Reference

Public Member Functions
	__construct (\Magento\MediaStorage\Helper\File\Storage\Database $coreFileStorageDatabase, \Magento\Framework\Filesystem $filesystem, \Magento\MediaStorage\Model\File\UploaderFactory $uploaderFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Psr\Log\LoggerInterface $logger, $baseTmpPath, $basePath, $allowedExtensions)
	setBaseTmpPath ($baseTmpPath)
	setBasePath ($basePath)
	setAllowedExtensions ($allowedExtensions)
	getBaseTmpPath ()
	getBasePath ()
	getAllowedExtensions ()
	getFilePath ($path, $imageName)
	moveFileFromTmp ($imageName)

Protected Attributes
	$coreFileStorageDatabase
	$mediaDirectory
	$storeManager
	$logger
	$baseTmpPath
	$basePath
	$allowedExtensions

Detailed Description

Catalog image uploader

Definition at line 11 of file ImageUploader.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\MediaStorage\Helper\File\Storage\Database	$coreFileStorageDatabase,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\MediaStorage\Model\File\UploaderFactory	$uploaderFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Psr\Log\LoggerInterface	$logger,
			$baseTmpPath,
			$basePath,
			$allowedExtensions
	)

ImageUploader constructor

Parameters

\Magento\MediaStorage\Helper\File\Storage\Database	$coreFileStorageDatabase
\Magento\Framework\Filesystem	$filesystem
\Magento\MediaStorage\Model\File\UploaderFactory	$uploaderFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Psr\Log\LoggerInterface	$logger
string	$baseTmpPath
string	$basePath
	string[]	$allowedExtensions

Definition at line 91 of file ImageUploader.php.

      {
        $this->coreFileStorageDatabase = $coreFileStorageDatabase;
        $this->mediaDirectory = $filesystem->getDirectoryWrite(\Magento\Framework\App\Filesystem\DirectoryList::MEDIA);
        $this->uploaderFactory = $uploaderFactory;
        $this->storeManager = $storeManager;
        $this->logger = $logger;
        $this->baseTmpPath = $baseTmpPath;
        $this->basePath = $basePath;
        $this->allowedExtensions = $allowedExtensions;
    }

Member Function Documentation

getAllowedExtensions()

getAllowedExtensions

(

)

Retrieve base path

Returns

string[]

Definition at line 172 of file ImageUploader.php.

    {
        return $this->allowedExtensions;
    }

getBasePath()

getBasePath

(

)

Retrieve base path

Returns

string

Definition at line 162 of file ImageUploader.php.

    {
        return $this->basePath;
    }

getBaseTmpPath()

getBaseTmpPath

(

)

Retrieve base tmp path

Returns

string

Definition at line 152 of file ImageUploader.php.

    {
        return $this->baseTmpPath;
    }

getFilePath()

getFilePath	(		$path,
			$imageName
	)

Retrieve path

Parameters

string	$path
string	$imageName

Returns

string

Definition at line 185 of file ImageUploader.php.

    {
        return rtrim($path, '/') . '/' . ltrim($imageName, '/');
    }

moveFileFromTmp()

moveFileFromTmp

(

$imageName

)

Checking file for moving and move it

Parameters

string

$imageName

Returns

string

Exceptions

Definition at line 199 of file ImageUploader.php.

    {
        $baseTmpPath = $this->getBaseTmpPath();
        $basePath = $this->getBasePath();

        $baseImagePath = $this->getFilePath($basePath, $imageName);
        $baseTmpImagePath = $this->getFilePath($baseTmpPath, $imageName);

        try {
            $this->coreFileStorageDatabase->copyFile(
                $baseTmpImagePath,
                $baseImagePath
            );
            $this->mediaDirectory->renameFile(
                $baseTmpImagePath,
                $baseImagePath
            );
        } catch (\Exception $e) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('Something went wrong while saving the file(s).')
            );
        }

        return $imageName;
    }

setAllowedExtensions()

setAllowedExtensions

(

$allowedExtensions

)

Set allowed extensions

Parameters

string[]

$allowedExtensions

Returns

void

Definition at line 142 of file ImageUploader.php.

    {
        $this->allowedExtensions = $allowedExtensions;
    }

setBasePath()

setBasePath

(

$basePath

)

Set base path

Parameters

string

$basePath

Returns

void

Definition at line 130 of file ImageUploader.php.

    {
        $this->basePath = $basePath;
    }

setBaseTmpPath()

setBaseTmpPath

(

$baseTmpPath

)

Set base tmp path

Parameters

string

$baseTmpPath

Returns

void

Definition at line 118 of file ImageUploader.php.

    {
        $this->baseTmpPath = $baseTmpPath;
    }

Field Documentation

$allowedExtensions

$allowedExtensions

protected

Definition at line 65 of file ImageUploader.php.

$basePath

$basePath

protected

Definition at line 58 of file ImageUploader.php.

$baseTmpPath

$baseTmpPath

protected

Definition at line 51 of file ImageUploader.php.

$coreFileStorageDatabase

$coreFileStorageDatabase

protected

Definition at line 18 of file ImageUploader.php.

$logger

$logger

protected

Definition at line 44 of file ImageUploader.php.

$mediaDirectory

$mediaDirectory

protected

Definition at line 25 of file ImageUploader.php.

$storeManager

$storeManager

protected

Definition at line 39 of file ImageUploader.php.

---

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

• vendor/magento/module-catalog/Model/ImageUploader.php