oxVoucher Class Reference

Inheritance diagram for oxVoucher:
[legend]
Collaboration diagram for oxVoucher:
[legend]

List of all members.


Detailed Description

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

Definition at line 9 of file oxvoucher.php.


Public Member Functions

 __construct ()
 getVoucherByNr ($voucherNr, $aVouchers=array(), $blCheckavalability=false)
 markAsUsed ($sOrderId, $sUserId)
 markAsReserved ()
 unMarkAsReserved ()
 getDiscountValue ($dPrice)
 checkVoucherAvailability ($aVouchers, $dPrice)
 checkBasketVoucherAvailability ($aVouchers, $dPrice)
 checkUserAvailability ($oUser)
 getSimpleVoucher ()
 getSerie ()

Protected Member Functions

 _isAvailablePrice ($dPrice)
 _isAvailableWithSameSeries ($aVouchers)
 _isAvailableWithOtherSeries ($aVouchers)
 _isValidDate ()
 _isNotReserved ()
 _isAvailableInOtherOrder ($oUser)
 _isValidUserGroup ($oUser)

Protected Attributes

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

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.getVoucherByNr ( voucherNr,
aVouchers = array(),
blCheckavalability = false 
)

Gets voucher from db by given number.

Parameters:
string $voucherNr Voucher number
array $aVouchers Array of available vouchers (default array())
bool $blCheckavalability ()
Exceptions:
oxVoucherException exception
Returns:
mixed

Definition at line 46 of file oxvoucher.php.

oxVoucher.markAsUsed ( sOrderId,
sUserId 
)

marks voucher as used

Parameters:
string $sOrderId order id
string $sUserId user id
Returns:
null

Definition at line 86 of file oxvoucher.php.

oxVoucher.markAsReserved (  ) 

mark voucher as reserved

Returns:
null

Definition at line 102 of file oxvoucher.php.

oxVoucher.unMarkAsReserved (  ) 

unmark as reserved

Returns:
null

Definition at line 118 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 138 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 169 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 193 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 214 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 245 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 279 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 315 of file oxvoucher.php.

oxVoucher._isNotReserved (  )  [protected]

Checks if voucher is not yet reserved before.

Exceptions:
oxVoucherException exception
Returns:
bool

Definition at line 344 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 366 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 385 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 414 of file oxvoucher.php.

oxVoucher.getSimpleVoucher (  ) 

Returns compact voucher object which is used in oxbasket

Returns:
oxstdclass

Definition at line 443 of file oxvoucher.php.

oxVoucher.getSerie (  ) 

create oxVoucherSerie object of this voucher

Returns:
oxVoucherSerie

Definition at line 458 of file oxvoucher.php.


Member Data Documentation

oxVoucher.$_oSerie = null [protected]

Definition at line 12 of file oxvoucher.php.

oxVoucher.$_blDisableShopCheck = true [protected]

Definition at line 19 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 on Thu Dec 4 12:05:37 2008 for OXID eShop CE by  doxygen 1.5.5