Download Class Reference

Public Member Functions
	__construct (\Magento\Framework\Filesystem $filesystem, \Magento\MediaStorage\Helper\File\Storage\Database $fileStorageDatabase, \Magento\MediaStorage\Model\File\Storage\DatabaseFactory $storageDatabaseFactory, \Magento\Framework\App\Response\Http\FileFactory $fileFactory, $rootDirBasePath=DirectoryList::MEDIA)
	downloadFile ($info)

Protected Member Functions
	_isCanProcessed ($relativePath)
	_processDatabaseFile ($filePath, $relativePath)

Protected Attributes
	$_rootDir
	$_fileStorageDatabase
	$_storageDatabaseFactory
	$_fileFactory
	$rootDirBasePath

Detailed Description

Class Download. Represents download logic for files

Definition at line 14 of file Download.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Filesystem	$filesystem,
		\Magento\MediaStorage\Helper\File\Storage\Database	$fileStorageDatabase,
		\Magento\MediaStorage\Model\File\Storage\DatabaseFactory	$storageDatabaseFactory,
		\Magento\Framework\App\Response\Http\FileFactory	$fileFactory,
			$rootDirBasePath = DirectoryList::MEDIA
	)

Constructor method

Parameters

\Magento\Framework\Filesystem	$filesystem
\Magento\MediaStorage\Helper\File\Storage\Database	$fileStorageDatabase
\Magento\MediaStorage\Model\File\Storage\DatabaseFactory	$storageDatabaseFactory
\Magento\Framework\App\Response\Http\FileFactory	$fileFactory
string	$rootDirBasePath

Definition at line 50 of file Download.php.

      {
        $this->rootDirBasePath = $rootDirBasePath;
        $this->_rootDir = $filesystem->getDirectoryWrite($this->rootDirBasePath);
        $this->_fileStorageDatabase = $fileStorageDatabase;
        $this->_storageDatabaseFactory = $storageDatabaseFactory;
        $this->_fileFactory = $fileFactory;
    }

Member Function Documentation

_isCanProcessed()

_isCanProcessed (   $relativePath )

protected

Method checks, if file can be returned depends on the given filepath

Parameters

string

$relativePath

Returns

bool

Definition at line 97 of file Download.php.

    {
        $filePath = $this->_rootDir->getAbsolutePath($relativePath);
        $pathWithFixedSeparator = str_replace('\\', '/', $this->_rootDir->getDriver()->getRealPath($filePath));
        return (strpos($pathWithFixedSeparator, $relativePath) !== false
            && $this->_rootDir->isFile($relativePath) && $this->_rootDir->isReadable($relativePath))
            || $this->_processDatabaseFile($filePath, $relativePath);
    }

_processDatabaseFile()

_processDatabaseFile (   $filePath,   $relativePath  )

protected

Check file in database storage if needed and place it on file system

Parameters

string	$filePath
string	$relativePath

Returns

bool

Definition at line 113 of file Download.php.

    {
        if (!$this->_fileStorageDatabase->checkDbUsage()) {
            return false;
        }
        $file = $this->_storageDatabaseFactory->create()->loadByFilename($relativePath);
        if (!$file->getId()) {
            return false;
        }
        $stream = $this->_rootDir->openFile($relativePath, 'w+');
        $stream->lock();
        $stream->write($filePath, $file->getContent());
        $stream->unlock();
        $stream->close();
        return true;
    }

downloadFile()

downloadFile

(

$info

)

Custom options downloader

Parameters

array

$info

Returns

void

Exceptions

Definition at line 71 of file Download.php.

    {
        $relativePath = $info['order_path'];
        if (!$this->_isCanProcessed($relativePath)) {
            //try get file from quote
            $relativePath = $info['quote_path'];
            if (!$this->_isCanProcessed($relativePath)) {
                throw new LocalizedException(
                    __('Path "%1" is not part of allowed directory "%2"', $relativePath, $this->rootDirBasePath)
                );
            }
        }
        $this->_fileFactory->create(
            $info['title'],
            ['value' => $this->_rootDir->getRelativePath($relativePath), 'type' => 'filename'],
            $this->rootDirBasePath,
            $info['type']
        );
    }

Field Documentation

$_fileFactory

$_fileFactory

protected

Definition at line 34 of file Download.php.

$_fileStorageDatabase

$_fileStorageDatabase

protected

Definition at line 24 of file Download.php.

$_rootDir

$_rootDir

protected

Definition at line 19 of file Download.php.

$_storageDatabaseFactory

$_storageDatabaseFactory

protected

Definition at line 29 of file Download.php.

$rootDirBasePath

$rootDirBasePath

protected

Definition at line 39 of file Download.php.

---

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

• vendor/magento/module-sales/Model/Download.php