Inheritance diagram for OxidEsales\EshopCommunity\Application\Model\User:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Model\User:

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 ()

	getUserPayments ($sOXID=null)

	save ()

	allowDerivedUpdate ()

	inGroup ($sGroupID)

	delete ($oxid=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 ()

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

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

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

	login ($userName, $password, $setSessionCookie=false)

	logout ()

	loadAdminUser ()

	loadActiveUser ($blForceAdmin=false)

	checkIfEmailExists ($sEmail)

	getUserRecommLists ($sOXID=null)

	getRecommListsCount ($sOx=null)

	loadUserByUpdateId ($sUid)

	setUpdateKey ($blReset=false)

	getUpdateLinkTerm ()

	isExpiredUpdateId ($sKey)

	getUpdateId ()

	encodePassword ($sPassword, $sSalt)

	setPassword ($password=null)

	isSamePassword ($password)

	isLoadedFromCookie ()

	getReviewUserHash ($sUserId)

	getReviewUserId ($sReviewUserHash)

	getStateId ()

	getStateTitle ($sId=null)

	isTermsAccepted ()

	acceptTerms ()

	setCreditPointsForRegistrant ($sUserId, $sRecEmail)

	setCreditPointsForInviter ()

	updateInvitationStatistics ($aRecEmail)

	getIdByUserName ($userName)

	hasAccount ()

	isPriceViewModeNetto ()

	isMallAdmin ()

Public Attributes
const	USER_COOKIE_SALT = 'user_cookie_salt'

Protected Member Functions
	_getStateObject ()

	_getWishListId ()

	_getMergedAddressFields ()

	_assignAddress ($aDelAddress)

	_getLoginQueryHashedWithMD5 ($userName, $password, $shopId, $isAdmin)

	_getLoginQuery ($userName, $password, $shopId, $isAdmin)

	_getShopSelect ($myConfig, $sShopID, $blAdmin)

	_getCookieUserId ()

	_ldapLogin ($sUser, $sPassword, $sShopID, $sShopSelect)

	_getUserRights ()

	_insert ()

	_update ()

	_setAutoGroups ($sCountryId)

	_dbLogin (string $userName, $password, $shopID)

	getPasswordHashFromDatabase (string $userName, int $shopId, bool $isLoginToAdminBackend)

	_isDemoShop ()

	_getDemoShopLoginQuery ($sUser, $sPassword)

	onChangeUserData ($aInvAddress)

	deleteAdditionally ($sOXIDQuoted)

	updateGetOrdersQuery ($query)

	onLogin ($userName, $password)

	getUtilsObjectInstance ()

	formQueryPartForSha512Password (string $password, DatabaseInterface $database, string $userCondition, string $shopCondition)

	formQueryPartForMD5Password ($password, DatabaseInterface $databaseb)

	formQueryPartForAdminView ($sShopID, $blAdmin)

	formUserCookieQuery ($user, $shopId)

Protected Attributes
	$_blDisableShopCheck = true

	$_oNewsSubscription = null

	$_sClassName = 'oxuser'

	$_aBaskets = []

	$_oGroups

	$_aAddresses = []

	$_oPayments

	$_oRecommList

	$_blMallUsers = false

	$_iCntNoticeListArticles = null

	$_iCntWishListArticles = null

	$_iCntRecommLists = null

	$_sUpdateKey = null

	$_blLoadedFromCookie = null

	$_sSelAddressId = null

	$_oSelAddress = null

	$_sWishId = null

	$_oUserCountryTitle = null

	$_oStateObject = null

Static Protected Attributes
static	$_aUserCookie = []

Private Member Functions
	loadAuthenticatedUser (string $userName, int $shopId)

	getAuthenticatedUserId (string $userName, int $shopId, bool $isLoginToAdminBackend)

	hashPassword (string $password)

	deleteUserFromGroups (DatabaseInterface $database)

	deleteDeliveries (DatabaseInterface $database)

	deleteDiscounts (DatabaseInterface $database)

	deleteAcceptedTerms (DatabaseInterface $database)

	deleteAddresses (DatabaseInterface $database)

	deleteBaskets (DatabaseInterface $database)

	deleteNotOrderRelatedRemarks (DatabaseInterface $database)

	deleteRecommendationLists (DatabaseInterface $database)

	deleteNewsletterSubscriptions (DatabaseInterface $database)

	deleteReviews (DatabaseInterface $database)

	deleteRatings (DatabaseInterface $database)

	deletePriceAlarms (DatabaseInterface $database)

	deleteItemById ($id, $key, $className)

	formQueryPartForUserName ($user, DatabaseInterface $database)

	formQueryPartForActiveUser ()

Private Attributes
	$isOutdatedPasswordHashAlgorithmUsed = false

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

OxidEsales\EshopCommunity\Application\Model\User::__construct ( )

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

Member Function Documentation

◆ __get()

OxidEsales\EshopCommunity\Application\Model\User::__get ( $sParamName )

Getter for special not frequently used fields

Parameters

string $sParamName name of parameter to get value

Returns: mixed

◆ _assignAddress()

OxidEsales\EshopCommunity\Application\Model\User::_assignAddress ( $aDelAddress )

protected

creates new address entry or updates existing

Parameters

array $aDelAddress address data array

◆ _dbLogin()

OxidEsales\EshopCommunity\Application\Model\User::_dbLogin	(	string	$userName,
			$password,
			$shopID
	)

protected

Initiates user login against data in DB.

Parameters

string	$userName	User
string	$password	Password
string	$shopID	Shop id

Exceptions

UserException

Deprecated:: since v6.4.0 (2019-03-15); \OxidEsales\EshopCommunity\Internal\Domain\Authentication\Bridge\PasswordServiceBridgeInterface was added as the new default for hashing passwords. Hashing passwords with MD5 and SHA512 is still supported in order support login with older password hashes. Therefor this method might not be compatible with the current passhword hash any more.

Returns: void

◆ _getCookieUserId()

OxidEsales\EshopCommunity\Application\Model\User::_getCookieUserId ( )

protected

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

Returns: string

◆ _getDemoShopLoginQuery()

OxidEsales\EshopCommunity\Application\Model\User::_getDemoShopLoginQuery	(	$sUser,
		$sPassword
	)

protected

Return sql to get id of mall admin in demo shop

Parameters

string	$sUser	User name
string	$sPassword	User password

Exceptions

object::$oEx

Returns: string

◆ _getLoginQuery()

OxidEsales\EshopCommunity\Application\Model\User::_getLoginQuery	(	$userName,
		$password,
		$shopId,
		$isAdmin
	)

protected

Builds and returns user login query

Parameters

string	$userName
string	$password
int	$shopId
bool	$isAdmin

Deprecated:: since v6.4.0 (2019-03-15); \OxidEsales\EshopCommunity\Internal\Domain\Authentication\Bridge\PasswordServiceBridgeInterface was added as the new default for hashing passwords. Hashing passwords with MD5 and SHA512 is still supported in order support login with older password hashes. Therefor this method might not be compatible with the current passhword hash any more.

Returns: string

◆ _getLoginQueryHashedWithMD5()

OxidEsales\EshopCommunity\Application\Model\User::_getLoginQueryHashedWithMD5	(	$userName,
		$password,
		$shopId,
		$isAdmin
	)

protected

Builds and returns user login query.

MD5 encoding is used in legacy eShop versions. We still allow to perform the login for users registered in the previous eshop versions.

Parameters

string	$userName	login name
string	$password	login password
string	$shopId	shopid
bool	$isAdmin	admin/non admin mode

Deprecated:: since v6.4.0 (2019-03-15); \OxidEsales\EshopCommunity\Internal\Domain\Authentication\Bridge\PasswordServiceBridgeInterface was added as the new default for hashing passwords. Hashing passwords with MD5 and SHA512 is still supported in order support login with older password hashes. Therefor this method might not be compatible with the current passhword hash any more.

Returns: string

◆ _getMergedAddressFields()

OxidEsales\EshopCommunity\Application\Model\User::_getMergedAddressFields ( )

protected

Returns merged delivery address fields.

Returns: string

◆ _getShopSelect()

OxidEsales\EshopCommunity\Application\Model\User::_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

◆ _getStateObject()

OxidEsales\EshopCommunity\Application\Model\User::_getStateObject ( )

protected

Gets state object.

Returns: oxState

◆ _getUserRights()

OxidEsales\EshopCommunity\Application\Model\User::_getUserRights ( )

protected

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

Returns: string

◆ _getWishListId()

OxidEsales\EshopCommunity\Application\Model\User::_getWishListId ( )

protected

Checks if product from wishlist is added

Returns: $sWishId

◆ _insert()

OxidEsales\EshopCommunity\Application\Model\User::_insert ( )

protected

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

Returns: bool

◆ _isDemoShop()

OxidEsales\EshopCommunity\Application\Model\User::_isDemoShop ( )

protected

Return true - if shop is in demo mode

Returns: bool

◆ _ldapLogin()

OxidEsales\EshopCommunity\Application\Model\User::_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

Deprecated:: v5.3 (2016-10-06); LDAP will be moved to own module.

Exceptions

$oEx	if user is wrong

◆ _setAutoGroups()

OxidEsales\EshopCommunity\Application\Model\User::_setAutoGroups ( $sCountryId )

protected

Automatically assigns user to specific groups according to users country information

Parameters

string $sCountryId users country id

◆ _update()

OxidEsales\EshopCommunity\Application\Model\User::_update ( )

protected

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

Returns: bool

◆ acceptTerms()

OxidEsales\EshopCommunity\Application\Model\User::acceptTerms ( )

Writes terms acceptance info to db

◆ addToGroup()

OxidEsales\EshopCommunity\Application\Model\User::addToGroup ( $sGroupID )

Adds user to the group

Parameters

string $sGroupID group id

Returns: bool

◆ allowDerivedUpdate()

OxidEsales\EshopCommunity\Application\Model\User::allowDerivedUpdate ( )

Overrides parent isDerived check and returns true

Returns: bool

◆ changeUserData()

OxidEsales\EshopCommunity\Application\Model\User::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 (\OxidEsales\Eshop\Application\Model\User::_setAutoGroups, \OxidEsales\Eshop\Application\Model\User::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

UserException,oxInputException,oxConnectionException

◆ checkIfEmailExists()

OxidEsales\EshopCommunity\Application\Model\User::checkIfEmailExists ( $sEmail )

Checks for already used email

Parameters

string $sEmail user email/login

Returns: null

◆ checkValues()

OxidEsales\EshopCommunity\Application\Model\User::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

UserException,oxInputException

◆ convertBirthday()

OxidEsales\EshopCommunity\Application\Model\User::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 birthday data

Returns: string

◆ createUser()

OxidEsales\EshopCommunity\Application\Model\User::createUser ( )

Inserts new or updates existing user

Exceptions

UserException exception

Returns: bool

◆ delete()

OxidEsales\EshopCommunity\Application\Model\User::delete ( $oxid = null )

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

Parameters

string $oxid object ID (default null)

Returns: bool

◆ deleteAcceptedTerms()

OxidEsales\EshopCommunity\Application\Model\User::deleteAcceptedTerms ( DatabaseInterface $database )

private

Deletes user accepted terms.

Parameters

DatabaseInterface $database

◆ deleteAdditionally()

OxidEsales\EshopCommunity\Application\Model\User::deleteAdditionally ( $sOXIDQuoted )

protected

Method is used to make additional delete actions.

Parameters

string $sOXIDQuoted

◆ deleteAddresses()

OxidEsales\EshopCommunity\Application\Model\User::deleteAddresses ( DatabaseInterface $database )

private

Deletes User addresses.

Parameters

DatabaseInterface $database

◆ deleteBaskets()

OxidEsales\EshopCommunity\Application\Model\User::deleteBaskets ( DatabaseInterface $database )

private

Deletes noticelists, wishlists or saved baskets

Parameters

DatabaseInterface $database

◆ deleteDeliveries()

OxidEsales\EshopCommunity\Application\Model\User::deleteDeliveries ( DatabaseInterface $database )

private

Deletes deliveries.

Parameters

DatabaseInterface $database

◆ deleteDiscounts()

OxidEsales\EshopCommunity\Application\Model\User::deleteDiscounts ( DatabaseInterface $database )

private

Deletes discounts.

Parameters

DatabaseInterface $database

◆ deleteItemById()

OxidEsales\EshopCommunity\Application\Model\User::deleteItemById	(	$id,
		$key,
		$className
	)

private

Callback function for array_walk to delete items using the delete method of the given model class

Parameters

string	$id	Id of the item to be deleted
integer	$key	Key of the array
string	$className	Model class to be used

◆ deleteNewsletterSubscriptions()

OxidEsales\EshopCommunity\Application\Model\User::deleteNewsletterSubscriptions ( DatabaseInterface $database )

private

Deletes newsletter subscriptions.

Parameters

DatabaseInterface $database

◆ deleteNotOrderRelatedRemarks()

OxidEsales\EshopCommunity\Application\Model\User::deleteNotOrderRelatedRemarks ( DatabaseInterface $database )

private

Deletes not Order related remarks.

Parameters

DatabaseInterface $database

◆ deletePriceAlarms()

OxidEsales\EshopCommunity\Application\Model\User::deletePriceAlarms ( DatabaseInterface $database )

private

Deletes price alarms.

Parameters

DatabaseInterface $database

◆ deleteRatings()

OxidEsales\EshopCommunity\Application\Model\User::deleteRatings ( DatabaseInterface $database )

private

Deletes User ratings.

Parameters

DatabaseInterface $database

◆ deleteRecommendationLists()

OxidEsales\EshopCommunity\Application\Model\User::deleteRecommendationLists ( DatabaseInterface $database )

private

Deletes recommendation lists.

Parameters

DatabaseInterface $database

◆ deleteReviews()

OxidEsales\EshopCommunity\Application\Model\User::deleteReviews ( DatabaseInterface $database )

private

Deletes User reviews.

Parameters

DatabaseInterface $database

◆ deleteUserFromGroups()

OxidEsales\EshopCommunity\Application\Model\User::deleteUserFromGroups ( DatabaseInterface $database )

private

Deletes User from groups.

Parameters

DatabaseInterface $database

◆ encodePassword()

OxidEsales\EshopCommunity\Application\Model\User::encodePassword	(	$sPassword,
		$sSalt
	)

Encodes and returns given password

Parameters

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

Deprecated:: since v6.4.0 (2019-03-15); \OxidEsales\EshopCommunity\Internal\Domain\Authentication\Bridge\PasswordServiceBridgeInterface was added as the new default for hashing passwords. Hashing passwords with MD5 and SHA512 is still supported in order support login with older password hashes. Therefor this method might not be compatible with the current passhword hash any more.

Returns: string

◆ exists()

OxidEsales\EshopCommunity\Application\Model\User::exists ( $sOXID = null )

Checks if user exists in database.

Parameters

string $sOXID object ID (default null)

Returns: bool

◆ formQueryPartForActiveUser()

OxidEsales\EshopCommunity\Application\Model\User::formQueryPartForActiveUser ( )

private

Returns: string

◆ formQueryPartForAdminView()

OxidEsales\EshopCommunity\Application\Model\User::formQueryPartForAdminView	(	$sShopID,
		$blAdmin
	)

protected

Forms shop select query.

Parameters

string	$sShopID	Shop id is used when method is overridden.
bool	$blAdmin

Returns: string

◆ formQueryPartForMD5Password()

OxidEsales\EshopCommunity\Application\Model\User::formQueryPartForMD5Password	(		$password,
		DatabaseInterface	$databaseb
	)

protected

Parameters

string	$password
DatabaseInterface	$databaseb

Deprecated:: since v6.4.0 (2019-03-15); \OxidEsales\EshopCommunity\Internal\Domain\Authentication\Bridge\PasswordServiceBridgeInterface was added as the new default for hashing passwords. Hashing passwords with MD5 and SHA512 is still supported in order support login with older password hashes. Therefor this method might not be compatible with the current passhword hash any more.

Returns: string

◆ formQueryPartForSha512Password()

OxidEsales\EshopCommunity\Application\Model\User::formQueryPartForSha512Password	(	string	$password,
		DatabaseInterface	$database,
		string	$userCondition,
		string	$shopCondition
	)

protected

Parameters

string	$password
DatabaseInterface	$database
string	$userCondition
string	$shopCondition

Deprecated:: since v6.4.0 (2019-03-15); \OxidEsales\EshopCommunity\Internal\Domain\Authentication\Bridge\PasswordServiceBridgeInterface was added as the new default for hashing passwords. Hashing passwords with MD5 and SHA512 is still supported in order support login with older password hashes. Therefor this method might not be compatible with the current passhword hash any more.

Returns: string

◆ formQueryPartForUserName()

OxidEsales\EshopCommunity\Application\Model\User::formQueryPartForUserName	(		$user,
		DatabaseInterface	$database
	)

private

Parameters

string	$user
DatabaseInterface	$database

Returns: string

◆ formUserCookieQuery()

OxidEsales\EshopCommunity\Application\Model\User::formUserCookieQuery	(	$user,
		$shopId
	)

protected

Updates given query. Method is for overriding.

Parameters

string	$user
string	$shopId

Returns: string

◆ getActiveCountry()

OxidEsales\EshopCommunity\Application\Model\User::getActiveCountry ( )

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

Returns: string

◆ getAuthenticatedUserId()

OxidEsales\EshopCommunity\Application\Model\User::getAuthenticatedUserId	(	string	$userName,
		int	$shopId,
		bool	$isLoginToAdminBackend
	)

private

Parameters

string	$userName
int	$shopId
bool	$isLoginToAdminBackend

Returns: false|string

◆ getBasket()

OxidEsales\EshopCommunity\Application\Model\User::getBasket ( $sName )

Returns notice, wishlist or saved basket object

Parameters

string $sName name/type of basket

Returns: \OxidEsales\Eshop\Application\Model\UserBasket

◆ getBoni()

OxidEsales\EshopCommunity\Application\Model\User::getBoni ( )

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

Returns: integer

◆ getEncodedDeliveryAddress()

OxidEsales\EshopCommunity\Application\Model\User::getEncodedDeliveryAddress ( )

Returns encoded delivery address.

Returns: string

◆ getIdByUserName()

OxidEsales\EshopCommunity\Application\Model\User::getIdByUserName ( $userName )

return user id by user name

Parameters

string $userName

Returns: false|string

◆ getNewsSubscription()

OxidEsales\EshopCommunity\Application\Model\User::getNewsSubscription ( )

Returns user newsletter subscription controller object

Returns: object oxnewssubscribed

◆ getNoticeListArtCnt()

OxidEsales\EshopCommunity\Application\Model\User::getNoticeListArtCnt ( )

Returns amount of articles in noticelist

Returns: int

◆ getOrderCount()

OxidEsales\EshopCommunity\Application\Model\User::getOrderCount ( )

Caclulates amount of orders made by user

Returns: int

◆ getOrders()

OxidEsales\EshopCommunity\Application\Model\User::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

◆ getPasswordHashFromDatabase()

OxidEsales\EshopCommunity\Application\Model\User::getPasswordHashFromDatabase	(	string	$userName,
		int	$shopId,
		bool	$isLoginToAdminBackend
	)

protected

Parameters

string	$userName
int	$shopId
bool	$isLoginToAdminBackend

Returns: false|string

Exceptions

◆ getRecommListsCount()

OxidEsales\EshopCommunity\Application\Model\User::getRecommListsCount ( $sOx = null )

Returns recommlist count

Parameters

string $sOx object ID (default is null)

Deprecated:: since v5.3 (2016-06-17); Listmania will be moved to an own module.

Returns: int

◆ getReviewUserHash()

OxidEsales\EshopCommunity\Application\Model\User::getReviewUserHash ( $sUserId )

Generates user password and username hash for review

Parameters

string $sUserId userid

Returns: string

◆ getReviewUserId()

OxidEsales\EshopCommunity\Application\Model\User::getReviewUserId ( $sReviewUserHash )

Gets from review user hash user id

Parameters

string $sReviewUserHash review user hash

Returns: string

◆ getSelectedAddress()

OxidEsales\EshopCommunity\Application\Model\User::getSelectedAddress ( )

Sets in the array \OxidEsales\Eshop\Application\Model\User::_aAddresses selected address. Returns user selected address object.

Returns: object $oSelectedAddress

◆ getSelectedAddressId()

OxidEsales\EshopCommunity\Application\Model\User::getSelectedAddressId ( )

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

Returns: string

◆ getStateId()

OxidEsales\EshopCommunity\Application\Model\User::getStateId ( )

Get state id for current user

Returns: mixed

◆ getStateTitle()

OxidEsales\EshopCommunity\Application\Model\User::getStateTitle ( $sId = null )

Get state title by id

Parameters

string $sId state ID

Returns: string

◆ getUpdateId()

OxidEsales\EshopCommunity\Application\Model\User::getUpdateId ( )

Returns user passwords update id

Returns: string

◆ getUpdateLinkTerm()

OxidEsales\EshopCommunity\Application\Model\User::getUpdateLinkTerm ( )

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

Returns: int

◆ getUserAddresses()

OxidEsales\EshopCommunity\Application\Model\User::getUserAddresses ( $sUserId = null )

Returns user defined Address list object

Parameters

string $sUserId object ID (default is null)

Returns: array

◆ getUserCountry()

OxidEsales\EshopCommunity\Application\Model\User::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

◆ getUserCountryId()

OxidEsales\EshopCommunity\Application\Model\User::getUserCountryId ( $sCountry = null )

Returns user countryid according to passed name

Parameters

string $sCountry country

Returns: string

◆ getUserGroups()

OxidEsales\EshopCommunity\Application\Model\User::getUserGroups ( $sOXID = null )

Returns assigned user groups list object

Parameters

string $sOXID object ID (default is null)

Returns: object

◆ getUserPayments()

OxidEsales\EshopCommunity\Application\Model\User::getUserPayments ( $sOXID = null )

Returns user payment history list object

Parameters

string $sOXID object ID (default is null)

Returns: object oxList with oxuserpayments objects

◆ getUserRecommLists()

OxidEsales\EshopCommunity\Application\Model\User::getUserRecommLists ( $sOXID = null )

Returns user recommendation list object

Parameters

string $sOXID object ID (default is null)

Deprecated:: since v5.3 (2016-06-17); Listmania will be moved to an own module.

Returns: object oxList with oxrecommlist objects

◆ getUtilsObjectInstance()

OxidEsales\EshopCommunity\Application\Model\User::getUtilsObjectInstance ( )

protected

Returns: \OxidEsales\Eshop\Core\UtilsObject

◆ getWishListArtCnt()

OxidEsales\EshopCommunity\Application\Model\User::getWishListArtCnt ( )

Calculating user wishlist item count

Returns: int

◆ hasAccount()

OxidEsales\EshopCommunity\Application\Model\User::hasAccount ( )

returns true if user registered and have account

Returns: bool

◆ hashPassword()

OxidEsales\EshopCommunity\Application\Model\User::hashPassword ( string $password )

private

Parameters

string $password

Returns: string

◆ inGroup()

OxidEsales\EshopCommunity\Application\Model\User::inGroup ( $sGroupID )

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

Parameters

string $sGroupID user group ID

Returns: bool

◆ isExpiredUpdateId()

OxidEsales\EshopCommunity\Application\Model\User::isExpiredUpdateId ( $sKey )

Checks if password update key is not expired yet

Parameters

string $sKey key

Returns: bool

◆ isLoadedFromCookie()

OxidEsales\EshopCommunity\Application\Model\User::isLoadedFromCookie ( )

Returns if user was loaded from cookie

Returns: bool

◆ isMallAdmin()

OxidEsales\EshopCommunity\Application\Model\User::isMallAdmin ( )

Returns true if User is mall admin.

Returns: bool

◆ isPriceViewModeNetto()

OxidEsales\EshopCommunity\Application\Model\User::isPriceViewModeNetto ( )

Return user price view mode, true - if netto mode

Returns: bool

◆ isSamePassword()

OxidEsales\EshopCommunity\Application\Model\User::isSamePassword ( $password )

Checks if user entered password is the same as old

Parameters

string $password new password

Returns: bool

◆ isTermsAccepted()

OxidEsales\EshopCommunity\Application\Model\User::isTermsAccepted ( )

Checks if user accepted latest shopping terms and conditions version

Returns: bool

◆ load()

OxidEsales\EshopCommunity\Application\Model\User::load ( $oxID )

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

Parameters

string $oxID User ID

Returns: bool

◆ loadActiveUser()

OxidEsales\EshopCommunity\Application\Model\User::loadActiveUser ( $blForceAdmin = false )

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

Parameters

bool $blForceAdmin (default false)

Returns: bool

◆ loadAdminUser()

OxidEsales\EshopCommunity\Application\Model\User::loadAdminUser ( )

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

Returns: bool

◆ loadAuthenticatedUser()

OxidEsales\EshopCommunity\Application\Model\User::loadAuthenticatedUser	(	string	$userName,
		int	$shopId
	)

private

Parameters

string	$userName
int	$shopId

Exceptions

UserException

◆ loadUserByUpdateId()

OxidEsales\EshopCommunity\Application\Model\User::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

◆ login()

OxidEsales\EshopCommunity\Application\Model\User::login	(	$userName,
		$password,
		$setSessionCookie = `false`
	)

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

NOTE: It the user has already been loaded prior calling \OxidEsales\Eshop\Application\Model\User::login, NO valid password is necessary for login.

Parameters

string	$userName	User username
string	$password	User password
bool	$setSessionCookie	(default false)

Exceptions

object
oxCookieException
UserException

Returns: bool

◆ logout()

OxidEsales\EshopCommunity\Application\Model\User::logout ( )

Logs out session user. Returns true on success

Returns: bool

◆ onChangeUserData()

OxidEsales\EshopCommunity\Application\Model\User::onChangeUserData ( $aInvAddress )

protected

Method used for override.

Parameters

array $aInvAddress

◆ onLogin()

OxidEsales\EshopCommunity\Application\Model\User::onLogin	(	$userName,
		$password
	)

protected

Method is used for overriding and add additional actions when logging in.

Parameters

string	$userName
string	$password

◆ onOrderExecute()

OxidEsales\EshopCommunity\Application\Model\User::onOrderExecute	(	$oBasket,
		$iSuccess
	)

Called after saving an order.

Parameters

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

◆ removeFromGroup()

OxidEsales\EshopCommunity\Application\Model\User::removeFromGroup ( $sGroupID = null )

Removes user from passed user group.

Parameters

string $sGroupID group id

◆ save()

OxidEsales\EshopCommunity\Application\Model\User::save ( )

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

Returns: bool

◆ setCreditPointsForInviter()

OxidEsales\EshopCommunity\Application\Model\User::setCreditPointsForInviter ( )

Assigns credit points to inviter

Returns: bool

◆ setCreditPointsForRegistrant()

OxidEsales\EshopCommunity\Application\Model\User::setCreditPointsForRegistrant	(	$sUserId,
		$sRecEmail
	)

Assigns registration points for invited user and its inviter (calls \OxidEsales\Eshop\Application\Model\User::setInvitationCreditPoints())

Parameters

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

Returns: bool

◆ setMallUsersStatus()

OxidEsales\EshopCommunity\Application\Model\User::setMallUsersStatus ( $blOn = false )

Sets mall user status

Parameters

bool $blOn mall users is on or off

◆ setNewsSubscription()

OxidEsales\EshopCommunity\Application\Model\User::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

◆ setPassword()

OxidEsales\EshopCommunity\Application\Model\User::setPassword ( $password = null )

Sets new password for user ( save is not called)

Parameters

string $password password

◆ setSelectedAddressId()

OxidEsales\EshopCommunity\Application\Model\User::setSelectedAddressId ( $sAddressId )

Selected user address setter

Parameters

string $sAddressId selected address id

◆ setUpdateKey()

OxidEsales\EshopCommunity\Application\Model\User::setUpdateKey ( $blReset = false )

Generates or resets and saves users update key

Parameters

bool $blReset marker to reset update info

◆ updateGetOrdersQuery()

OxidEsales\EshopCommunity\Application\Model\User::updateGetOrdersQuery ( $query )

protected

Updates query for selecting orders.

Parameters

string $query

Returns: string

◆ updateInvitationStatistics()

OxidEsales\EshopCommunity\Application\Model\User::updateInvitationStatistics ( $aRecEmail )

Updating invitations statistics

Parameters

array $aRecEmail array of recipients emails

Member Data Documentation

◆ $_aAddresses

OxidEsales\EshopCommunity\Application\Model\User::$_aAddresses = []

protected

◆ $_aBaskets

OxidEsales\EshopCommunity\Application\Model\User::$_aBaskets = []

protected

◆ $_aUserCookie

OxidEsales\EshopCommunity\Application\Model\User::$_aUserCookie = []

staticprotected

◆ $_blDisableShopCheck

OxidEsales\EshopCommunity\Application\Model\User::$_blDisableShopCheck = true

protected

◆ $_blLoadedFromCookie

OxidEsales\EshopCommunity\Application\Model\User::$_blLoadedFromCookie = null

protected

◆ $_blMallUsers

OxidEsales\EshopCommunity\Application\Model\User::$_blMallUsers = false

protected

◆ $_iCntNoticeListArticles

OxidEsales\EshopCommunity\Application\Model\User::$_iCntNoticeListArticles = null

protected

◆ $_iCntRecommLists

OxidEsales\EshopCommunity\Application\Model\User::$_iCntRecommLists = null

protected

◆ $_iCntWishListArticles

OxidEsales\EshopCommunity\Application\Model\User::$_iCntWishListArticles = null

protected

◆ $_oGroups

OxidEsales\EshopCommunity\Application\Model\User::$_oGroups

protected

◆ $_oNewsSubscription

OxidEsales\EshopCommunity\Application\Model\User::$_oNewsSubscription = null

protected

◆ $_oPayments

OxidEsales\EshopCommunity\Application\Model\User::$_oPayments

protected

◆ $_oRecommList

OxidEsales\EshopCommunity\Application\Model\User::$_oRecommList

protected

◆ $_oSelAddress

OxidEsales\EshopCommunity\Application\Model\User::$_oSelAddress = null

protected

◆ $_oStateObject

OxidEsales\EshopCommunity\Application\Model\User::$_oStateObject = null

protected

◆ $_oUserCountryTitle

OxidEsales\EshopCommunity\Application\Model\User::$_oUserCountryTitle = null

protected

◆ $_sClassName

OxidEsales\EshopCommunity\Application\Model\User::$_sClassName = 'oxuser'

protected

◆ $_sSelAddressId

OxidEsales\EshopCommunity\Application\Model\User::$_sSelAddressId = null

protected

◆ $_sUpdateKey

OxidEsales\EshopCommunity\Application\Model\User::$_sUpdateKey = null

protected

◆ $_sWishId

OxidEsales\EshopCommunity\Application\Model\User::$_sWishId = null

protected

◆ $isOutdatedPasswordHashAlgorithmUsed

OxidEsales\EshopCommunity\Application\Model\User::$isOutdatedPasswordHashAlgorithmUsed = false

private

◆ USER_COOKIE_SALT

const OxidEsales\EshopCommunity\Application\Model\User::USER_COOKIE_SALT = 'user_cookie_salt'

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

/oxideshop-ce/source/Application/Model/User.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __get()

◆ _assignAddress()

◆ _dbLogin()

◆ _getCookieUserId()

◆ _getDemoShopLoginQuery()

◆ _getLoginQuery()

◆ _getLoginQueryHashedWithMD5()

◆ _getMergedAddressFields()

◆ _getShopSelect()

◆ _getStateObject()

◆ _getUserRights()

◆ _getWishListId()

◆ _insert()

◆ _isDemoShop()

◆ _ldapLogin()

◆ _setAutoGroups()

◆ _update()

◆ acceptTerms()

◆ addToGroup()

◆ allowDerivedUpdate()

◆ changeUserData()

◆ checkIfEmailExists()

◆ checkValues()

◆ convertBirthday()

◆ createUser()

◆ delete()

◆ deleteAcceptedTerms()

◆ deleteAdditionally()

◆ deleteAddresses()

◆ deleteBaskets()

◆ deleteDeliveries()

◆ deleteDiscounts()

◆ deleteItemById()

◆ deleteNewsletterSubscriptions()

◆ deleteNotOrderRelatedRemarks()

◆ deletePriceAlarms()

◆ deleteRatings()

◆ deleteRecommendationLists()

◆ deleteReviews()

◆ deleteUserFromGroups()

◆ encodePassword()

◆ exists()

◆ formQueryPartForActiveUser()

◆ formQueryPartForAdminView()

◆ formQueryPartForMD5Password()

◆ formQueryPartForSha512Password()

◆ formQueryPartForUserName()

◆ formUserCookieQuery()

◆ getActiveCountry()

◆ getAuthenticatedUserId()

◆ getBasket()

◆ getBoni()

◆ getEncodedDeliveryAddress()

◆ getIdByUserName()

◆ getNewsSubscription()

◆ getNoticeListArtCnt()

◆ getOrderCount()

◆ getOrders()

◆ getPasswordHashFromDatabase()

◆ getRecommListsCount()

◆ getReviewUserHash()

◆ getReviewUserId()

◆ getSelectedAddress()

◆ getSelectedAddressId()

◆ getStateId()

◆ getStateTitle()

◆ getUpdateId()

◆ getUpdateLinkTerm()

◆ getUserAddresses()