Inheritance diagram for oxUser:

Collaboration diagram for oxUser:

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 ()
	getEncodedDeliveryAddress ()
	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)
	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 ()
	isPriceViewModeNetto ()
Public Member Functions inherited from oxBase
	getUseSkipSaveFields ()
	setUseSkipSaveFields ($blUseSkipSaveFields)
	__set ($sName, $sValue)
	__isset ($mVar)
	__clone ()
	oxClone ($oObject)
	getUpdateSeo ()
	setUpdateSeo ($blUpdateSeo)
	init ($sTableName=null, $blForceAllFields=false)
	assign ($dbRecord)
	getClassName ()
	getCoreTableName ()
	getId ()
	setId ($sOXID=null)
	setShopId ($iShopId)
	getShopId ()
	getViewName ($blForceCoreTableUsage=null)
	modifyCacheKey ($sCacheKey, $blOverride=false)
	disableLazyLoading ()
	isDerived ()
	setIsDerived ($blVal)
	isMultilang ()
	isLoaded ()
	buildSelectString ($aWhere=null)
	assignRecord ($sSelect)
	getFieldData ($sFieldName)
	getSelectFields ($blForceCoreTableUsage=null)
	allowDerivedDelete ()
	getSqlActiveSnippet ($blForceCoreTable=null)
	beforeUpdate ($sOXID=null)
	onChange ($iAction=null, $sOXID=null)
	setInList ()
	isOx ()
	isReadOnly ()
	setReadOnly ($blReadOnly)
	getFieldNames ()
	addFieldName ($sName)
	getLanguage ()
Public Member Functions inherited from oxSuperCfg
	__call ($sMethod, $aArgs)
	getConfig ()
	setConfig ($oConfig)
	getSession ()
	setSession ($oSession)
	getUser ()
	setUser ($oUser)
	isAdmin ()
	setAdminMode ($blAdmin)

Protected Member Functions
	_getWishListId ()
	_getMergedAddressFields ()
	_assignAddress ($aDelAddress)
	_getLegacyLoginQuery ($sUser, $sPassword, $sShopID, $blAdmin)
	_getLoginQuery ($sUser, $sPassword, $sShopID, $blAdmin)
	_getShopSelect ($myConfig, $sShopID, $blAdmin)
	_loadSavedUserBasketAfterLogin ()
	_getFacebookUserId ()
	_getCookieUserId ()
	_ldapLogin ($sUser, $sPassword, $sShopID, $sShopSelect)
	_getUserRights ()
	_insert ()
	_update ()
	_checkLogin ($sLogin, $aInvAddress)
	_checkEmail ($sEmail)
	_checkCountries ($aInvAddress, $aDelAddress)
	_checkRequiredFields ($aInvAddress, $aDelAddress)
	_checkRequiredArrayFields ($sFieldName, $aFieldValues)
	_checkVatId ($aInvAddress)
	_setAutoGroups ($sCountryId)
	_dbLogin ($sUser, $sPassword, $sShopID)
	_isDemoShop ()
	_getDemoShopLoginQuery ($sUser, $sPassword)
Protected Member Functions inherited from oxBase
	_setUpdateSeoOnFieldChange ($sField)
	_isInList ()
	_getObjectViewName ($sTable, $sShopID=null)
	_getTableFields ($sTable, $blReturnSimple=false)
	_getAllFields ($blReturnSimple=false)
	_initDataStructure ($blForceFullStructure=false)
	_getNonCachedFieldNames ($blForceFullStructure=false)
	_getFieldStatus ($sFieldName)
	_addField ($sName, $iStatus, $sType=null, $sLength=null)
	_getFieldLongName ($sFieldName)
	_setFieldData ($sFieldName, $sValue, $iDataType=oxField::T_TEXT)
	_canFieldBeNull ($sFieldName)
	_getFieldDefaultValue ($sFieldName)
	_getUpdateFieldValue ($sFieldName, $oField)
	_getUpdateFields ($blUseSkipSaveFields=true)
	_isDisabledFieldCache ()

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
Protected Attributes inherited from oxBase
	$_sOXID = null
	$_iShopId = null
	$_blIsSimplyClonable = true
	$_sClassName = 'oxbase'
	$_sCoreTable = null
	$_sViewTable = null
	$_aFieldNames = array('oxid' => 0)
	$_sCacheKey = null
	$_blUseLazyLoading = false
	$_aSkipSaveFields = array('oxtimestamp')
	$_blUseSkipSaveFields = true
	$_sExistKey = 'oxid'
	$_blIsDerived = null
	$_blIsSeoObject = false
	$_blUpdateSeo = true
	$_blReadOnly = false
	$_blIsInList = false
	$_isLoaded = false
	$_aInnerLazyCache = null
	$_blEmployMultilanguage = false

Static Protected Attributes
static	$_aUserCookie = array()
Static Protected Attributes inherited from oxBase
static	$_blDisableFieldCaching = array()
Static Protected Attributes inherited from oxSuperCfg
static	$_oConfig = null
static	$_oSession = null
static	$_oRights = null
static	$_oActUser = null
static	$_blIsAdmin = null

Detailed Description

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

Definition at line 9 of file oxuser.php.

Constructor & Destructor Documentation

oxUser::__construct ( )

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

Returns: null

Reimplemented from oxBase.

Definition at line 146 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 173 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 1218 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 1892 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 1860 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 1737 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 1923 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 1908 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 1938 of file oxuser.php.

oxUser::_dbLogin	(	$sUser,
		$sPassword,
		$sShopID
	)

protected

Parameters

$sUser
$sPassword
$sShopID

Exceptions

object

Definition at line 2393 of file oxuser.php.

oxUser::_getCookieUserId ( )

protected

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

Returns: string

Definition at line 1534 of file oxuser.php.

oxUser::_getDemoShopLoginQuery	(	$sUser,
		$sPassword
	)

protected

Definition at line 2433 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 1513 of file oxuser.php.

oxUser::_getLegacyLoginQuery	(	$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 1254 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

Exceptions

object

Returns: string

Definition at line 1287 of file oxuser.php.

oxUser::_getMergedAddressFields ( )

protected

Returns merged delivery address fields.

Returns: string

Definition at line 1189 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 1320 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 1638 of file oxuser.php.

oxUser::_getWishListId ( )

protected

Checks if product from wishlist is added

Returns: $sWishId

Definition at line 371 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 1682 of file oxuser.php.

oxUser::_isDemoShop ( )

protected

Definition at line 2422 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 1579 of file oxuser.php.

oxUser::_loadSavedUserBasketAfterLogin ( )

protected

Load saved user basket from the database after he logs in

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

Returns: null

Definition at line 1337 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 1951 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 1700 of file oxuser.php.

oxUser::acceptTerms ( )

Writes terms acceptance info to db

Returns: null

Definition at line 2243 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 1013 of file oxuser.php.

oxUser::addToGroup ( $sGroupID )

Adds user to the group

Parameters

string $sGroupID group id

Returns: bool

Definition at line 829 of file oxuser.php.

oxUser::allowDerivedUpdate ( )

Overrides parent isDerived check and returns true

Returns: bool

Reimplemented from oxBase.

Definition at line 513 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 1154 of file oxuser.php.

oxUser::checkIfEmailExists ( $sEmail )

Checks for already used email

Parameters

string $sEmail user email/login

Returns: null

Definition at line 1751 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 1877 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 1058 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 943 of file oxuser.php.

oxUser::createUser ( )

Inserts new or updates existing user

Exceptions

oxUserException exception

Returns: bool

Definition at line 781 of file oxuser.php.

oxUser::decodeSalt ( $sSaltHex )

Returns plains password salt representation

Parameters

string $sSaltHex heximal representation of password salt value

Deprecated:: since v4.8.8/5.1.8 (2014-08-12); No need after introducing oxPasswordSaltGenerator

Returns: string

Definition at line 2118 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 543 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

Deprecated:: since v4.8.8/5.1.8 (2014-08-13); Use oxPasswordSaltGenerator

Returns: string

Definition at line 2080 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 618 of file oxuser.php.

oxUser::getActiveCountry ( )

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

Returns: string

Definition at line 754 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 914 of file oxuser.php.

oxUser::getBoni ( )

Return standart credit rating, can be set in config option iCreditRating;

Returns: integer

Definition at line 992 of file oxuser.php.

oxUser::getEncodedDeliveryAddress ( )

Returns encoded delivery address.

Returns: string

Definition at line 743 of file oxuser.php.

oxUser::getIdByUserName ( $sUserName )

retruns user id by user name

Parameters

string $sUserName user name

Returns: string

Definition at line 2352 of file oxuser.php.

oxUser::getNewsSubscription ( )

Returns user newsletter subscription controller object

Returns: object oxnewssubscribed

Definition at line 212 of file oxuser.php.

oxUser::getNoticeListArtCnt ( )

Returns amount of articles in noticelist

Returns: int

Definition at line 711 of file oxuser.php.

oxUser::getOrderCount ( )

Caclulates amount of orders made by user

Returns: int

Definition at line 694 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: oxList

Definition at line 660 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 2175 of file oxuser.php.

oxUser::getRecommListsCount ( $sOx = null )

Returns recommlist count

Parameters

string $sOx object ID (default is null)

Returns: int

Definition at line 1834 of file oxuser.php.

oxUser::getReviewUserHash ( $sUserId )

Generates user password and username hash for review

Parameters

string $sUserId userid

Returns: string

Definition at line 2194 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 2208 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 393 of file oxuser.php.

oxUser::getSelectedAddressId ( )

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

Returns: string

Definition at line 353 of file oxuser.php.

oxUser::getState ( )

Returns string representation of user state

Returns: string

Definition at line 2220 of file oxuser.php.

oxUser::getUpdateId ( )

Returns user passwords update id

Returns: string

Definition at line 2061 of file oxuser.php.

oxUser::getUpdateLinkTerm ( )

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

Returns: int

Definition at line 2037 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 312 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 245 of file oxuser.php.

oxUser::getUserCountryId ( $sCountry = null )

Returns user countryid according to passed name

Parameters

string $sCountry country

Returns: string

Definition at line 270 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 286 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 438 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 1803 of file oxuser.php.

oxUser::getWishListArtCnt ( )

Calculating user wishlist item count

Returns: int

Definition at line 727 of file oxuser.php.

oxUser::hasAccount ( )

returns true if user registered and have account

Returns: bool

Definition at line 2369 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 525 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 2049 of file oxuser.php.

oxUser::isLoadedFromCookie ( )

Returns if user was loaded from cookie

Returns: bool

Definition at line 2164 of file oxuser.php.

oxUser::isPriceViewModeNetto ( )

Return user price view mode, true - if netto mode

Returns: bool

Definition at line 2381 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 2154 of file oxuser.php.

oxUser::isTermsAccepted ( )

Checks if user accepted latest shopping terms and conditions version

Returns: bool

Definition at line 2230 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 593 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 1461 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 1448 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 2001 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

object
oxCookieException
oxUserException

Returns: bool

Definition at line 1365 of file oxuser.php.

oxUser::logout ( )

Logs out session user. Returns true on success

Returns: bool

Definition at line 1423 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 877 of file oxuser.php.

oxUser::prepareSalt ( $sSalt )

Returns safe salt value (heximal representation)

Parameters

string $sSalt any unique string value

Deprecated:: since v4.8.8/5.1.8 (2014-08-13); Use oxPasswordSaltGenerator

Returns: string

Definition at line 2099 of file oxuser.php.

oxUser::removeFromGroup ( $sGroupID = null )

Removes user from passed user group.

Parameters

string $sGroupID group id

Returns: null

Definition at line 854 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 467 of file oxuser.php.

oxUser::setCreditPointsForInviter ( )

Assigns credit points to inviter

Returns: bool

Definition at line 2291 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 2262 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 161 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 1094 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 2130 of file oxuser.php.

oxUser::setSelectedAddressId ( $sAddressId )

Selected user address setter

Parameters

string $sAddressId selected address id

Returns: null

Definition at line 343 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 2017 of file oxuser.php.

oxUser::updateFbId ( )

Updates user Facebook ID

Returns: null

Definition at line 2309 of file oxuser.php.

oxUser::updateInvitationStatistics ( $aRecEmail )

Updating invitations statistics

Parameters

array $aRecEmail array of recipients emails

Returns: null

Definition at line 2329 of file oxuser.php.

Member Data Documentation

oxUser::$_aAddresses = array()

protected

Definition at line 48 of file oxuser.php.

oxUser::$_aBaskets = array()

protected

Definition at line 34 of file oxuser.php.

oxUser::$_aUserCookie = array()

staticprotected

Definition at line 76 of file oxuser.php.

oxUser::$_blDisableShopCheck = true

protected

Definition at line 15 of file oxuser.php.

oxUser::$_blLoadedFromCookie = null

protected

Definition at line 111 of file oxuser.php.

oxUser::$_blMallUsers = false

protected

Definition at line 69 of file oxuser.php.

oxUser::$_iCntNoticeListArticles = null

protected

Definition at line 83 of file oxuser.php.

oxUser::$_iCntRecommLists = null

protected

Definition at line 97 of file oxuser.php.

oxUser::$_iCntWishListArticles = null

protected

Definition at line 90 of file oxuser.php.

oxUser::$_oGroups

protected

Definition at line 41 of file oxuser.php.

oxUser::$_oNewsSubscription = null

protected

Definition at line 21 of file oxuser.php.

oxUser::$_oPayments

protected

Definition at line 55 of file oxuser.php.

oxUser::$_oRecommList

protected

Definition at line 62 of file oxuser.php.

oxUser::$_oSelAddress = null

protected

Definition at line 125 of file oxuser.php.

oxUser::$_oUserCountryTitle = null

protected

Definition at line 139 of file oxuser.php.

oxUser::$_sClassName = 'oxuser'

protected

Definition at line 27 of file oxuser.php.

oxUser::$_sSelAddressId = null

protected

Definition at line 118 of file oxuser.php.

oxUser::$_sUpdateKey = null

protected

Definition at line 104 of file oxuser.php.

oxUser::$_sWishId = null

protected

Definition at line 132 of file oxuser.php.

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

application/models/oxuser.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation