Inheritance diagram for oxcmp_user:

Collaboration diagram for oxcmp_user:

Public Member Functions
	init ()
	render ()
	login ()
	login_noredirect ()
	login_updateFbId ()
	logout ()
	changeUser ()
	changeuser_testvalues ()
	createUser ()
	registerUser ()
	setLoginStatus ($iStatus)
	getLoginStatus ()
	getInvitor ()
	setRecipient ()
	_setOrderRemark ($oUser)
	_sendRegistrationEmail ($oUser)
Public Member Functions inherited from oxView
	setViewParameters ($aParams=null)
	getViewParameter ($sKey)
	setIsCallForCache ($blIsCallForCache=null)
	getIsCallForCache ()
	getViewId ()
	addGlobalParams ($oShop=null)
	addTplParam ($sPara, $sValue)
	getBelboonParam ()
	getViewConfig ()
	getTemplateName ()
	setTemplateName ($sTemplate)
	setClassName ($sClassName)
	getClassName ()
	setFncName ($sFncName)
	getFncName ()
	setViewData ($aViewData=null)
	getViewData ()
	getViewDataElement ($sParamId=null)
	setClassLocation ($sClassLocation=null)
	getClassLocation ()
	setThisAction ($sThisAction=null)
	getThisAction ()
	setParent ($oParent=null)
	getParent ()
	setIsComponent ($blIsComponent=null)
	getIsComponent ()
	executeFunction ($sFunction)
	getAdditionalParams ()
	getTrustedShopId ()
	getTSExcellenceId ()
	getCharSet ()
	getShopVersion ()
	getShopEdition ()
	getRevision ()
	getPackageInfo ()
	getShopFullEdition ()
	isDemoVersion ()
	isBetaVersion ()
	isRCVersion ()
	showBetaNote ()
	isDemoShop ()
	showNewsletter ()
	setShowNewsletter ($blShow)
	getShopLogo ()
	setShopLogo ($sLogo)
	getActCategory ()
	setActCategory ($oCategory)
	getCategoryId ()
	setCategoryId ($sCategoryId)
	getErrorDestination ()
	getActionClassName ()
	isConnectedWithFb ()
	getFbUserId ()
	showFbConnectToAccountMsg ()
	isMall ()
	showRdfa ()
	getSidForWidget ()
Public Member Functions inherited from oxSuperCfg
	__call ($sMethod, $aArgs)
	__construct ()
	getConfig ()
	setConfig ($oConfig)
	getSession ()
	setSession ($oSession)
	getUser ()
	setUser ($oUser)
	isAdmin ()
	setAdminMode ($blAdmin)

Protected Member Functions
	_setActiveLogin ($blActiveLogin)
	_getActiveLogin ()
	_checkPsState ()
	_loadSessionUser ()
	_afterLogin ($oUser)
	_afterLogout ()
	_changeUser_noRedirect ()
	_getDelAddressData ()
	_getLogoutLink ()
Protected Member Functions inherited from oxView
	_executeNewAction ($sNewAction)

Protected Attributes
	$_blIsNewUser = false
	$_blIsComponent = true
	$_blNewsSubscriptionStatus = null
	$_iLoginStatus = null
	$_sTermsVer = null
	$_aAllowedClasses
	$_blActiveLogin = false
Protected Attributes inherited from oxView
	$_aViewData = array()
	$_sClassLocation = null
	$_sThisAction = null
	$_oParent = null
	$_blIsComponent = false
	$_sThisTemplate = null
	$_sViewId = null
	$_sClass = null
	$_sFnc = null
	$_sTrustedShopId = null
	$_sTSExcellenceId = null
	$_sCharSet = null
	$_sVersion = null
	$_blDemoVersion = null
	$_blDemoShop = null
	$_iNewsStatus = null
	$_sShopLogo = null
	$_sCategoryId = null
	$_oClickCat = null
	$_blIsCallForCache = false
	$_oViewConf = null

Private Member Functions
	cleanBillingAddress ($aBillingAddress)
	cleanDeliveryAddress ($aDeliveryAddress)

Additional Inherited Members
Static Protected Attributes inherited from oxView
static	$_blExecuted = false

Detailed Description

User object manager. Sets user details data, switches, logouts, logins user etc. oxcmp

Definition at line 13 of file oxcmp_user.php.

Member Function Documentation

oxcmp_user::_afterLogin ( $oUser )

protected

Special functionality which is performed after user logs in (or user is created without pass). Performes additional checking if user is not BLOCKED (oxuser::InGroup("oxidblocked")) - if yes - redirects to blocked user page ("cl=content&tpl=user_blocked.tpl"). If user status is OK - sets user ID to session, automatically assigns him to dynamic group (oxuser::addDynGroup(); if this directive is set (usually by URL)). Stores cookie info if user confirmed in login screen. Then loads delivery info and forces basket to recalculate (oxsession::getBasket() + oBasket::blCalcNeeded = true). Returns "payment" to redirect to payment screen. If problems occured loading user - sets error code according problem, and returns "user" to redirect to user info screen.

Parameters

oxuser $oUser user object

Returns: string

Definition at line 261 of file oxcmp_user.php.

oxcmp_user::_afterLogout ( )

protected

Special utility function which is executed right after oxcmp_user::logout is called. Currently it unsets such session parameters as user chosen payment id, delivery address id, active delivery set.

Returns: null

Definition at line 347 of file oxcmp_user.php.

oxcmp_user::_changeUser_noRedirect ( )

protected

Mostly used for customer profile editing screen (OXID eShop -> MY ACCOUNT). Checks if oUser is set (oxcmp_user::oUser) - if not - executes oxcmp_user::_loadSessionUser(). If user unchecked newsletter subscription option - removes him from this group. There is an additional MUST FILL fields checking. Function returns true or false according to user data submission status.

Session variables: ordrem

Returns: bool true on success, false otherwise

Definition at line 589 of file oxcmp_user.php.

oxcmp_user::_checkPsState ( )

protected

If private sales enabled, checks: (1) if no session user and view can be accessed; (2) session user is available and accepted terms version matches actual version. In case any condition is not satisfied redirects user to: (1) login page; (2) terms agreement page;

Returns: null

Definition at line 156 of file oxcmp_user.php.

oxcmp_user::_getActiveLogin ( )

protected

Returns active login value

Returns: bool

Definition at line 86 of file oxcmp_user.php.

oxcmp_user::_getDelAddressData ( )

protected

Returns delivery address from request. Before returning array is checked if all needed data is there

Returns: array

Definition at line 691 of file oxcmp_user.php.

oxcmp_user::_getLogoutLink ( )

protected

Returns logout link with additional params

Returns: string $sLogoutLink

Definition at line 714 of file oxcmp_user.php.

oxcmp_user::_loadSessionUser ( )

protected

Tries to load user ID from session.

Returns: null

Definition at line 180 of file oxcmp_user.php.

oxcmp_user::_sendRegistrationEmail ( $oUser )

Sends registration email if option parameter is set to 3

Parameters

object $oUser user object

Returns: false

Definition at line 824 of file oxcmp_user.php.

oxcmp_user::_setActiveLogin ( $blActiveLogin )

protected

Sets active login value

Parameters

boolean $blActiveLogin active login value

Returns: null

Definition at line 76 of file oxcmp_user.php.

oxcmp_user::_setOrderRemark ( $oUser )

Sets order remark session variable if active login is true

Parameters

object $oUser user object

Returns: null

Definition at line 799 of file oxcmp_user.php.

oxcmp_user::changeUser ( )

Executes blUserRegistered = oxcmp_user::_changeUser_noRedirect(). if this returns true - returns "payment" (this redirects to payment page), else returns blUserRegistered value.

See Also: oxcmp_user::_changeUser_noRedirect()

Returns: mixed redirection string or true if user is registered, false otherwise

Definition at line 404 of file oxcmp_user.php.

oxcmp_user::changeuser_testvalues ( )

Executes oxcmp_user::_changeuser_noredirect(). returns "account_user" (this redirects to billing and shipping settings page) on success

Returns: null

Definition at line 421 of file oxcmp_user.php.

oxcmp_user::cleanBillingAddress ( $aBillingAddress )

private

Removes sensitive fields from billing address data.

Parameters

array $aBillingAddress

Returns: array

Definition at line 660 of file oxcmp_user.php.

oxcmp_user::cleanDeliveryAddress ( $aDeliveryAddress )

private

Removes sensitive fields from billing address data.

Parameters

array $aDeliveryAddress

Returns: array

Definition at line 676 of file oxcmp_user.php.

oxcmp_user::createUser ( )

First test if all MUST FILL fields were filled, then performed additional checking oxcmp_user::CheckValues(). If no errors occured - trying to create new user (oxuser::CreateUser()), logging him to shop (oxuser::Login() if user has entered password) or assigning him to dynamic group (oxuser::addDynGroup()). If oxuser::CreateUser() returns false - thsi means user is allready created - we only logging him to shop (oxcmp_user::Login()). If there is any error with missing data - function will return false and set error code (oxcmp_user::iError). If user was created successfully - will return "payment" to redirect to payment interface.

Template variables: usr_err

Session variables: usr_err, usr

Returns: mixed redirection string or true if successful, false otherwise

Definition at line 453 of file oxcmp_user.php.

oxcmp_user::getInvitor ( )

Gets from URL invitor id

Returns: null

Definition at line 771 of file oxcmp_user.php.

oxcmp_user::getLoginStatus ( )

Returns user login state marker:

USER_LOGIN_SUCCESS - user successfully logged in;
USER_LOGIN_FAIL - login failed;
USER_LOGOUT - user logged out.

Returns: int

Definition at line 761 of file oxcmp_user.php.

oxcmp_user::init ( )

Sets oxcmp_oxuser::blIsComponent = true, fetches user error code and sets it to default - 0. Executes parent::init().

Session variable: usr_err

Returns: null

Reimplemented from oxView.

Definition at line 100 of file oxcmp_user.php.

oxcmp_user::login ( )

Collects posted user information from posted variables ("lgn_usr", "lgn_pwd", "lgn_cook"), executes oxuser::login() and checks if such user exists.

Session variables: usr, usr_err

Template variables: usr_err

Returns: string redirection string

Definition at line 218 of file oxcmp_user.php.

oxcmp_user::login_noredirect ( )

Executes oxcmp_user::login() method. After loggin user will not be redirected to user or payment screens.

Returns: null

Definition at line 295 of file oxcmp_user.php.

oxcmp_user::login_updateFbId ( )

Executes oxcmp_user::login() and updates logged in user Facebook User ID (if user was connected using Facebook Connect)

Returns: null

Definition at line 327 of file oxcmp_user.php.

oxcmp_user::logout ( )

Deletes user information from session:
"usr", "dgr", "dynvalue", "paymentid"
also deletes cookie, unsets oxconfig::oUser, oxcmp_user::oUser, forces basket to recalculate.

Returns: null

Definition at line 371 of file oxcmp_user.php.

oxcmp_user::registerUser ( )

Creates new oxid user

Returns: string partial parameter string or null

Definition at line 561 of file oxcmp_user.php.

oxcmp_user::render ( )

Executes parent::render(), oxcmp_user::_loadSessionUser(), loads user delivery info. Returns user object oxcmp_user::oUser.

Session variables: dgr

Returns: object user object

Reimplemented from oxView.

Definition at line 136 of file oxcmp_user.php.

oxcmp_user::setLoginStatus ( $iStatus )

Sets user login state

Parameters

int $iStatus login state (USER_LOGIN_SUCCESS/USER_LOGIN_FAIL/USER_LOGOUT)

Returns: null

Definition at line 748 of file oxcmp_user.php.

oxcmp_user::setRecipient ( )

sets from URL invitor id

Returns: null

Definition at line 784 of file oxcmp_user.php.

Member Data Documentation

oxcmp_user::$_aAllowedClasses

protected

Initial value:

 array(
                                        'register',
                                        'forgotpwd',
                                        'content',
                                        'account',
                                        'clearcookies',
                                        'oxwServiceMenu',
                                        )

Definition at line 54 of file oxcmp_user.php.

oxcmp_user::$_blActiveLogin = false

protected

Definition at line 67 of file oxcmp_user.php.

oxcmp_user::$_blIsComponent = true

protected

Definition at line 25 of file oxcmp_user.php.

oxcmp_user::$_blIsNewUser = false

protected

Definition at line 19 of file oxcmp_user.php.

oxcmp_user::$_blNewsSubscriptionStatus = null

protected

Definition at line 31 of file oxcmp_user.php.

oxcmp_user::$_iLoginStatus = null

protected

Definition at line 40 of file oxcmp_user.php.

oxcmp_user::$_sTermsVer = null

protected

Definition at line 47 of file oxcmp_user.php.

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

application/components/oxcmp_user.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation