File Class Reference

Inheritance diagram for File:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\MediaStorage\Helper\File\Storage\Database $coreFileStorageDatabase, \Magento\Framework\Filesystem $filesystem, array $mimeTypes=[])
	uploadFromTmp ($tmpPath, \Magento\MediaStorage\Model\File\Uploader $uploader)
	moveFileFromTmp ($baseTmpPath, $basePath, $file)
	ensureFileInFilesystem ($file)
	getFilePath ($path, $file)
	getFileFromPathFile ($pathFile)
	getFileSize ($file)
	getFileType ($filePath)
	getAllFileTypes ()
	getAllMineTypes ()
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Protected Member Functions
	_moveFileFromTmp ($baseTmpPath, $basePath, $file)
	_getFileTypeByExt ($ext)
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Protected Attributes
	$_coreFileStorageDatabase = null
	$_filesystem
	$_mediaDirectory
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Static Protected Attributes
static	$_mimeTypes

Detailed Description

Downloadable Products File Helper

@api

Since

100.0.2

Definition at line 16 of file File.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\MediaStorage\Helper\File\Storage\Database	$coreFileStorageDatabase,
		\Magento\Framework\Filesystem	$filesystem,
		array	$mimeTypes = []
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\MediaStorage\Helper\File\Storage\Database	$coreFileStorageDatabase
\Magento\Framework\Filesystem	$filesystem
array	$mimeTypes

Definition at line 45 of file File.php.

      {
        $this->_coreFileStorageDatabase = $coreFileStorageDatabase;
        $this->_filesystem = $filesystem;
        $this->_mediaDirectory = $filesystem->getDirectoryWrite(DirectoryList::MEDIA);
        parent::__construct($context);
        if (!empty($mimeTypes)) {
            foreach ($mimeTypes as $key => $value) {
                self::$_mimeTypes[$key] = $value;
            }
        }
    }

Member Function Documentation

_getFileTypeByExt()

_getFileTypeByExt (   $ext )

protected

Parameters

string

$ext

Returns

string

Definition at line 205 of file File.php.

    {
        $type = 'x' . $ext;
        if (isset(self::$_mimeTypes[$type])) {
            return self::$_mimeTypes[$type];
        }
        return 'application/octet-stream';
    }

_moveFileFromTmp()

_moveFileFromTmp (   $baseTmpPath,   $basePath,   $file  )

protected

Move file from tmp path to base path

Parameters

string	$baseTmpPath
string	$basePath
string	$file

Returns

string

Definition at line 128 of file File.php.

    {
        if (strrpos($file, '.tmp') == strlen($file) - 4) {
            $file = substr($file, 0, strlen($file) - 4);
        }

        $destFile = dirname(
            $file
        ) . '/' . \Magento\MediaStorage\Model\File\Uploader::getNewFileName(
            $this->getFilePath($basePath, $file)
        );

        $this->_coreFileStorageDatabase->copyFile(
            $this->getFilePath($baseTmpPath, $file),
            $this->getFilePath($basePath, $destFile)
        );

        $this->_mediaDirectory->renameFile(
            $this->getFilePath($baseTmpPath, $file),
            $this->getFilePath($basePath, $destFile)
        );

        return str_replace('\\', '/', $destFile);
    }

ensureFileInFilesystem()

ensureFileInFilesystem

(

$file

)

Check if file exist in filesystem and try to re-create it from database record if negative.

Parameters

string

$file

Returns

bool|int

Definition at line 110 of file File.php.

    {
        $result = true;
        if (!$this->_mediaDirectory->isFile($file)) {
            $result = $this->_coreFileStorageDatabase->saveFileToFilesystem($file);
        }

        return $result;
    }

getAllFileTypes()

getAllFileTypes

(

)

Returns

array

Definition at line 217 of file File.php.

    {
        return array_values(self::getAllMineTypes());
    }

getAllMineTypes()

getAllMineTypes

(

)

Returns

array

Definition at line 225 of file File.php.

    {
        return self::$_mimeTypes;
    }

getFileFromPathFile()

getFileFromPathFile

(

$pathFile

)

Return file name form file path

Parameters

string

$pathFile

Returns

string

Definition at line 174 of file File.php.

    {
        $file = substr($pathFile, strrpos($pathFile, '/') + 1);

        return $file;
    }

getFilePath()

getFilePath	(		$path,
			$file
	)

Return full path to file

Parameters

string	$path
string	$file

Returns

string

Definition at line 160 of file File.php.

    {
        $path = rtrim($path, '/');
        $file = ltrim($file, '/');

        return $path . '/' . $file;
    }

getFileSize()

getFileSize

(

$file

)

Get filesize in bytes.

Parameters

string

$file

Returns

int

Definition at line 186 of file File.php.

    {
        return $this->_mediaDirectory->stat($file)['size'];
    }

getFileType()

getFileType

(

$filePath

)

Parameters

string

$filePath

Returns

string

Definition at line 195 of file File.php.

    {
        $ext = substr($filePath, strrpos($filePath, '.') + 1);
        return $this->_getFileTypeByExt($ext);
    }

moveFileFromTmp()

moveFileFromTmp	(		$baseTmpPath,
			$basePath,
			$file
	)

Checking file for moving and move it

Parameters

string	$baseTmpPath
string	$basePath
string	$file

Returns

string

Exceptions

Definition at line 87 of file File.php.

    {
        if (isset($file[0])) {
            $fileName = $file[0]['file'];
            if ($file[0]['status'] === 'new') {
                try {
                    $fileName = $this->_moveFileFromTmp($baseTmpPath, $basePath, $file[0]['file']);
                } catch (\Exception $e) {
                    throw new \Magento\Framework\Exception\LocalizedException(
                        __('Something went wrong while saving the file(s).')
                    );
                }
            }
            return $fileName;
        }
        return '';
    }

uploadFromTmp()

uploadFromTmp	(		$tmpPath,
		\Magento\MediaStorage\Model\File\Uploader	$uploader
	)

Upload file from temporary folder.

Parameters

string	$tmpPath
\Magento\MediaStorage\Model\File\Uploader	$uploader

Returns

array

Definition at line 68 of file File.php.

    {
        $uploader->setAllowRenameFiles(true);
        $uploader->setFilesDispersion(true);
        $absoluteTmpPath = $this->_mediaDirectory->getAbsolutePath($tmpPath);
        $result = $uploader->save($absoluteTmpPath);
        unset($result['path']);

        return $result;
    }

Field Documentation

$_coreFileStorageDatabase

$_coreFileStorageDatabase = null

protected

Definition at line 23 of file File.php.

$_filesystem

$_filesystem

protected

Definition at line 30 of file File.php.

$_mediaDirectory

$_mediaDirectory

protected

Definition at line 37 of file File.php.

$_mimeTypes

$_mimeTypes

staticprotected

Definition at line 233 of file File.php.

---

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

• vendor/magento/module-downloadable/Helper/File.php