oxUser Class Reference

Inheritance diagram for oxUser:

Collaboration diagram for oxUser:

List of all members.

Public Member Functions
	__construct ()
	setMallUsersStatus ($blOn=false)
	__get ($sParamName)
	getNewsSubscription ()
	getUserCountry ($sCountryId=null, $iLang=null)
	getUserCountryId ($sCountry=null)
	getUserGroups ($sOXID=null)
	getUserAddresses ($sUserId=null)
	setSelectedAddressId ($sAddressId)
	getSelectedAddressId ()
	getSelectedAddress ($sWishId=false)
	getUserPayments ($sOXID=null)
	save ()
	allowDerivedUpdate ()
	inGroup ($sGroupID)
	delete ($sOXID=null)
	load ($oxID)
	exists ($sOXID=null)
	getOrders ($iLimit=false, $iPage=0)
	getOrderCount ()
	getNoticeListArtCnt ()
	getWishListArtCnt ()
	getActiveCountry ()
	createUser ()
	addToGroup ($sGroupID)
	removeFromGroup ($sGroupID=null)
	onOrderExecute ($oBasket, $iSuccess)
	getBasket ($sName)
	convertBirthday ($aData)
	getBoni ()
	addDynGroup ($sDynGoup, $aDeniedDynGroups)
	checkValues ($sLogin, $sPassword, $sPassword2, $aInvAddress, $aDelAddress)
	setNewsSubscription ($blSubscribe, $blSendOptIn, $blForceCheckOptIn=false)
	changeUserData ($sUser, $sPassword, $sPassword2, $aInvAddress, $aDelAddress)
	addUserAddress ($oUser)
	login ($sUser, $sPassword, $blCookie=false)
	logout ()
	loadAdminUser ()
	loadActiveUser ($blForceAdmin=false)
	checkIfEmailExists ($sEmail)
	getUserRecommLists ($sOXID=null)
	getRecommListsCount ($sOx=null)
	checkPassword ($sNewPass, $sConfPass, $blCheckLenght=false)
	loadUserByUpdateId ($sUid)
	setUpdateKey ($blReset=false)
	getUpdateLinkTerm ()
	isExpiredUpdateId ($sKey)
	getUpdateId ()
	encodePassword ($sPassword, $sSalt)
	prepareSalt ($sSalt)
	decodeSalt ($sSaltHex)
	setPassword ($sPassword=null)
	isSamePassword ($sNewPass)
	isLoadedFromCookie ()
	getPasswordHash ()
	getReviewUserHash ($sUserId)
	getReviewUserId ($sReviewUserHash)
	getState ()
	isTermsAccepted ()
	acceptTerms ()
	setCreditPointsForRegistrant ($sUserId, $sRecEmail)
	setCreditPointsForInviter ()
	updateFbId ()
	updateInvitationStatistics ($aRecEmail)
	getIdByUserName ($sUserName)
	hasAccount ()
Static Public Member Functions
static	getAdminUser ()
static	getActiveUser ($blForceAdmin=false)
Protected Member Functions
	_getWishListId ()
	_assignAddress ($aDelAddress)
	_getLoginQuery ($sUser, $sPassword, $sShopID, $blAdmin)
	_getShopSelect ($myConfig, $sShopID, $blAdmin)
	_loadSavedUserBasketAfterLogin ()
	_getFacebookUserId ()
	_getCookieUserId ($blAdmin=false)
	_ldapLogin ($sUser, $sPassword, $sShopID, $sShopSelect)
	_getUserRights ()
	_insert ()
	_update ()
	_checkLogin ($sLogin, $aInvAddress)
	_checkEmail ($sEmail)
	_checkPassword ($sNewPass, $sConfPass, $blCheckLenght=false)
	_checkCountries ($aInvAddress, $aDelAddress)
	_checkRequiredFields ($aInvAddress, $aDelAddress)
	_checkRequiredArrayFields ($sFieldName, $aFieldValues)
	_checkVatId ($aInvAddress)
	_setAutoGroups ($sCountryId)
	_hasUserAddress ($sUserId)
	_setUserCookie ($sUser, $sPassword, $sShopId=null, $iTimeout=31536000, $sSalt= 'ox')
	_deleteUserCookie ($sShopId=null)
Static Protected Member Functions
static	_getUserCookie ($sShopId=null)
Protected Attributes
	$_blDisableShopCheck = true
	$_oNewsSubscription = null
	$_sClassName = 'oxuser'
	$_aBaskets = array()
	$_oGroups
	$_aAddresses = array()
	$_oPayments
	$_oRecommList
	$_blMallUsers = false
	$_iCntNoticeListArticles = null
	$_iCntWishListArticles = null
	$_iCntRecommLists = null
	$_sUpdateKey = null
	$_blLoadedFromCookie = null
	$_sSelAddressId = null
	$_oSelAddress = null
	$_sWishId = null
	$_oUserCountryTitle = null
Static Protected Attributes
static	$_aUserCookie = array()

---

Detailed Description

User manager. Performs user managing function, as assigning to groups, updating information, deletion and other.

Definition at line 8 of file oxuser.php.

---

Constructor & Destructor Documentation

oxUser.__construct

(

)

Class constructor, initiates parent constructor (parent.oxBase()).

Returns:

null

Reimplemented from oxBase.

Definition at line 145 of file oxuser.php.

---

Member Function Documentation

oxUser.__get

(

$

sParamName

)

Getter for special not frequently used fields

Parameters:

string

$sParamName name of parameter to get value

Returns:

mixed

Reimplemented from oxBase.

Definition at line 172 of file oxuser.php.

oxUser._assignAddress

(

$

aDelAddress

)

[protected]

creates new address entry or updates existing

Parameters:

array

$aDelAddress address data array

Returns:

null

Definition at line 1208 of file oxuser.php.

oxUser._checkCountries	(	$	aInvAddress,
		$	aDelAddress
	)			[protected]

Checks if user defined countries (billing and delivery) are active

Parameters:

	array	$aInvAddress billing address info
	array	$aDelAddress delivery address info

use oxInputValidator.checkCountries() instead

Returns:

null

Definition at line 1876 of file oxuser.php.

oxUser._checkEmail

(

$

sEmail

)

[protected]

Checks if email (used as login) is not empty and is valid. On any error exception is thrown.

Parameters:

string

$sEmail user email/login

use oxInputValidator.checkEmail() instead

Returns:

null

Definition at line 1825 of file oxuser.php.

oxUser._checkLogin	(	$	sLogin,
		$	aInvAddress
	)			[protected]

Checks if user name does not break logics:

• if user wants to UPDATE his login name, performing check if user entered correct password
• additionally checking for user name dublicates. This is usually needed when creating new users. On any error exception is thrown.

Parameters:

	string	$sLogin user preferred login name
	array	$aInvAddress user information

use oxInputValidator.checkLogin() instead

Returns:

string login name

Definition at line 1702 of file oxuser.php.

oxUser._checkPassword	(	$	sNewPass,
		$	sConfPass,
		$	blCheckLenght = false
	)			[protected]

Checking if user password is fine. In case of error exception is thrown

Parameters:

	string	$sNewPass new user password
	string	$sConfPass retyped user password
	bool	$blCheckLenght option to check password lenght

Exceptions:

oxUserException,oxInputException

Deprecated:

use public oxuser.checkPassword() instead

Returns:

mixed

Definition at line 1844 of file oxuser.php.

oxUser._checkRequiredArrayFields	(	$	sFieldName,
		$	aFieldValues
	)			[protected]

Checks if all values are filled up

Parameters:

	string	$sFieldName checking field name
	array	$aFieldValues field values

use oxInputValidator.checkRequiredArrayFields() instead

Returns:

null

Definition at line 1907 of file oxuser.php.

oxUser._checkRequiredFields	(	$	aInvAddress,
		$	aDelAddress
	)			[protected]

Checking if all required fields were filled. In case of error exception is thrown

Parameters:

	array	$aInvAddress billing address
	array	$aDelAddress delivery address

use oxInputValidator.checkRequiredFields() instead

Returns:

null

Definition at line 1892 of file oxuser.php.

oxUser._checkVatId

(

$

aInvAddress

)

[protected]

Checks if user passed VAT id is valid. Exception is thrown if id is not valid

Parameters:

array

$aInvAddress user input array

use oxInputValidator.checkVatId() instead

Returns:

null

Definition at line 1922 of file oxuser.php.

oxUser._deleteUserCookie

(

$

sShopId = null

)

[protected]

Deletes user cookie data

Parameters:

string

$sShopId shop ID (default null)

Deprecated:

should be used oxUtilsServer.deleteUserCookie()

Returns:

null

Definition at line 2025 of file oxuser.php.

oxUser._getCookieUserId

(

$

blAdmin = false

)

[protected]

Checks if user is connected via cookies and if so, returns user id.

Parameters:

bool

$blAdmin (default false)

Returns:

string

Definition at line 1500 of file oxuser.php.

oxUser._getFacebookUserId

(

)

[protected]

Checks if user is connected via Facebook connect and if so, returns user id.

Returns:

string

Definition at line 1477 of file oxuser.php.

oxUser._getLoginQuery	(	$	sUser,
		$	sPassword,
		$	sShopID,
		$	blAdmin
	)			[protected]

Builds and returns user login query

Parameters:

	string	$sUser login name
	string	$sPassword login password
	string	$sShopID shopid
	bool	$blAdmin admin/non admin mode

Returns:

string

Definition at line 1241 of file oxuser.php.

oxUser._getShopSelect	(	$	myConfig,
		$	sShopID,
		$	blAdmin
	)			[protected]

Returns shopselect part of login query sql

Parameters:

	object	$myConfig shop config
	string	$sShopID shopid
	bool	$blAdmin admin/non admin mode

Returns:

string

Definition at line 1281 of file oxuser.php.

static oxUser._getUserCookie

(

$

sShopId = null

)

[static, protected]

Returns cookie stored used login data

Parameters:

string

$sShopId shop ID (default null)

Deprecated:

should be used oxUtilsServer.getUserCookie()

Returns:

string

Definition at line 2039 of file oxuser.php.

oxUser._getUserRights

(

)

[protected]

Returns user rights index. Index cannot be higher than current session user rights index.

Returns:

string

Definition at line 1603 of file oxuser.php.

oxUser._getWishListId

(

)

[protected]

Checks if product from wishlist is added

Returns:

$sWishId

Definition at line 370 of file oxuser.php.

oxUser._hasUserAddress

(

$

sUserId

)

[protected]

Checks if user allready has user address

Parameters:

object

$sUserId user to check Id

Deprecated:

in 4.5.1 since 2011-05-06 related with bug #0002072

Returns:

bool

Definition at line 1984 of file oxuser.php.

oxUser._insert

(

)

[protected]

Inserts user object data to DB. Returns true on success.

Returns:

bool

Reimplemented from oxBase.

Definition at line 1647 of file oxuser.php.

oxUser._ldapLogin	(	$	sUser,
		$	sPassword,
		$	sShopID,
		$	sShopSelect
	)			[protected]

Login for Ldap

Parameters:

	string	$sUser User username
	string	$sPassword User password
	string	$sShopID Shop id
	string	$sShopSelect Shop select

Exceptions:

$oEx

if user is wrong

Returns:

null

Definition at line 1544 of file oxuser.php.

oxUser._loadSavedUserBasketAfterLogin

(

)

[protected]

Load saved user basket from the database after he logs in

Deprecated:

move this functionality in MAJOR version to function which calls login method (e.g. component or so)

Returns:

null

Definition at line 1298 of file oxuser.php.

oxUser._setAutoGroups

(

$

sCountryId

)

[protected]

Automatically assigns user to specific groups according to users country information

Parameters:

string

$sCountryId users country id

Returns:

null

Definition at line 1935 of file oxuser.php.

oxUser._setUserCookie	(	$	sUser,
		$	sPassword,
		$	sShopId = null,
		$	iTimeout = 31536000,
		$	sSalt = 'ox'
	)			[protected]

Sets user info into cookie

Parameters:

	string	$sUser user ID
	string	$sPassword password
	string	$sShopId shop ID (default null)
	integer	$iTimeout timeout value (default 31536000)
	string	$sSalt encryption salt

Deprecated:

should be used oxUtilsServer.setUserCookie()

Returns:

null

Definition at line 2011 of file oxuser.php.

oxUser._update

(

)

[protected]

Updates changed user object data to DB. Returns true on success.

Returns:

bool

Reimplemented from oxBase.

Definition at line 1665 of file oxuser.php.

oxUser.acceptTerms

(

)

Writes terms acceptance info to db

Returns:

null

Definition at line 2312 of file oxuser.php.

oxUser.addDynGroup	(	$	sDynGoup,
		$	aDeniedDynGroups
	)

If there is a directove to add user to dynamic group (usually by URL - "dgr=any_group") - tries to add user to it. First checks if passed dynamic group is not in denied group list (defined ar oxConfig.aDeniedDynGroups) and if not - adds user to this group.

Parameters:

	string	$sDynGoup deny group (oxSession.getVar( 'dgr' ))
	array	$aDeniedDynGroups ($myConfig->getConfigParam( 'aDeniedDynGroups' ))

Returns:

bool

Definition at line 1002 of file oxuser.php.

oxUser.addToGroup

(

$

sGroupID

)

Adds user to the group

Parameters:

string

$sGroupID group id

Returns:

bool

Definition at line 821 of file oxuser.php.

oxUser.addUserAddress

(

$

oUser

)

Adds new address info to user copied from passed user. Returns new address ID

Parameters:

object

$oUser user object to copy address info

Deprecated:

in 4.5.1 since 2011-05-06 related with bug #0002072

Returns:

mixed

Definition at line 1174 of file oxuser.php.

oxUser.allowDerivedUpdate

(

)

Overrides parent isDerived check and returns true

Returns:

bool

Reimplemented from oxBase.

Definition at line 512 of file oxuser.php.

oxUser.changeUserData	(	$	sUser,
		$	sPassword,
		$	sPassword2,
		$	aInvAddress,
		$	aDelAddress
	)

When changing/updating user information in frontend this method validates user input. If data is fine - automatically assigns this values. Additionally calls methods (oxuser._setAutoGroups, oxuser.setNewsSubscription) to perform automatic groups assignment and returns newsletter subscription status. If some action fails - exception is thrown.

Parameters:

	string	$sUser user login name
	string	$sPassword user password
	string	$sPassword2 user confirmation password
	array	$aInvAddress user billing address
	array	$aDelAddress delivery address

Exceptions:

oxUserException,oxInputException,oxConnectionException

Returns:

bool

Definition at line 1143 of file oxuser.php.

oxUser.checkIfEmailExists

(

$

sEmail

)

Checks for already used email

Parameters:

string

$sEmail user email/login

Returns:

null

Definition at line 1716 of file oxuser.php.

oxUser.checkPassword	(	$	sNewPass,
		$	sConfPass,
		$	blCheckLenght = false
	)

Checking if user password is fine. In case of error exception is thrown

Parameters:

	string	$sNewPass new user password
	string	$sConfPass retyped user password
	bool	$blCheckLenght option to check password lenght

use oxInputValidator.checkPassword() instead

Returns:

mixed

Definition at line 1861 of file oxuser.php.

oxUser.checkValues	(	$	sLogin,
		$	sPassword,
		$	sPassword2,
		$	aInvAddress,
		$	aDelAddress
	)

Performs bunch of checks if user profile data is correct; on any error exception is thrown

Parameters:

	string	$sLogin user login name
	string	$sPassword user password
	string	$sPassword2 user password to compare
	array	$aInvAddress array of user profile data
	array	$aDelAddress array of user profile data

Exceptions:

oxUserException,oxInputException

Returns:

null

Definition at line 1047 of file oxuser.php.

oxUser.convertBirthday

(

$

aData

)

User birthday converter. Usually this data comes in array form, so before writing into DB it must be converted into string

Parameters:

array

$aData dirthday data

Returns:

string

Definition at line 935 of file oxuser.php.

oxUser.createUser

(

)

Inserts new or updates existing user

Exceptions:

oxUserException

exception

Returns:

bool

Definition at line 773 of file oxuser.php.

oxUser.decodeSalt

(

$

sSaltHex

)

Returns plains password salt representation

Parameters:

string

$sSaltHex heximal representation of password salt value

Returns:

string

Definition at line 2155 of file oxuser.php.

oxUser.delete

(

$

sOXID = null

)

Removes user data stored in some DB tables (such as oxuserpayments, oxaddress oxobject2group, oxremark, etc). Return true on success.

Parameters:

string

$sOXID object ID (default null)

Returns:

bool

Reimplemented from oxBase.

Definition at line 542 of file oxuser.php.

oxUser.encodePassword	(	$	sPassword,
		$	sSalt
	)

Encodes and returns given password

Parameters:

	string	$sPassword password to encode
	string	$sSalt any unique string value

Returns:

string

Definition at line 2130 of file oxuser.php.

oxUser.exists

(

$

sOXID = null

)

Checks if user exists in database.

Parameters:

string

$sOXID object ID (default null)

Returns:

bool

Reimplemented from oxBase.

Definition at line 616 of file oxuser.php.

oxUser.getActiveCountry

(

)

Returns user country ID, but If delivery address is given - returns delivery country.

Returns:

string

Definition at line 746 of file oxuser.php.

static oxUser.getActiveUser

(

$

blForceAdmin = false

)

[static]

Loads active user object. If user is not available - returns false.

Parameters:

bool

$blForceAdmin (default false)

Deprecated:

use non static method loadActiveUser

Returns:

bool

Definition at line 2246 of file oxuser.php.

static oxUser.getAdminUser

(

)

[static]

Loads active admin user object (if possible). If user is not available - returns false.

Deprecated:

use non static method loadAdminUser

Returns:

bool

Definition at line 2231 of file oxuser.php.

oxUser.getBasket

(

$

sName

)

Returns notice, wishlist or saved basket object

Parameters:

string

$sName name/type of basket

Returns:

oxuserbasket

Definition at line 906 of file oxuser.php.

oxUser.getBoni

(

)

No logic set, only returns "1000". You should extend this function according your needs.

Returns:

integer

Definition at line 985 of file oxuser.php.

oxUser.getIdByUserName

(

$

sUserName

)

retruns user id by user name

Parameters:

string

$sUserName user name

Returns:

string

Definition at line 2421 of file oxuser.php.

oxUser.getNewsSubscription

(

)

Returns user newsletter subscription controller object

Returns:

object oxnewssubscribed

Definition at line 211 of file oxuser.php.

oxUser.getNoticeListArtCnt

(

)

Returns amount of articles in noticelist

Returns:

int

Definition at line 713 of file oxuser.php.

oxUser.getOrderCount

(

)

Caclulates amount of orders made by user

Returns:

int

Definition at line 696 of file oxuser.php.

oxUser.getOrders	(	$	iLimit = false,
		$	iPage = 0
	)

Returns object with ordering information (order articles list).

Parameters:

	int	$iLimit how many entries to load
	int	$iPage which page to start

Returns:

object

Definition at line 661 of file oxuser.php.

oxUser.getPasswordHash

(

)

Returns password hash. In case password in db is plain or decodable password is processed and hash returned

Returns:

string

Definition at line 2207 of file oxuser.php.

oxUser.getRecommListsCount

(

$

sOx = null

)

Returns recommlist count

Parameters:

string

$sOx object ID (default is null)

Returns:

int

Definition at line 1799 of file oxuser.php.

oxUser.getReviewUserHash

(

$

sUserId

)

Generates user password and username hash for review

Parameters:

string

$sUserId userid

Returns:

string

Definition at line 2263 of file oxuser.php.

oxUser.getReviewUserId

(

$

sReviewUserHash

)

Gets from review user hash user id

Parameters:

string

$sReviewUserHash review user hash

Returns:

string

Definition at line 2277 of file oxuser.php.

oxUser.getSelectedAddress

(

$

sWishId = false

)

Sets in the array oxuser._aAddresses selected address. Returns user selected Address id.

Parameters:

bool

$sWishId wishlist user id

Returns:

object $oSelectedAddress

Definition at line 392 of file oxuser.php.

oxUser.getSelectedAddressId

(

)

Returns user chosen address id ("oxaddressid" or "deladrid")

Returns:

string

Definition at line 352 of file oxuser.php.

oxUser.getState

(

)

Returns string representation of user state

Returns:

string

Definition at line 2289 of file oxuser.php.

oxUser.getUpdateId

(

)

Returns user passwords update id

Returns:

string

Definition at line 2113 of file oxuser.php.

oxUser.getUpdateLinkTerm

(

)

Return password update link validity term (seconds). Default 3600 * 6

Returns:

int

Definition at line 2089 of file oxuser.php.

oxUser.getUserAddresses

(

$

sUserId = null

)

Returns user defined Address list object

Parameters:

string

$sUserId object ID (default is null)

Returns:

object

Definition at line 311 of file oxuser.php.

oxUser.getUserCountry	(	$	sCountryId = null,
		$	iLang = null
	)

Returns user country (object) according to passed parameters or they are taken from user object ( oxid, country id) and session (language)

Parameters:

	string	$sCountryId country id (optional)
	int	$iLang active language (optional)

Returns:

string

Definition at line 244 of file oxuser.php.

oxUser.getUserCountryId

(

$

sCountry = null

)

Returns user countryid according to passed name

Parameters:

string

$sCountry country

Returns:

string

Definition at line 269 of file oxuser.php.

oxUser.getUserGroups

(

$

sOXID = null

)

Returns assigned user groups list object

Parameters:

string

$sOXID object ID (default is null)

Returns:

object

Definition at line 285 of file oxuser.php.

oxUser.getUserPayments

(

$

sOXID = null

)

Returns user payment history list object

Parameters:

string

$sOXID object ID (default is null)

Returns:

object oxlist with oxuserpayments objects

Definition at line 437 of file oxuser.php.

oxUser.getUserRecommLists

(

$

sOXID = null

)

Returns user recommendation list object

Parameters:

string

$sOXID object ID (default is null)

Returns:

object oxlist with oxrecommlist objects

Definition at line 1768 of file oxuser.php.

oxUser.getWishListArtCnt

(

)

Calculating user wishlist item count

Returns:

int

Definition at line 729 of file oxuser.php.

oxUser.hasAccount

(

)

returns true if user registered and have account

Returns:

bool

Definition at line 2438 of file oxuser.php.

oxUser.inGroup

(

$

sGroupID

)

Checks if this object is in group, returns true on success.

Parameters:

string

$sGroupID user group ID

Returns:

bool

Definition at line 524 of file oxuser.php.

oxUser.isExpiredUpdateId

(

$

sKey

)

Checks if password update key is not expired yet

Parameters:

string

$sKey key

Returns:

bool

Definition at line 2101 of file oxuser.php.

oxUser.isLoadedFromCookie

(

)

Returns if user was loaded from cookie

Returns:

bool

Definition at line 2196 of file oxuser.php.

oxUser.isSamePassword

(

$

sNewPass

)

Checks if user entered password is the same as old

Parameters:

string

$sNewPass new password

Returns:

bool

Definition at line 2186 of file oxuser.php.

oxUser.isTermsAccepted

(

)

Checks if user accepted latest shopping terms and conditions version

Returns:

bool

Definition at line 2299 of file oxuser.php.

oxUser.load

(

$

oxID

)

Loads object (user) details from DB. Returns true on success.

Parameters:

string

$oxID User ID

Returns:

bool

Reimplemented from oxBase.

Definition at line 592 of file oxuser.php.

oxUser.loadActiveUser

(

$

blForceAdmin = false

)

Loads active user object. If user is not available - returns false.

Parameters:

bool

$blForceAdmin (default false)

Returns:

bool

Definition at line 1425 of file oxuser.php.

oxUser.loadAdminUser

(

)

Loads active admin user object (if possible). If user is not available - returns false.

Returns:

bool

Definition at line 1412 of file oxuser.php.

oxUser.loadUserByUpdateId

(

$

sUid

)

Tries to load user object by passed update id. Update id is generated when user forgot passwords and wants to update it

Parameters:

string

$sUid update id

Returns:

oxuser

Definition at line 2053 of file oxuser.php.

oxUser.login	(	$	sUser,
		$	sPassword,
		$	blCookie = false
	)

Performs user login by username and password. Fetches user data from DB. Registers in session. Returns true on success, FALSE otherwise.

Parameters:

	string	$sUser User username
	string	$sPassword User password
	bool	$blCookie (default false)

Exceptions:

oxConnectionException,oxCookieException,oxUserException

Returns:

bool

Definition at line 1325 of file oxuser.php.

oxUser.logout

(

)

Logs out session user. Returns true on success

Returns:

bool

Definition at line 1387 of file oxuser.php.

oxUser.onOrderExecute	(	$	oBasket,
		$	iSuccess
	)

Called after saving an order.

Parameters:

	object	$oBasket Shopping basket object
	int	$iSuccess order success status

Returns:

null

Definition at line 869 of file oxuser.php.

oxUser.prepareSalt

(

$

sSalt

)

Returns safe salt value (heximal representation)

Parameters:

string

$sSalt any unique string value

Returns:

string

Definition at line 2143 of file oxuser.php.

oxUser.removeFromGroup

(

$

sGroupID = null

)

Removes user from passed user group.

Parameters:

string

$sGroupID group id

Returns:

null

Definition at line 846 of file oxuser.php.

oxUser.save

(

)

Saves (updates) user object data information in DB. Return true on success.

Returns:

bool

Reimplemented from oxBase.

Definition at line 466 of file oxuser.php.

oxUser.setCreditPointsForInviter

(

)

Assigns credit points to inviter

Returns:

bool

Definition at line 2360 of file oxuser.php.

oxUser.setCreditPointsForRegistrant	(	$	sUserId,
		$	sRecEmail
	)

Assigns registration points for invited user and its inviter (calls oxUser.setInvitationCreditPoints())

Parameters:

	string	$sUserId inviter user id
	string	$sRecEmail recipient (registrant) email

Returns:

bool

Definition at line 2331 of file oxuser.php.

oxUser.setMallUsersStatus

(

$

blOn = false

)

Sets mall user status

Parameters:

bool

$blOn mall users is on or off

Returns:

null

Definition at line 160 of file oxuser.php.

oxUser.setNewsSubscription	(	$	blSubscribe,
		$	blSendOptIn,
		$	blForceCheckOptIn = false
	)

Sets newsletter subscription status to user

Parameters:

	bool	$blSubscribe subscribes/unsubscribes user from newsletter
	bool	$blSendOptIn if to send confirmation email
	bool	$blForceCheckOptIn forces to check subscription even when it is set to 1

Returns:

bool

Definition at line 1083 of file oxuser.php.

oxUser.setPassword

(

$

sPassword = null

)

Sets new password for user ( save is not called)

Parameters:

string

$sPassword password

Returns:

null

Definition at line 2167 of file oxuser.php.

oxUser.setSelectedAddressId

(

$

sAddressId

)

Selected user address setter

Parameters:

string

$sAddressId selected address id

Returns:

null

Definition at line 342 of file oxuser.php.

oxUser.setUpdateKey

(

$

blReset = false

)

Generates or resets and saves users update key

Parameters:

bool

$blReset marker to reset update info

Returns:

null

Definition at line 2069 of file oxuser.php.

oxUser.updateFbId

(

)

Updates user Facebook ID

Returns:

null

Definition at line 2378 of file oxuser.php.

oxUser.updateInvitationStatistics

(

$

aRecEmail

)

Updating invitations statistics

Parameters:

array

$aRecEmail array of recipients emails

Returns:

null

Definition at line 2398 of file oxuser.php.

---

Member Data Documentation

oxUser.$_aAddresses = array() [protected]

Definition at line 47 of file oxuser.php.

oxUser.$_aBaskets = array() [protected]

Definition at line 33 of file oxuser.php.

oxUser.$_aUserCookie = array() [static, protected]

Definition at line 75 of file oxuser.php.

oxUser.$_blDisableShopCheck = true [protected]

Definition at line 14 of file oxuser.php.

oxUser.$_blLoadedFromCookie = null [protected]

Definition at line 110 of file oxuser.php.

oxUser.$_blMallUsers = false [protected]

Definition at line 68 of file oxuser.php.

oxUser.$_iCntNoticeListArticles = null [protected]

Definition at line 82 of file oxuser.php.

oxUser.$_iCntRecommLists = null [protected]

Definition at line 96 of file oxuser.php.

oxUser.$_iCntWishListArticles = null [protected]

Definition at line 89 of file oxuser.php.

oxUser.$_oGroups [protected]

Definition at line 40 of file oxuser.php.

oxUser.$_oNewsSubscription = null [protected]

Definition at line 20 of file oxuser.php.

oxUser.$_oPayments [protected]

Definition at line 54 of file oxuser.php.

oxUser.$_oRecommList [protected]

Definition at line 61 of file oxuser.php.

oxUser.$_oSelAddress = null [protected]

Definition at line 124 of file oxuser.php.

oxUser.$_oUserCountryTitle = null [protected]

Definition at line 138 of file oxuser.php.

oxUser.$_sClassName = 'oxuser' [protected]

Reimplemented from oxBase.

Definition at line 26 of file oxuser.php.

oxUser.$_sSelAddressId = null [protected]

Definition at line 117 of file oxuser.php.

oxUser.$_sUpdateKey = null [protected]

Definition at line 103 of file oxuser.php.

oxUser.$_sWishId = null [protected]

Definition at line 131 of file oxuser.php.

---

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

• core/oxuser.php