oxcmp_user Class Reference

Inheritance diagram for oxcmp_user:

Inheritance graph
Collaboration diagram for oxcmp_user:

Collaboration graph

List of all members.

Detailed Description

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

Definition at line 8 of file oxcmp_user.php.

Public Member Functions

 init ()
 render ()
 login ()
 login_noredirect ()
 logout ()
 changeUser ()
 changeuser_testvalues ()
 createUser ()
 registerUser ()
 loginOid ()

Protected Member Functions

 _loadSessionUser ()
 _afterLogin ($oUser)
 _afterLogout ()
 _changeUser_noRedirect ()
 _getDelAddressData ()
 _getLogoutLink ()
 _setupDelAddress ()
 _getUserTitle ($sGender)
 _getReturnUrl ()

Protected Attributes

 $_blIsNewUser = false
 $_blIsComponent = true
 $_blNewsSubscriptionStatus = null

Member Function Documentation

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 37 of file oxcmp_user.php.

oxcmp_user.render (  ) 

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

Template variables: invadr, lgn_usr, deladr,

Session variables: dgr

object user object

Reimplemented from oxView.

Definition at line 57 of file oxcmp_user.php.

oxcmp_user._loadSessionUser (  )  [protected]

Tries to load user ID from session.


Definition at line 108 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

string redirection string

Definition at line 150 of file oxcmp_user.php.

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.

oxuser $oUser user object

Definition at line 203 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 235 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 248 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.


Definition at line 270 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:
mixed redirection string or true if user is registered, false otherwise

Definition at line 298 of file oxcmp_user.php.

oxcmp_user.changeuser_testvalues (  ) 

Executes oxcmp_user._changeuser_noredirect().


Definition at line 319 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

mixed redirection string or true if successful, false otherwise

Definition at line 345 of file oxcmp_user.php.

oxcmp_user.registerUser (  ) 

Creates new oxid user

string partial parameter string or null

Definition at line 432 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

bool true on success, false otherwise

Definition at line 467 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


Definition at line 525 of file oxcmp_user.php.

oxcmp_user._getLogoutLink (  )  [protected]

Returns logout link with additional params

string $sLogoutLink

Definition at line 549 of file oxcmp_user.php.

oxcmp_user._setupDelAddress (  )  [protected]

Checks if shipping address fields must be displayed and sets into session.

Template variables: blshowshipaddress


Definition at line 581 of file oxcmp_user.php.

oxcmp_user.loginOid (  ) 

Collects user information posted from openid server. If user do not exists creates new user and executes oxuser.openIdLogin().


Definition at line 615 of file oxcmp_user.php.

oxcmp_user._getUserTitle ( sGender  )  [protected]

Returns gender for database

string $sGender F(femail) or M(mail)

Definition at line 692 of file oxcmp_user.php.

oxcmp_user._getReturnUrl (  )  [protected]

Returns return url for openid.

string $sReturnUrl

Definition at line 706 of file oxcmp_user.php.

Member Data Documentation

oxcmp_user.$_blIsNewUser = false [protected]

Definition at line 14 of file oxcmp_user.php.

oxcmp_user.$_blIsComponent = true [protected]

Reimplemented from oxView.

Definition at line 20 of file oxcmp_user.php.

oxcmp_user.$_blNewsSubscriptionStatus = null [protected]

Definition at line 26 of file oxcmp_user.php.

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

Generated on Wed Apr 22 12:30:30 2009 for OXID eShop CE by  doxygen 1.5.5