OXID eShop CE  4.9.7
 All Classes Files Functions Variables Pages
oxVoucherSerie Class Reference
+ Inheritance diagram for oxVoucherSerie:
+ Collaboration diagram for oxVoucherSerie:

Public Member Functions

 __construct ()
 delete ($sOxId=null)
 setUserGroups ()
 unsetUserGroups ()
 unsetDiscountRelations ()
 getVoucherList ()
 deleteVoucherList ()
 countVouchers ()
 getVoucherStatusByDatetime ($sNow=null)
- Public Member Functions inherited from oxBase
 getUseSkipSaveFields ()
 setUseSkipSaveFields ($blUseSkipSaveFields)
 __set ($sName, $sValue)
 __get ($sName)
 __isset ($mVar)
 __clone ()
 oxClone ($oObject)
 getUpdateSeo ()
 setUpdateSeo ($blUpdateSeo)
 init ($sTableName=null, $blForceAllFields=false)
 assign ($dbRecord)
 getClassName ()
 getCoreTableName ()
 getId ()
 setId ($sOXID=null)
 setShopId ($iShopId)
 getShopId ()
 getViewName ($blForceCoreTableUsage=null)
 modifyCacheKey ($sCacheKey, $blOverride=false)
 disableLazyLoading ()
 isDerived ()
 setIsDerived ($blVal)
 isMultilang ()
 load ($sOXID)
 isLoaded ()
 buildSelectString ($aWhere=null)
 assignRecord ($sSelect)
 getFieldData ($sFieldName)
 getSelectFields ($blForceCoreTableUsage=null)
 save ()
 allowDerivedUpdate ()
 allowDerivedDelete ()
 exists ($sOXID=null)
 getSqlActiveSnippet ($blForceCoreTable=null)
 beforeUpdate ($sOXID=null)
 onChange ($iAction=null, $sOXID=null)
 setInList ()
 isOx ()
 isReadOnly ()
 setReadOnly ($blReadOnly)
 getFieldNames ()
 addFieldName ($sName)
 getLanguage ()
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

Protected Attributes

 $_oGroups = null
 $_sClassName = 'oxvoucherserie'
- Protected Attributes inherited from oxBase
 $_sOXID = null
 $_iShopId = null
 $_blIsSimplyClonable = true
 $_sClassName = 'oxbase'
 $_sCoreTable = null
 $_sViewTable = null
 $_aFieldNames = array('oxid' => 0)
 $_sCacheKey = null
 $_blUseLazyLoading = false
 $_aSkipSaveFields = array('oxtimestamp')
 $_blUseSkipSaveFields = true
 $_sExistKey = 'oxid'
 $_blIsDerived = null
 $_blIsSeoObject = false
 $_blUpdateSeo = true
 $_blReadOnly = false
 $_blIsInList = false
 $_isLoaded = false
 $_aInnerLazyCache = null
 $_blEmployMultilanguage = false

Additional Inherited Members

- Protected Member Functions inherited from oxBase
 _setUpdateSeoOnFieldChange ($sField)
 _removeElement2ShopRelations ($sOxId)
 _isInList ()
 _getObjectViewName ($sTable, $sShopID=null)
 _getTableFields ($sTable, $blReturnSimple=false)
 _getAllFields ($blReturnSimple=false)
 _initDataStructure ($blForceFullStructure=false)
 _getNonCachedFieldNames ($blForceFullStructure=false)
 _getFieldStatus ($sFieldName)
 _addField ($sName, $iStatus, $sType=null, $sLength=null)
 _getFieldLongName ($sFieldName)
 _setFieldData ($sFieldName, $sValue, $iDataType=oxField::T_TEXT)
 _canFieldBeNull ($sFieldName)
 _getFieldDefaultValue ($sFieldName)
 _getUpdateFieldValue ($sFieldName, $oField)
 _getUpdateFields ($blUseSkipSaveFields=true)
 _update ()
 _insert ()
 _isDisabledFieldCache ()
 _addSkippedSaveFieldsForMapping ()
 _disableLazyLoadingForCaching ()
- Static Protected Attributes inherited from oxBase
static $_blDisableFieldCaching = array()

Detailed Description

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

Definition at line 8 of file oxvoucherserie.php.

Constructor & Destructor Documentation

oxVoucherSerie::__construct ( )

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

Reimplemented from oxBase.

Definition at line 26 of file oxvoucherserie.php.

Member Function Documentation

oxVoucherSerie::countVouchers ( )

Returns array of vouchers counts.


Definition at line 121 of file oxvoucherserie.php.

oxVoucherSerie::delete (   $sOxId = null)

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

string$sOxIdobject ID (default null)

Reimplemented from oxBase.

Definition at line 39 of file oxvoucherserie.php.

oxVoucherSerie::deleteVoucherList ( )

Deletes assigned voucher list.

Definition at line 109 of file oxvoucherserie.php.

oxVoucherSerie::getVoucherList ( )

Returns array of a vouchers assigned to this serie.


Definition at line 97 of file oxvoucherserie.php.

oxVoucherSerie::getVoucherStatusByDatetime (   $sNow = null)

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

string | null$sNowDate

Definition at line 144 of file oxvoucherserie.php.

oxVoucherSerie::setUserGroups ( )

Collects and returns user group list.


Definition at line 58 of file oxvoucherserie.php.

oxVoucherSerie::unsetDiscountRelations ( )

Removes product or dategory relations.

Definition at line 85 of file oxvoucherserie.php.

oxVoucherSerie::unsetUserGroups ( )

Removes user groups relations.

Definition at line 75 of file oxvoucherserie.php.

Member Data Documentation

oxVoucherSerie::$_oGroups = null

Definition at line 16 of file oxvoucherserie.php.

oxVoucherSerie::$_sClassName = 'oxvoucherserie'

Definition at line 21 of file oxvoucherserie.php.

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