Public Member Functions | Protected Member Functions | Protected Attributes

oxVoucher Class Reference

Inheritance diagram for oxVoucher:
Collaboration diagram for oxVoucher:

List of all members.

Public Member Functions

 __construct ()
 getVoucherByNr ($sVoucherNr, $aVouchers=array(), $blCheckavalability=false)
 markAsUsed ($sOrderId, $sUserId, $dDiscount)
 markAsReserved ()
 unMarkAsReserved ()
 getDiscountValue ($dPrice)
 checkVoucherAvailability ($aVouchers, $dPrice)
 checkBasketVoucherAvailability ($aVouchers, $dPrice)
 checkUserAvailability ($oUser)
 getSimpleVoucher ()
 getSerie ()
 getDiscount ()
 getDiscountType ()
 __get ($sName)

Protected Member Functions

 _isAvailablePrice ($dPrice)
 _isAvailableWithSameSeries ($aVouchers)
 _isAvailableWithOtherSeries ($aVouchers)
 _isValidDate ()
 _isNotReserved ()
 _isAvailableInOtherOrder ($oUser)
 _isValidUserGroup ($oUser)
 _isProductVoucher ()
 _isCategoryVoucher ()
 _getSerieDiscount ()
 _getBasketItems ($oDiscount=null)
 _getOrderBasketItems ($oDiscount=null)
 _getSessionBasketItems ($oDiscount=null)
 _getGenericDiscoutValue ($dPrice)
 _getProductDiscoutValue ($dPrice)
 _getCategoryDiscoutValue ($dPrice)
 _getVoucherTimeout ()

Protected Attributes

 $_oSerie = null
 $_blDisableShopCheck = true
 $_sClassName = 'oxvoucher'

Detailed Description

Voucher manager. Performs deletion, generating, assigning to group and other voucher managing functions.

Definition at line 9 of file oxvoucher.php.

Constructor & Destructor Documentation

oxVoucher.__construct (  ) 

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

Reimplemented from oxBase.

Definition at line 29 of file oxvoucher.php.

Member Function Documentation

oxVoucher.__get ( $  sName  ) 

Extra getter to guarantee compatibility with templates

Parameters:
string $sName name of variable to get
Returns:
string

Reimplemented from oxBase.

Definition at line 769 of file oxvoucher.php.

oxVoucher._getBasketItems ( $  oDiscount = null  )  [protected]

Returns basket item information array from session or order.

Parameters:
oxDisvount $oDiscount discount object
Returns:
array

Definition at line 543 of file oxvoucher.php.

oxVoucher._getCategoryDiscoutValue ( $  dPrice  )  [protected]

Returns the discount value used, if voucher is aplied only for specific categories.

Parameters:
double $dPrice price to calculate discount on it
Exceptions:
oxVoucherException exception
Returns:
double

Definition at line 735 of file oxvoucher.php.

oxVoucher._getGenericDiscoutValue ( $  dPrice  )  [protected]

Returns the discount value used.

Parameters:
double $dPrice price to calculate discount on it
Exceptions:
oxVoucherException exception
Returns:
double

Definition at line 631 of file oxvoucher.php.

oxVoucher._getOrderBasketItems ( $  oDiscount = null  )  [protected]

Returns basket item information (id,amount,price) array takig item list from order.

Parameters:
oxDisvount $oDiscount discount object
Returns:
array

Definition at line 561 of file oxvoucher.php.

oxVoucher._getProductDiscoutValue ( $  dPrice  )  [protected]

Returns the discount value used, if voucher is aplied only for specific products.

Parameters:
double $dPrice price to calculate discount on it
Exceptions:
oxVoucherException exception
Returns:
double

Definition at line 681 of file oxvoucher.php.

oxVoucher._getSerieDiscount (  )  [protected]

Returns the discount object created from voucher serie data

Returns:
object

Definition at line 512 of file oxvoucher.php.

oxVoucher._getSessionBasketItems ( $  oDiscount = null  )  [protected]

Returns basket item information (id,amount,price) array takig item list from session.

Parameters:
oxDisvount $oDiscount discount object
Returns:
array

Definition at line 595 of file oxvoucher.php.

oxVoucher._getVoucherTimeout (  )  [protected]

Returns a configured value for voucher timeouts or a default of 3 hours if not configured

Returns:
integer Seconds a voucher can stay in status reserved

Definition at line 793 of file oxvoucher.php.

oxVoucher._isAvailableInOtherOrder ( $  oUser  )  [protected]

Checks if user already used vouchers from this series and can he use it again.

Parameters:
object $oUser user object
Exceptions:
oxVoucherException exception
Returns:
boolean

Definition at line 390 of file oxvoucher.php.

oxVoucher._isAvailablePrice ( $  dPrice  )  [protected]

Checks availability about price. Returns error array.

Parameters:
double $dPrice base article price
Exceptions:
oxVoucherException exception
Returns:
array

Definition at line 215 of file oxvoucher.php.

oxVoucher._isAvailableWithOtherSeries ( $  aVouchers  )  [protected]

Checks if cumulation with vouchers from the other series possible. Returns true on success.

Parameters:
array $aVouchers array of vouchers
Exceptions:
oxVoucherException exception
Returns:
bool

Definition at line 275 of file oxvoucher.php.

oxVoucher._isAvailableWithSameSeries ( $  aVouchers  )  [protected]

Checks if cumulation with vouchers of the same series possible. Returns true on success.

Parameters:
array $aVouchers array of vouchers
Exceptions:
oxVoucherException exception
Returns:
bool

Definition at line 240 of file oxvoucher.php.

oxVoucher._isCategoryVoucher (  )  [protected]

Returns true if voucher is category specific, otherwise false

Returns:
boolean

Definition at line 497 of file oxvoucher.php.

oxVoucher._isNotReserved (  )  [protected]

Checks if voucher is not yet reserved before.

Exceptions:
oxVoucherException exception
Returns:
bool

Definition at line 348 of file oxvoucher.php.

oxVoucher._isProductVoucher (  )  [protected]

Returns true if voucher is product specific, otherwise false

Returns:
boolean

Definition at line 482 of file oxvoucher.php.

oxVoucher._isValidDate (  )  [protected]

Checks if voucher is in valid time period. Returns true on success.

Exceptions:
oxVoucherException exception
Returns:
bool

Definition at line 312 of file oxvoucher.php.

oxVoucher._isValidUserGroup ( $  oUser  )  [protected]

Checks if user belongs to the same group as the voucher. Returns true on sucess.

Parameters:
object $oUser user object
Exceptions:
oxVoucherException exception
Returns:
bool

Definition at line 420 of file oxvoucher.php.

oxVoucher.checkBasketVoucherAvailability ( $  aVouchers,
$  dPrice 
)

Performs basket level voucher availability check (no need to check if voucher is reserved or so).

Parameters:
array $aVouchers array of vouchers
double $dPrice current sum (price)
Exceptions:
oxVoucherException exception
Returns:
array

Definition at line 195 of file oxvoucher.php.

oxVoucher.checkUserAvailability ( $  oUser  ) 

Checks availability for the given user. Returns array with errors.

Parameters:
object $oUser user object
Exceptions:
oxVoucherException exception
Returns:
array

Definition at line 371 of file oxvoucher.php.

oxVoucher.checkVoucherAvailability ( $  aVouchers,
$  dPrice 
)

Checks availability without user logged in. Returns array with errors.

Parameters:
array $aVouchers array of vouchers
double $dPrice current sum (price)
Exceptions:
oxVoucherException exception
Returns:
array

Definition at line 172 of file oxvoucher.php.

oxVoucher.getDiscount (  ) 

Return discount value

Returns:
double

Definition at line 654 of file oxvoucher.php.

oxVoucher.getDiscountType (  ) 

Return discount type

Returns:
string

Definition at line 665 of file oxvoucher.php.

oxVoucher.getDiscountValue ( $  dPrice  ) 

Returns the discount value used.

Parameters:
double $dPrice price to calculate discount on it
Exceptions:
oxVoucherException exception
Returns:
double

Definition at line 150 of file oxvoucher.php.

oxVoucher.getSerie (  ) 

create oxVoucherSerie object of this voucher

Returns:
oxVoucherSerie

Definition at line 464 of file oxvoucher.php.

oxVoucher.getSimpleVoucher (  ) 

Returns compact voucher object which is used in oxbasket

Returns:
stdClass

Definition at line 449 of file oxvoucher.php.

oxVoucher.getVoucherByNr ( $  sVoucherNr,
$  aVouchers = array(),
$  blCheckavalability = false 
)

Gets voucher from db by given number.

Parameters:
string $sVoucherNr Voucher number
array $aVouchers Array of available vouchers (default array())
bool $blCheckavalability check if voucher is still reserver od not
Exceptions:
oxVoucherException exception
Returns:
mixed

Definition at line 46 of file oxvoucher.php.

oxVoucher.markAsReserved (  ) 

mark voucher as reserved

Returns:
null

Definition at line 112 of file oxvoucher.php.

oxVoucher.markAsUsed ( $  sOrderId,
$  sUserId,
$  dDiscount 
)

marks voucher as used

Parameters:
string $sOrderId order id
string $sUserId user id
double $dDiscount used discount
Returns:
null

Definition at line 95 of file oxvoucher.php.

oxVoucher.unMarkAsReserved (  ) 

unmark as reserved

Returns:
null

Definition at line 129 of file oxvoucher.php.

Member Data Documentation

oxVoucher.$_blDisableShopCheck = true [protected]

Definition at line 19 of file oxvoucher.php.

oxVoucher.$_oSerie = null [protected]

Definition at line 12 of file oxvoucher.php.

oxVoucher.$_sClassName = 'oxvoucher' [protected]

Reimplemented from oxBase.

Definition at line 24 of file oxvoucher.php.

The documentation for this class was generated from the following file:
Generated by  doxygen 1.7.1