Inheritance diagram for oxcmp_user:

Collaboration diagram for oxcmp_user:

Public Member Functions
	init ()
	render ()
	login ()
	login_noredirect ()
	login_updateFbId ()
	logout ()
	changeUser ()
	changeuser_testvalues ()
	registerUser ()
	setLoginStatus ($iStatus)
	getLoginStatus ()
	getInvitor ()
	setRecipient ()
Protected Member Functions
	_checkPsState ()
	_loadSessionUser ()
	_afterLogin ($oUser)
	_afterLogout ()
	_saveInvitor ()
	_saveDeliveryAddressState ()
	_changeUser_noRedirect ()
	_getDelAddressData ()
	_getLogoutLink ()
Protected Attributes
	$_blIsNewUser = false
	$_blIsComponent = true
	$_blNewsSubscriptionStatus = null
	$_iLoginStatus = null
	$_sTermsVer = null
	$_aAllowedClasses

Detailed Description

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

oxcmp

Definition at line 14 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"). 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 216 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.

Definition at line 294 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 580 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;

Definition at line 109 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 654 of file oxcmp_user.php.

oxcmp_user._getLogoutLink ( ) [protected]

Returns logout link with additional params

Returns:: string $sLogoutLink

Definition at line 682 of file oxcmp_user.php.

oxcmp_user._loadSessionUser ( ) [protected]

Tries to load user ID from session.

Returns:: null

Definition at line 133 of file oxcmp_user.php.

oxcmp_user._saveDeliveryAddressState ( ) [protected]

Saving show/hide delivery address state

Definition at line 555 of file oxcmp_user.php.

oxcmp_user._saveInvitor ( ) [protected]

Saves invitor ID

Definition at line 544 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 349 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 366 of file oxcmp_user.php.

oxcmp_user.getInvitor ( )

Sets invitor id to session from URL

Definition at line 736 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 728 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

Reimplemented from oxView.

Definition at line 76 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 172 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.

Definition at line 246 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)

Definition at line 276 of file oxcmp_user.php.

oxcmp_user.logout ( )

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

Returns:: null

Definition at line 316 of file oxcmp_user.php.

oxcmp_user.registerUser ( )

Creates new oxid user

Returns:: string partial parameter string or null

Definition at line 526 of file oxcmp_user.php.

oxcmp_user.render ( )

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

Returns:: object user object

Reimplemented from oxView.

Definition at line 91 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)

Definition at line 715 of file oxcmp_user.php.

oxcmp_user.setRecipient ( )

sets from URL invitor id

Definition at line 748 of file oxcmp_user.php.

Member Data Documentation

oxcmp_user.$_aAllowedClasses [protected]

Initial value:

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

Definition at line 60 of file oxcmp_user.php.

oxcmp_user.$_blIsComponent = true [protected]

Reimplemented from oxView.

Definition at line 29 of file oxcmp_user.php.

oxcmp_user.$_blIsNewUser = false [protected]

Definition at line 22 of file oxcmp_user.php.

oxcmp_user.$_blNewsSubscriptionStatus = null [protected]

Definition at line 36 of file oxcmp_user.php.

oxcmp_user.$_iLoginStatus = null [protected]

Definition at line 46 of file oxcmp_user.php.

oxcmp_user.$_sTermsVer = null [protected]

Definition at line 53 of file oxcmp_user.php.

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

application/components/oxcmp_user.php

oxcmp_user Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation