OXID eShop CE  6.1.5
OxidEsales\EshopCommunity\Application\Model\VoucherSerie Class Reference
+ Inheritance diagram for OxidEsales\EshopCommunity\Application\Model\VoucherSerie:
+ Collaboration diagram for OxidEsales\EshopCommunity\Application\Model\VoucherSerie:

Public Member Functions

 __construct ()
 
 delete ($sOxId=null)
 
 setUserGroups ()
 
 unsetUserGroups ()
 
 unsetDiscountRelations ()
 
 getVoucherList ()
 
 deleteVoucherList ()
 
 countVouchers ()
 
 getVoucherStatusByDatetime ($sNow=null)
 

Protected Attributes

 $_oGroups = null
 
 $_sClassName = 'oxvoucherserie'
 

Detailed Description

Voucher serie manager. Manages list of available Vouchers (fetches, deletes, etc.).

Constructor & Destructor Documentation

◆ __construct()

OxidEsales\EshopCommunity\Application\Model\VoucherSerie::__construct ( )

Class constructor, initiates parent constructor (parent::oxBase()).

Member Function Documentation

◆ countVouchers()

OxidEsales\EshopCommunity\Application\Model\VoucherSerie::countVouchers ( )

Returns array of vouchers counts.

Returns
array

◆ delete()

OxidEsales\EshopCommunity\Application\Model\VoucherSerie::delete (   $sOxId = null)

Override delete function so we can delete user group and article or category relations first.

Parameters
string$sOxIdobject ID (default null)
Returns
null

◆ deleteVoucherList()

OxidEsales\EshopCommunity\Application\Model\VoucherSerie::deleteVoucherList ( )

Deletes assigned voucher list.

◆ getVoucherList()

OxidEsales\EshopCommunity\Application\Model\VoucherSerie::getVoucherList ( )

Returns array of a vouchers assigned to this serie.

Returns
array

◆ getVoucherStatusByDatetime()

OxidEsales\EshopCommunity\Application\Model\VoucherSerie::getVoucherStatusByDatetime (   $sNow = null)

Get voucher status base on given date (if nothing was passed, current datetime will be used as a measure).

Parameters
string | null$sNowDate
Returns
int

◆ setUserGroups()

OxidEsales\EshopCommunity\Application\Model\VoucherSerie::setUserGroups ( )

Collects and returns user group list.

Returns
object

◆ unsetDiscountRelations()

OxidEsales\EshopCommunity\Application\Model\VoucherSerie::unsetDiscountRelations ( )

Removes product or dategory relations.

◆ unsetUserGroups()

OxidEsales\EshopCommunity\Application\Model\VoucherSerie::unsetUserGroups ( )

Removes user groups relations.

Member Data Documentation

◆ $_oGroups

OxidEsales\EshopCommunity\Application\Model\VoucherSerie::$_oGroups = null
protected

◆ $_sClassName

OxidEsales\EshopCommunity\Application\Model\VoucherSerie::$_sClassName = 'oxvoucherserie'
protected

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