OxidEsales\EshopCommunity\Application\Model\OrderFile Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Model\OrderFile:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Model\OrderFile:

Public Member Functions
	__construct ()
	reset ()
	setOrderId ($sOrderId)
	setOrderArticleId ($sOrderArticleId)
	setShopId ($sShopId)
	setFile ($sFileName, $sFileId, $iMaxDownloadCounts, $iExpirationTime, $iExpirationDownloadTime)
	getFileSize ()
	isValid ()
	isPaid ()
	getValidUntil ()
	getLeftDownloadCount ()
	processOrderFile ()
	getFileId ()

Protected Member Functions
	_getFieldLongName ($sFieldName)

Protected Attributes
	$_sCoreTable = 'oxorderfiles'
	$_sClassName = 'oxorderfile'

Detailed Description

Article file link manager.

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Application\Model\OrderFile::__construct

(

)

Initialises the instance

Returns

oxOrderFile

Member Function Documentation

_getFieldLongName()

OxidEsales\EshopCommunity\Application\Model\OrderFile::_getFieldLongName (   $sFieldName )

protected

returns long name

Parameters

string

$sFieldName

- field name

Returns

string

getFileId()

OxidEsales\EshopCommunity\Application\Model\OrderFile::getFileId

(

)

Gets field id.

Returns

mixed

getFileSize()

OxidEsales\EshopCommunity\Application\Model\OrderFile::getFileSize

(

)

Returns downloadable file size in bytes.

Returns

int

getLeftDownloadCount()

OxidEsales\EshopCommunity\Application\Model\OrderFile::getLeftDownloadCount

(

)

returns date ant time

Returns

bool

getValidUntil()

OxidEsales\EshopCommunity\Application\Model\OrderFile::getValidUntil

(

)

returns date ant time

Returns

bool

isPaid()

OxidEsales\EshopCommunity\Application\Model\OrderFile::isPaid

(

)

returns state payed or not the order

Returns

bool

isValid()

OxidEsales\EshopCommunity\Application\Model\OrderFile::isValid

(

)

Checks if order file is still available to download

Returns

bool

processOrderFile()

OxidEsales\EshopCommunity\Application\Model\OrderFile::processOrderFile

(

)

Checks if download link is valid, changes count, if first download changes valid until

Returns

bool

reset()

OxidEsales\EshopCommunity\Application\Model\OrderFile::reset

(

)

reset order files downloadcount and / or expration times

setFile()

OxidEsales\EshopCommunity\Application\Model\OrderFile::setFile	(		$sFileName,
			$sFileId,
			$iMaxDownloadCounts,
			$iExpirationTime,
			$iExpirationDownloadTime
	)

Set file and download options

Parameters

string	$sFileName	file name
string	$sFileId	file id
int	$iMaxDownloadCounts	max download count
int	$iExpirationTime	main download time after order in times
int	$iExpirationDownloadTime	download time after first download in hours

setOrderArticleId()

OxidEsales\EshopCommunity\Application\Model\OrderFile::setOrderArticleId

(

$sOrderArticleId

)

set order article id

Parameters

string

$sOrderArticleId

- order article id

setOrderId()

OxidEsales\EshopCommunity\Application\Model\OrderFile::setOrderId

(

$sOrderId

)

set order id

Parameters

string

$sOrderId

- order id

setShopId()

OxidEsales\EshopCommunity\Application\Model\OrderFile::setShopId

(

$sShopId

)

set shop id

Parameters

string

$sShopId

- shop id

Member Data Documentation

$_sClassName

OxidEsales\EshopCommunity\Application\Model\OrderFile::$_sClassName = 'oxorderfile'

protected

$_sCoreTable

OxidEsales\EshopCommunity\Application\Model\OrderFile::$_sCoreTable = 'oxorderfiles'

protected

---

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

• /oxideshop-ce/source/Application/Model/OrderFile.php