OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController:

Public Member Functions
	render ()
	showSuggest ()
	getWishList ()
	getWishProductList ()
	getSimilarRecommListIds ()
	sendWishList ()
	isWishListEmailSent ()
	setEnteredData ($oData)
	getEnteredData ()
	togglePublic ()
	searchForWishList ()
	getWishListUsers ()
	getWishListSearchParam ()
	getBreadCrumb ()

Protected Attributes
	$_sThisTemplate = 'page/account/wishlist.tpl'
	$_blShowSuggest = null
	$_oWishList = null
	$_aRecommList = null
	$_oEditval = null
	$_iSendWishList = null
	$_sSearchParam = null
	$_oWishListUsers = false
	$_blEmailSent = false
	$_aEditValues = false
	$_aSimilarRecommListIds = null
	$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW

Detailed Description

Current user wishlist manager. When user is logged in in this manager window he can modify his own wishlist status - remove articles from wishlist or store them to shopping basket, view detail information. Additionally user can view wishlist of some other user by entering users login name in special field. OXID eShop -> MY ACCOUNT -> Newsletter.

Member Function Documentation

getBreadCrumb()

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::getBreadCrumb

(

)

Returns Bread Crumb - you are here page1/page2/page3...

Returns

array

getEnteredData()

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::getEnteredData

(

)

Terurns user entered values for sending email.

Returns

array

getSimilarRecommListIds()

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::getSimilarRecommListIds

(

)

Return array of id to form recommend list.

Returns

array

getWishList()

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::getWishList

(

)

Show the Wishlist

Returns

\OxidEsales\Eshop\Application\Model\UserBasket | bool

getWishListSearchParam()

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::getWishListSearchParam

(

)

Returns wish list search parameter

Returns

string

getWishListUsers()

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::getWishListUsers

(

)

Returns a list of users which were found according to search condition. If no users were found - false is returned

Returns

\OxidEsales\Eshop\Core\Model\ListModel | bool

getWishProductList()

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::getWishProductList

(

)

Returns array of producst assigned to user wish list

Returns

array | bool

isWishListEmailSent()

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::isWishListEmailSent

(

)

If email was sent.

Returns

bool

render()

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::render

(

)

If user is logged in loads his wishlist articles (articles may be accessed by \OxidEsales\Eshop\Application\Model\User::GetBasket()), loads similar articles (is available) for the last article in list loaded by \OxidEsales\Eshop\Application\Model\Article::GetSimilarProducts() and returns name of template to render \OxidEsales\Eshop\Application\Controller\AccountWishlistController::_sThisTemplate

Returns

string $_sThisTemplate current template file name

searchForWishList()

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::searchForWishList

(

)

Searches for wishlist of another user. Returns false if no searching conditions set (no login name defined).

sendWishList()

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::sendWishList

(

)

Sends wishlist mail to recipient. On errors returns false.

Returns

bool

setEnteredData()

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::setEnteredData

(

$oData

)

Wishlist data setter

Parameters

object

$oData

suggest data object

showSuggest()

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::showSuggest

(

)

check if the wishlist is allowed

Returns

bool

togglePublic()

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::togglePublic

(

)

Changes wishlist status - public/non public. Returns false on error (if user is not logged in).

Returns

bool

Member Data Documentation

$_aEditValues

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::$_aEditValues = false

protected

$_aRecommList

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::$_aRecommList = null

protected

$_aSimilarRecommListIds

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::$_aSimilarRecommListIds = null

protected

$_blEmailSent

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::$_blEmailSent = false

protected

$_blShowSuggest

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::$_blShowSuggest = null

protected

$_iSendWishList

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::$_iSendWishList = null

protected

$_iViewIndexState

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW

protected

$_oEditval

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::$_oEditval = null

protected

$_oWishList

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::$_oWishList = null

protected

$_oWishListUsers

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::$_oWishListUsers = false

protected

$_sSearchParam

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::$_sSearchParam = null

protected

$_sThisTemplate

OxidEsales\EshopCommunity\Application\Controller\AccountWishlistController::$_sThisTemplate = 'page/account/wishlist.tpl'

protected

---

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

• /oxideshop-ce/source/Application/Controller/AccountWishlistController.php