Download Class Reference

Inheritance diagram for Download:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Downloadable\Helper\File $downloadableFile, \Magento\MediaStorage\Helper\File\Storage\Database $coreFileStorageDb, \Magento\Framework\Filesystem $filesystem, \Magento\Framework\Session\SessionManagerInterface $session, \Magento\Framework\Filesystem\File\ReadFactory $fileReadFactory)
	getFileSize ()
	getContentType ()
	getFilename ()
	setResource ($resourceFile, $linkType=self::LINK_TYPE_FILE)
	output ()
	getContentDisposition ($store=null)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	LINK_TYPE_URL = 'url'
const	LINK_TYPE_FILE = 'file'
const	XML_PATH_CONTENT_DISPOSITION = 'catalog/downloadable/content_disposition'

Protected Member Functions
	_getHandle ()
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Protected Attributes
	$_linkType = self::LINK_TYPE_FILE
	$_resourceFile = null
	$_handle = null
	$_urlHeaders = []
	$_contentType = 'application/octet-stream'
	$_fileName = 'download'
	$_coreFileStorageDb
	$_downloadableFile
	$_filesystem
	$fileReadFactory
	$_workingDirectory
	$_session
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Detailed Description

Downloadable Products Download Helper @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 17 of file Download.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Downloadable\Helper\File	$downloadableFile,
		\Magento\MediaStorage\Helper\File\Storage\Database	$coreFileStorageDb,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\Framework\Session\SessionManagerInterface	$session,
		\Magento\Framework\Filesystem\File\ReadFactory	$fileReadFactory
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
File	$downloadableFile
\Magento\MediaStorage\Helper\File\Storage\Database	$coreFileStorageDb
Filesystem	$filesystem
\Magento\Framework\Session\SessionManagerInterface	$session
Filesystem\File\ReadFactory	$fileReadFactory

Definition at line 119 of file Download.php.

      {
        parent::__construct($context);
        $this->_downloadableFile = $downloadableFile;
        $this->_coreFileStorageDb = $coreFileStorageDb;
        $this->_filesystem = $filesystem;
        $this->_session = $session;
        $this->fileReadFactory = $fileReadFactory;
    }

Member Function Documentation

_getHandle()

_getHandle ( )

protected

Retrieve Resource file handle (socket, file pointer etc)

Returns

\Magento\Framework\Filesystem\File\ReadInterface

Exceptions

CoreException|

Definition at line 141 of file Download.php.

    {
        if (!$this->_resourceFile) {
            throw new CoreException(__('Please set resource file and link type.'));
        }

        if ($this->_handle === null) {
            if ($this->_linkType == self::LINK_TYPE_URL) {
                $path = $this->_resourceFile;
                $protocol = strtolower(parse_url($path, PHP_URL_SCHEME));
                if ($protocol) {
                    // Strip down protocol from path
                    $path = preg_replace('#.+://#', '', $path);
                }
                $this->_handle = $this->fileReadFactory->create($path, $protocol);
            } elseif ($this->_linkType == self::LINK_TYPE_FILE) {
                $this->_workingDirectory = $this->_filesystem->getDirectoryRead(DirectoryList::MEDIA);
                $fileExists = $this->_downloadableFile->ensureFileInFilesystem($this->_resourceFile);
                if ($fileExists) {
                    $this->_handle = $this->_workingDirectory->openFile($this->_resourceFile);
                } else {
                    throw new CoreException(__('Invalid download link type.'));
                }
            } else {
                throw new CoreException(__('Invalid download link type.'));
            }
        }
        return $this->_handle;
    }

getContentDisposition()

getContentDisposition

(

$store = null

)

Use Content-Disposition: attachment

Parameters

mixed

$store

Returns

bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 283 of file Download.php.

    {
        return $this->scopeConfig->getValue(
            self::XML_PATH_CONTENT_DISPOSITION,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $store
        );
    }

getContentType()

getContentType

(

)

Return MIME type of a file.

Returns

string

Definition at line 186 of file Download.php.

    {
        $this->_getHandle();
        if ($this->_linkType == self::LINK_TYPE_FILE) {
            if (function_exists(
                'mime_content_type'
            ) && ($contentType = mime_content_type(
                $this->_workingDirectory->getAbsolutePath($this->_resourceFile)
            ))
            ) {
                return $contentType;
            } else {
                return $this->_downloadableFile->getFileType($this->_resourceFile);
            }
        } elseif ($this->_linkType == self::LINK_TYPE_URL) {
            return $this->_handle->stat($this->_resourceFile)['type'];
        }
        return $this->_contentType;
    }

getFilename()

getFilename

(

)

Return name of the file

Returns

string

Definition at line 211 of file Download.php.

    {
        $this->_getHandle();
        if ($this->_linkType == self::LINK_TYPE_FILE) {
            return pathinfo($this->_resourceFile, PATHINFO_BASENAME);
        } elseif ($this->_linkType == self::LINK_TYPE_URL) {
            $stat = $this->_handle->stat($this->_resourceFile);
            if (isset($stat['disposition'])) {
                $contentDisposition = explode('; ', $stat['disposition']);
                if (!empty($contentDisposition[1]) && preg_match(
                    '/filename=([^ ]+)/',
                    $contentDisposition[1],
                    $matches
                )
                ) {
                    return $matches[1];
                }
            }
            $fileName = @pathinfo($this->_resourceFile, PATHINFO_BASENAME);
            if ($fileName) {
                return $fileName;
            }
        }
        return $this->_fileName;
    }

getFileSize()

getFileSize

(

)

Retrieve file size in bytes

Returns

int

Definition at line 176 of file Download.php.

    {
        return $this->_getHandle()->stat($this->_resourceFile)['size'];
    }

output()

output

(

)

Output file contents

Returns

void

Definition at line 267 of file Download.php.

    {
        $handle = $this->_getHandle();
        $this->_session->writeClose();
        while (true == ($buffer = $handle->read(1024))) {
            echo $buffer; //@codingStandardsIgnoreLine
        }
    }

setResource()

setResource	(		$resourceFile,
			$linkType = self::LINK_TYPE_FILE
	)

Set resource file for download

Parameters

string	$resourceFile
string	$linkType

Returns

$this

Exceptions

Definition at line 245 of file Download.php.

    {
        if (self::LINK_TYPE_FILE == $linkType) {
            //check LFI protection
            if (preg_match('#\.\.[\\\/]#', $resourceFile)) {
                throw new \InvalidArgumentException(
                    'Requested file may not include parent directory traversal ("../", "..\\" notation)'
                );
            }
        }

        $this->_resourceFile = $resourceFile;
        $this->_linkType = $linkType;

        return $this;
    }

Field Documentation

$_contentType

$_contentType = 'application/octet-stream'

protected

Definition at line 67 of file Download.php.

$_coreFileStorageDb

$_coreFileStorageDb

protected

Definition at line 81 of file Download.php.

$_downloadableFile

$_downloadableFile

protected

Definition at line 88 of file Download.php.

$_fileName

$_fileName = 'download'

protected

Definition at line 74 of file Download.php.

$_filesystem

$_filesystem

protected

Definition at line 93 of file Download.php.

$_handle

$_handle = null

protected

Definition at line 53 of file Download.php.

$_linkType

$_linkType = self::LINK_TYPE_FILE

protected

Definition at line 39 of file Download.php.

$_resourceFile

$_resourceFile = null

protected

Definition at line 46 of file Download.php.

$_session

$_session

protected

Definition at line 109 of file Download.php.

$_urlHeaders

$_urlHeaders = []

protected

Definition at line 60 of file Download.php.

$_workingDirectory

$_workingDirectory

protected

Definition at line 104 of file Download.php.

$fileReadFactory

$fileReadFactory

protected

Definition at line 98 of file Download.php.

LINK_TYPE_FILE

const LINK_TYPE_FILE = 'file'

Link type file

Definition at line 27 of file Download.php.

LINK_TYPE_URL

const LINK_TYPE_URL = 'url'

Link type url

Definition at line 22 of file Download.php.

XML_PATH_CONTENT_DISPOSITION

const XML_PATH_CONTENT_DISPOSITION = 'catalog/downloadable/content_disposition'

Config path to content disposition

Definition at line 32 of file Download.php.

---

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

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