Public Member Functions | Protected Member Functions | Protected Attributes

oxOrderFile Class Reference

Inheritance diagram for oxOrderFile:
Collaboration diagram for oxOrderFile:

List of all members.

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.

Definition at line 7 of file oxorderfile.php.


Constructor & Destructor Documentation

oxOrderFile.__construct (  ) 

Initialises the instance

Returns:
null

Reimplemented from oxBase.

Definition at line 30 of file oxorderfile.php.


Member Function Documentation

oxOrderFile._getFieldLongName ( sFieldName  )  [protected]

returns long name

Parameters:
string $sFieldName - field name
Returns:
string

Reimplemented from oxBase.

Definition at line 127 of file oxorderfile.php.

oxOrderFile.getFileId (  ) 

Gets field id.

Returns:
mixed

Definition at line 240 of file oxorderfile.php.

oxOrderFile.getFileSize (  ) 

Returns downloadable file size in bytes.

Returns:
int

Definition at line 112 of file oxorderfile.php.

oxOrderFile.getLeftDownloadCount (  ) 

returns date ant time

Returns:
bool

Definition at line 193 of file oxorderfile.php.

oxOrderFile.getValidUntil (  ) 

returns date ant time

Returns:
bool

Definition at line 183 of file oxorderfile.php.

oxOrderFile.isPaid (  ) 

returns state payed or not the order

Returns:
bool

Definition at line 173 of file oxorderfile.php.

oxOrderFile.isValid (  ) 

Checks if order file is still available to download

Returns:
bool

Definition at line 150 of file oxorderfile.php.

oxOrderFile.processOrderFile (  ) 

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

Returns:
bool

Definition at line 208 of file oxorderfile.php.

oxOrderFile.reset (  ) 

reset order files downloadcount and / or expration times

Definition at line 39 of file oxorderfile.php.

oxOrderFile.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

Definition at line 94 of file oxorderfile.php.

oxOrderFile.setOrderArticleId ( sOrderArticleId  ) 

set order article id

Parameters:
string $sOrderArticleId - order article id

Definition at line 70 of file oxorderfile.php.

oxOrderFile.setOrderId ( sOrderId  ) 

set order id

Parameters:
string $sOrderId - order id

Definition at line 60 of file oxorderfile.php.

oxOrderFile.setShopId ( sShopId  ) 

set shop id

Parameters:
string $sShopId - shop id

Reimplemented from oxBase.

Definition at line 80 of file oxorderfile.php.


Member Data Documentation

oxOrderFile.$_sClassName = 'oxorderfile' [protected]

Reimplemented from oxBase.

Definition at line 22 of file oxorderfile.php.

oxOrderFile.$_sCoreTable = 'oxorderfiles' [protected]

Reimplemented from oxBase.

Definition at line 15 of file oxorderfile.php.


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