Docs For Class Mage_Downloadable_Helper

Description

Downloadable Products Download Helper

author: Magento Core Team <[email protected]>

Located in /Downloadable/Helper/Download.php (line 34)

Mage_Core_Helper_Abstract
   |
   --Mage_Downloadable_Helper_Download

Class Constant Summary

LINK_TYPE_FILE = 'file'

LINK_TYPE_URL = 'url'

XML_PATH_CONTENT_DISPOSITION = 'catalog/downloadable/content_disposition'

Variable Summary

string $_contentType

string $_fileName

resource $_handle

string $_linkType

string $_resourceFile

array $_urlHeaders

Method Summary

bool getContentDisposition ([mixed $store = null])

void getContentType ()

void getFilename ()

void getFilesize ()

Mage_Core_Controller_Request_Http getHttpRequest ()

Mage_Core_Controller_Response_Http getHttpResponse ()

void output ()

Mage_Downloadable_Helper_Download setResource (string $resourceFile, [string $linkType = self::LINK_TYPE_FILE])

resource _getHandle ()

Variables

string $_contentType = 'application/octet-stream' (line 74)

MIME Content-type for a file

access: protected

string $_fileName = 'download' (line 81)

File name

access: protected

resource $_handle = null (line 60)

Resource open handle

access: protected

string $_linkType = self::LINK_TYPE_FILE (line 46)

Type of link

access: protected

string $_resourceFile = null (line 53)

Resource file

access: protected

array $_urlHeaders = array() (line 67)

Remote server headers

access: protected

Inherited Variables

Inherited from Mage_Core_Helper_Abstract

Mage_Core_Helper_Abstract::$_layout
Mage_Core_Helper_Abstract::$_moduleName
Mage_Core_Helper_Abstract::$_request

Methods

getContentDisposition (line 296)

Use Content-Disposition: attachment

access: public

bool getContentDisposition ([mixed $store = null])

mixed $store

getContentType (line 201)

access: public

void getContentType ()

getFilename (line 220)

access: public

void getFilename ()

getFilesize (line 187)

Retrieve file size in bytes

access: public

void getFilesize ()

getHttpRequest (line 260)

Retrieve Http Request Object

access: public

Mage_Core_Controller_Request_Http getHttpRequest ()

getHttpResponse (line 270)

Retrieve Http Response Object

access: public

Mage_Core_Controller_Response_Http getHttpResponse ()

output (line 275)

access: public

void output ()

setResource (line 247)

Set resource file for download

access: public

Mage_Downloadable_Helper_Download setResource (string $resourceFile, [string $linkType = self::LINK_TYPE_FILE])

string $resourceFile
string $linkType

_getHandle (line 88)

Retrieve Resource file handle (socket, file pointer etc)

access: protected

resource _getHandle ()

Inherited Methods

Inherited From Mage_Core_Helper_Abstract

Mage_Core_Helper_Abstract::escapeHtml()
Mage_Core_Helper_Abstract::escapeUrl()
Mage_Core_Helper_Abstract::getLayout()
Mage_Core_Helper_Abstract::htmlEscape()
Mage_Core_Helper_Abstract::isModuleEnabled()
Mage_Core_Helper_Abstract::isModuleOutputEnabled()
Mage_Core_Helper_Abstract::jsQuoteEscape()
Mage_Core_Helper_Abstract::setLayout()
Mage_Core_Helper_Abstract::stripTags()
Mage_Core_Helper_Abstract::translateArray()
Mage_Core_Helper_Abstract::urlDecode()
Mage_Core_Helper_Abstract::urlEncode()
Mage_Core_Helper_Abstract::urlEscape()
Mage_Core_Helper_Abstract::_cleanCache()
Mage_Core_Helper_Abstract::_getModuleName()
Mage_Core_Helper_Abstract::_getRequest()
Mage_Core_Helper_Abstract::_getUrl()
Mage_Core_Helper_Abstract::_loadCache()
Mage_Core_Helper_Abstract::_removeCache()
Mage_Core_Helper_Abstract::_saveCache()
Mage_Core_Helper_Abstract::__()

Class Constants

LINK_TYPE_FILE = 'file' (line 37)

LINK_TYPE_URL = 'url' (line 36)

XML_PATH_CONTENT_DISPOSITION = 'catalog/downloadable/content_disposition' (line 39)

Class Mage_Downloadable_Helper_Download

Inherited Variables

Inherited Methods