OxidEsales\EshopCommunity\Application\Controller\AccountController Class Reference

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

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

Public Member Functions
	render ()
	confirmTerms ()
	getNavigationParams ()
	redirectAfterLogin ()
	getOrderCnt ()
	getArticleId ()
	getSearchParamForHtml ()
	getSearchParam ()
	getListType ()
	getBreadCrumb ()
	getCompareItemsCnt ()
	getTitle ()
	deleteAccount ()
	isUserAllowedToDeleteOwnAccount ()
	getAccountDeletionStatus ()

Protected Member Functions
	_getLoginTemplate ()

Protected Attributes
	$_iOrderCnt = null
	$_sArticleId = null
	$_sSearchParamForHtml = null
	$_sSearchParam = null
	$_sListType = null
	$_sThisTemplate = 'page/account/dashboard.tpl'
	$_sThisLoginTemplate = 'page/account/login.tpl'
	$_sThisAltLoginTemplate = 'page/privatesales/login.tpl'
	$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW
	$_sMetaDescriptionIdent = 'oxstartmetadescription'
	$_sMetaKeywordsIdent = 'oxstartmetakeywords'
	$_blBargainAction = true

Private Member Functions
	canUserAccountBeDeleted ()

Private Attributes
	$accountDeletionStatus

Detailed Description

Current user "My account" window. When user is logged in arranges "My account" window, by creating links to user details, order review, notice list, wish list. There is a link for logging out. Template includes Topoffer , bargain boxes. OXID eShop -> MY ACCOUNT.

Member Function Documentation

_getLoginTemplate()

OxidEsales\EshopCommunity\Application\Controller\AccountController::_getLoginTemplate ( )

protected

Returns login template name:

• if "login" feature is on returns $this->_sThisAltLoginTemplate
• else returns $this->_sThisLoginTemplate

Returns

string

canUserAccountBeDeleted()

OxidEsales\EshopCommunity\Application\Controller\AccountController::canUserAccountBeDeleted ( )

private

Checks if possible to delete user.

Returns

bool

confirmTerms()

OxidEsales\EshopCommunity\Application\Controller\AccountController::confirmTerms

(

)

Confirms term agreement. Returns value of confirmed term

Returns

string | bool

deleteAccount()

OxidEsales\EshopCommunity\Application\Controller\AccountController::deleteAccount

(

)

Deletes User account.

getAccountDeletionStatus()

OxidEsales\EshopCommunity\Application\Controller\AccountController::getAccountDeletionStatus

(

)

Template variable getter. Returns true, if a user account has been sucessfully deleted, else false.

Returns

bool

getArticleId()

OxidEsales\EshopCommunity\Application\Controller\AccountController::getArticleId

(

)

Return the active article id

Returns

string | bool

getBreadCrumb()

OxidEsales\EshopCommunity\Application\Controller\AccountController::getBreadCrumb

(

)

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

Returns

array

getCompareItemsCnt()

OxidEsales\EshopCommunity\Application\Controller\AccountController::getCompareItemsCnt

(

)

Template variable getter. Returns article list count in comparison

Returns

integer

getListType()

OxidEsales\EshopCommunity\Application\Controller\AccountController::getListType

(

)

Template variable getter. Returns list type

Returns

string

getNavigationParams()

OxidEsales\EshopCommunity\Application\Controller\AccountController::getNavigationParams

(

)

Returns array from parent::getNavigationParams(). If current request contains "sourcecl" and "anid" parameters - appends array with this data. Array is used to fill forms and append shop urls with actual state parameters

Returns

array

getOrderCnt()

OxidEsales\EshopCommunity\Application\Controller\AccountController::getOrderCnt

(

)

changes default template for compare in popup

Returns

null

getSearchParam()

OxidEsales\EshopCommunity\Application\Controller\AccountController::getSearchParam

(

)

Template variable getter. Returns search parameter

Returns

string

getSearchParamForHtml()

OxidEsales\EshopCommunity\Application\Controller\AccountController::getSearchParamForHtml

(

)

Template variable getter. Returns search parameter for Html

Returns

string

getTitle()

OxidEsales\EshopCommunity\Application\Controller\AccountController::getTitle

(

)

Page Title

Returns

string

isUserAllowedToDeleteOwnAccount()

OxidEsales\EshopCommunity\Application\Controller\AccountController::isUserAllowedToDeleteOwnAccount

(

)

Returns true if User is allowed to delete own account.

Returns

bool

redirectAfterLogin()

OxidEsales\EshopCommunity\Application\Controller\AccountController::redirectAfterLogin

(

)

For some user actions (like writing product review) user must be logged in. So e.g. in product details page there is a link leading to current view. Link contains parameter "sourcecl", which tells where to redirect after successfull login. If this parameter is defined and oxcmp_user::getLoginStatus() == USER_LOGIN_SUCCESS (means user has just logged in) then user is redirected back to source view.

Returns

null

render()

OxidEsales\EshopCommunity\Application\Controller\AccountController::render

(

)

Loads action articles. If user is logged and returns name of template to render account::_sThisTemplate

Returns

string $_sThisTemplate current template file name

Member Data Documentation

$_blBargainAction

OxidEsales\EshopCommunity\Application\Controller\AccountController::$_blBargainAction = true

protected

$_iOrderCnt

OxidEsales\EshopCommunity\Application\Controller\AccountController::$_iOrderCnt = null

protected

$_iViewIndexState

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

protected

$_sArticleId

OxidEsales\EshopCommunity\Application\Controller\AccountController::$_sArticleId = null

protected

$_sListType

OxidEsales\EshopCommunity\Application\Controller\AccountController::$_sListType = null

protected

$_sMetaDescriptionIdent

OxidEsales\EshopCommunity\Application\Controller\AccountController::$_sMetaDescriptionIdent = 'oxstartmetadescription'

protected

$_sMetaKeywordsIdent

OxidEsales\EshopCommunity\Application\Controller\AccountController::$_sMetaKeywordsIdent = 'oxstartmetakeywords'

protected

$_sSearchParam

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

protected

$_sSearchParamForHtml

OxidEsales\EshopCommunity\Application\Controller\AccountController::$_sSearchParamForHtml = null

protected

$_sThisAltLoginTemplate

OxidEsales\EshopCommunity\Application\Controller\AccountController::$_sThisAltLoginTemplate = 'page/privatesales/login.tpl'

protected

$_sThisLoginTemplate

OxidEsales\EshopCommunity\Application\Controller\AccountController::$_sThisLoginTemplate = 'page/account/login.tpl'

protected

$_sThisTemplate

OxidEsales\EshopCommunity\Application\Controller\AccountController::$_sThisTemplate = 'page/account/dashboard.tpl'

protected

$accountDeletionStatus

OxidEsales\EshopCommunity\Application\Controller\AccountController::$accountDeletionStatus

private

---

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

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