FileProcessor Class Reference

Public Member Functions
	__construct (\Magento\Framework\Filesystem $filesystem, \Magento\MediaStorage\Model\File\UploaderFactory $uploaderFactory, \Magento\Framework\UrlInterface $urlBuilder, \Magento\Framework\Url\EncoderInterface $urlEncoder, $entityTypeCode, \Magento\Framework\File\Mime $mime, array $allowedExtensions=[])
	getBase64EncodedData ($fileName)
	getStat ($fileName)
	getMimeType ($fileName)
	isExist ($fileName)
	getViewUrl ($filePath, $type)
	moveTemporaryFile ($fileName)
	removeUploadedFile ($fileName)

Data Fields
const	TMP_DIR = 'tmp'

Detailed Description

Definition at line 8 of file FileProcessor.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Filesystem	$filesystem,
		\Magento\MediaStorage\Model\File\UploaderFactory	$uploaderFactory,
		\Magento\Framework\UrlInterface	$urlBuilder,
		\Magento\Framework\Url\EncoderInterface	$urlEncoder,
			$entityTypeCode,
		\Magento\Framework\File\Mime	$mime,
		array	$allowedExtensions = []
	)

Parameters

\Magento\Framework\Filesystem	$filesystem
\Magento\MediaStorage\Model\File\UploaderFactory	$uploaderFactory
\Magento\Framework\UrlInterface	$urlBuilder
\Magento\Framework\Url\EncoderInterface	$urlEncoder
string	$entityTypeCode
\Magento\Framework\File\Mime	$mime
array	$allowedExtensions

Definition at line 59 of file FileProcessor.php.

      {
        $this->mediaDirectory = $filesystem->getDirectoryWrite(\Magento\Framework\App\Filesystem\DirectoryList::MEDIA);
        $this->uploaderFactory = $uploaderFactory;
        $this->urlBuilder = $urlBuilder;
        $this->urlEncoder = $urlEncoder;
        $this->entityTypeCode = $entityTypeCode;
        $this->mime = $mime;
        $this->allowedExtensions = $allowedExtensions;
    }

Member Function Documentation

getBase64EncodedData()

getBase64EncodedData

(

$fileName

)

Retrieve base64 encoded file content

Parameters

string

$fileName

Returns

string

Definition at line 83 of file FileProcessor.php.

    {
        $filePath = $this->entityTypeCode . '/' . ltrim($fileName, '/');

        $fileContent = $this->mediaDirectory->readFile($filePath);

        $encodedContent = base64_encode($fileContent);
        return $encodedContent;
    }

getMimeType()

getMimeType

(

$fileName

)

Retrieve MIME type of requested file

Parameters

string

$fileName

Returns

string

Definition at line 113 of file FileProcessor.php.

    {
        $filePath = $this->entityTypeCode . '/' . ltrim($fileName, '/');
        $absoluteFilePath = $this->mediaDirectory->getAbsolutePath($filePath);

        $result = $this->mime->getMimeType($absoluteFilePath);
        return $result;
    }

getStat()

getStat

(

$fileName

)

Get file statistics data

Parameters

string

$fileName

Returns

array

Definition at line 99 of file FileProcessor.php.

    {
        $filePath = $this->entityTypeCode . '/' . ltrim($fileName, '/');

        $result = $this->mediaDirectory->stat($filePath);
        return $result;
    }

getViewUrl()

getViewUrl	(		$filePath,
			$type
	)

Retrieve customer/index/viewfile action URL

Parameters

string	$filePath
string	$type

Returns

string

Definition at line 143 of file FileProcessor.php.

    {
        $viewUrl = '';

        if ($this->entityTypeCode == \Magento\Customer\Api\AddressMetadataInterface::ENTITY_TYPE_ADDRESS) {
            $filePath = $this->entityTypeCode . '/' . ltrim($filePath, '/');
            $viewUrl = $this->urlBuilder->getBaseUrl(['_type' => \Magento\Framework\UrlInterface::URL_TYPE_MEDIA])
                . $this->mediaDirectory->getRelativePath($filePath);
        }

        if ($this->entityTypeCode == \Magento\Customer\Api\CustomerMetadataInterface::ENTITY_TYPE_CUSTOMER) {
            $viewUrl = $this->urlBuilder->getUrl(
                'customer/index/viewfile',
                [$type => $this->urlEncoder->encode(ltrim($filePath, '/'))]
            );
        }

        return $viewUrl;
    }

isExist()

isExist

(

$fileName

)

Check if the file exists

Parameters

string

$fileName

Returns

bool

Definition at line 128 of file FileProcessor.php.

    {
        $filePath = $this->entityTypeCode . '/' . ltrim($fileName, '/');

        $result = $this->mediaDirectory->isExist($filePath);
        return $result;
    }

moveTemporaryFile()

moveTemporaryFile

(

$fileName

)

Move file from temporary directory into base directory

Parameters

string

$fileName

Returns

string

Exceptions

Definition at line 201 of file FileProcessor.php.

    {
        $fileName = ltrim($fileName, '/');

        $dispersionPath = \Magento\MediaStorage\Model\File\Uploader::getDispersionPath($fileName);
        $destinationPath = $this->entityTypeCode . $dispersionPath;

        if (!$this->mediaDirectory->create($destinationPath)) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('Unable to create directory %1.', $destinationPath)
            );
        }

        if (!$this->mediaDirectory->isWritable($destinationPath)) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('Destination folder is not writable or does not exists.')
            );
        }

        $destinationFileName = \Magento\MediaStorage\Model\File\Uploader::getNewFileName(
            $this->mediaDirectory->getAbsolutePath($destinationPath) . '/' . $fileName
        );

        try {
            $this->mediaDirectory->renameFile(
                $this->entityTypeCode . '/' . self::TMP_DIR . '/' . $fileName,
                $destinationPath . '/' . $destinationFileName
            );
        } catch (\Exception $e) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('Something went wrong while saving the file.')
            );
        }

        $fileName = $dispersionPath . '/' . $fileName;
        return $fileName;
    }

removeUploadedFile()

removeUploadedFile

(

$fileName

)

Remove uploaded file

Parameters

string

$fileName

Returns

bool

Definition at line 245 of file FileProcessor.php.

    {
        $filePath = $this->entityTypeCode . '/' . ltrim($fileName, '/');

        $result = $this->mediaDirectory->delete($filePath);
        return $result;
    }

Field Documentation

TMP_DIR

const TMP_DIR = 'tmp'

Temporary directory name

Definition at line 13 of file FileProcessor.php.

---

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

• vendor/magento/module-customer/Model/FileProcessor.php