OXID eShop CE  6.4.2
OxidEsales\EshopCommunity\Application\Component\UtilsComponent Class Reference
+ Inheritance diagram for OxidEsales\EshopCommunity\Application\Component\UtilsComponent:
+ Collaboration diagram for OxidEsales\EshopCommunity\Application\Component\UtilsComponent:

Public Member Functions

 toCompareList ( $sProductId=null, $dAmount=null, $aSel=null, $blOverride=false, $blBundle=false)
 
 toNoticeList ($sProductId=null, $dAmount=null, $aSel=null)
 
 toWishList ($sProductId=null, $dAmount=null, $aSel=null)
 
 render ()
 

Protected Member Functions

 _toList ($sListType, $sProductId, $dAmount, $aSel)
 

Protected Attributes

 $_blIsComponent = true
 

Detailed Description

Transparent shop utilities class. Some specific utilities, such as fetching article info, etc. (Class may be used for overriding).

@subpackage oxcmp

Member Function Documentation

◆ _toList()

OxidEsales\EshopCommunity\Application\Component\UtilsComponent::_toList (   $sListType,
  $sProductId,
  $dAmount,
  $aSel 
)
protected

Adds chosen product to defined user list. if amount is 0, item is removed from the list

Parameters
string$sListTypeuser product list type
string$sProductIdproduct id
double$dAmountproduct amount
array$aSelproduct selection list
Deprecated:
underscore prefix violates PSR12, will be renamed to "toList" in next major

◆ render()

OxidEsales\EshopCommunity\Application\Component\UtilsComponent::render ( )

Set view data, call parent::render

Returns
null

◆ toCompareList()

OxidEsales\EshopCommunity\Application\Component\UtilsComponent::toCompareList (   $sProductId = null,
  $dAmount = null,
  $aSel = null,
  $blOverride = false,
  $blBundle = false 
)

Adds/removes chosen article to/from article comparison list

Parameters
object$sProductIdproduct id
double$dAmountamount
array$aSel(default null)
bool$blOverrideallow override
bool$blBundlebundled

◆ toNoticeList()

OxidEsales\EshopCommunity\Application\Component\UtilsComponent::toNoticeList (   $sProductId = null,
  $dAmount = null,
  $aSel = null 
)

If session user is set loads user noticelist (\OxidEsales\Eshop\Application\Model\User::GetBasket()) and adds article to it.

Parameters
string$sProductIdProduct/article ID (default null)
double$dAmountamount of good (default null)
array$aSelproduct selection list (default null)
Returns
bool

◆ toWishList()

OxidEsales\EshopCommunity\Application\Component\UtilsComponent::toWishList (   $sProductId = null,
  $dAmount = null,
  $aSel = null 
)

If session user is set loads user wishlist (\OxidEsales\Eshop\Application\Model\User::GetBasket()) and adds article to it.

Parameters
string$sProductIdProduct/article ID (default null)
double$dAmountamount of good (default null)
array$aSelproduct selection list (default null)
Returns
false

Member Data Documentation

◆ $_blIsComponent

OxidEsales\EshopCommunity\Application\Component\UtilsComponent::$_blIsComponent = true
protected

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