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 () | |
Protected Member Functions | |
_getWishListId () | |
_getMergedAddressFields () | |
_assignAddress ($aDelAddress) | |
_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) | |
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() |
User manager. Performs user managing function, as assigning to groups, updating information, deletion and other.
Definition at line 9 of file oxuser.php.
oxUser.__construct | ( | ) |
Class constructor, initiates parent constructor (parent.oxBase()).
Reimplemented from oxBase.
Definition at line 146 of file oxuser.php.
oxUser.__get | ( | $ | sParamName | ) |
Getter for special not frequently used fields
string | $sParamName name of parameter to get value |
Reimplemented from oxBase.
Definition at line 173 of file oxuser.php.
oxUser._assignAddress | ( | $ | aDelAddress | ) | [protected] |
creates new address entry or updates existing
array | $aDelAddress address data array |
Definition at line 1221 of file oxuser.php.
oxUser._checkCountries | ( | $ | aInvAddress, | |
$ | aDelAddress | |||
) | [protected] |
Checks if user defined countries (billing and delivery) are active
array | $aInvAddress billing address info | |
array | $aDelAddress delivery address info |
use oxInputValidator.checkCountries() instead
Definition at line 1874 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.
string | $sEmail user email/login |
use oxInputValidator.checkEmail() instead
Definition at line 1842 of file oxuser.php.
oxUser._checkLogin | ( | $ | sLogin, | |
$ | aInvAddress | |||
) | [protected] |
Checks if user name does not break logics:
string | $sLogin user preferred login name | |
array | $aInvAddress user information |
use oxInputValidator.checkLogin() instead
Definition at line 1719 of file oxuser.php.
oxUser._checkRequiredArrayFields | ( | $ | sFieldName, | |
$ | aFieldValues | |||
) | [protected] |
Checks if all values are filled up
string | $sFieldName checking field name | |
array | $aFieldValues field values |
use oxInputValidator.checkRequiredArrayFields() instead
Definition at line 1905 of file oxuser.php.
oxUser._checkRequiredFields | ( | $ | aInvAddress, | |
$ | aDelAddress | |||
) | [protected] |
Checking if all required fields were filled. In case of error exception is thrown
array | $aInvAddress billing address | |
array | $aDelAddress delivery address |
use oxInputValidator.checkRequiredFields() instead
Definition at line 1890 of file oxuser.php.
oxUser._checkVatId | ( | $ | aInvAddress | ) | [protected] |
Checks if user passed VAT id is valid. Exception is thrown if id is not valid
array | $aInvAddress user input array |
use oxInputValidator.checkVatId() instead
Definition at line 1920 of file oxuser.php.
oxUser._getCookieUserId | ( | ) | [protected] |
Checks if user is connected via cookies and if so, returns user id.
Definition at line 1516 of file oxuser.php.
oxUser._getFacebookUserId | ( | ) | [protected] |
Checks if user is connected via Facebook connect and if so, returns user id.
Definition at line 1495 of file oxuser.php.
oxUser._getLoginQuery | ( | $ | sUser, | |
$ | sPassword, | |||
$ | sShopID, | |||
$ | blAdmin | |||
) | [protected] |
Builds and returns user login query
string | $sUser login name | |
string | $sPassword login password | |
string | $sShopID shopid | |
bool | $blAdmin admin/non admin mode |
Definition at line 1257 of file oxuser.php.
oxUser._getMergedAddressFields | ( | ) | [protected] |
oxUser._getShopSelect | ( | $ | myConfig, | |
$ | sShopID, | |||
$ | blAdmin | |||
) | [protected] |
Returns shopselect part of login query sql
object | $myConfig shop config | |
string | $sShopID shopid | |
bool | $blAdmin admin/non admin mode |
Definition at line 1302 of file oxuser.php.
oxUser._getUserRights | ( | ) | [protected] |
Returns user rights index. Index cannot be higher than current session user rights index.
Definition at line 1620 of file oxuser.php.
oxUser._getWishListId | ( | ) | [protected] |
Checks if product from wishlist is added
Definition at line 371 of file oxuser.php.
oxUser._insert | ( | ) | [protected] |
Inserts user object data to DB. Returns true on success.
Reimplemented from oxBase.
Definition at line 1664 of file oxuser.php.
oxUser._ldapLogin | ( | $ | sUser, | |
$ | sPassword, | |||
$ | sShopID, | |||
$ | sShopSelect | |||
) | [protected] |
oxUser._loadSavedUserBasketAfterLogin | ( | ) | [protected] |
Load saved user basket from the database after he logs in
Definition at line 1319 of file oxuser.php.
oxUser._setAutoGroups | ( | $ | sCountryId | ) | [protected] |
Automatically assigns user to specific groups according to users country information
string | $sCountryId users country id |
Definition at line 1933 of file oxuser.php.
oxUser._update | ( | ) | [protected] |
Updates changed user object data to DB. Returns true on success.
Definition at line 1682 of file oxuser.php.
oxUser.acceptTerms | ( | ) |
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.
string | $sDynGoup deny group (oxSession.getVar( 'dgr' )) | |
array | $aDeniedDynGroups ($myConfig->getConfigParam( 'aDeniedDynGroups' )) |
Definition at line 1016 of file oxuser.php.
oxUser.addToGroup | ( | $ | sGroupID | ) |
Adds user to the group
string | $sGroupID group id |
Definition at line 832 of file oxuser.php.
oxUser.allowDerivedUpdate | ( | ) |
Overrides parent isDerived check and returns true
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.
string | $sUser user login name | |
string | $sPassword user password | |
string | $sPassword2 user confirmation password | |
array | $aInvAddress user billing address | |
array | $aDelAddress delivery address |
oxUserException,oxInputException,oxConnectionException |
Definition at line 1157 of file oxuser.php.
oxUser.checkIfEmailExists | ( | $ | sEmail | ) |
Checks for already used email
string | $sEmail user email/login |
Definition at line 1733 of file oxuser.php.
oxUser.checkPassword | ( | $ | sNewPass, | |
$ | sConfPass, | |||
$ | blCheckLenght = false | |||
) |
Checking if user password is fine. In case of error exception is thrown
string | $sNewPass new user password | |
string | $sConfPass retyped user password | |
bool | $blCheckLenght option to check password lenght |
use oxInputValidator.checkPassword() instead
Definition at line 1859 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
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 |
oxUserException,oxInputException |
Definition at line 1061 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
array | $aData dirthday data |
Definition at line 946 of file oxuser.php.
oxUser.createUser | ( | ) |
Inserts new or updates existing user
oxUserException | exception |
Definition at line 784 of file oxuser.php.
oxUser.decodeSalt | ( | $ | sSaltHex | ) |
Returns plains password salt representation
string | $sSaltHex heximal representation of password salt value |
Definition at line 2085 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.
string | $sOXID object ID (default null) |
Reimplemented from oxBase.
Definition at line 543 of file oxuser.php.
oxUser.encodePassword | ( | $ | sPassword, | |
$ | sSalt | |||
) |
Encodes and returns given password
string | $sPassword password to encode | |
string | $sSalt any unique string value |
Definition at line 2060 of file oxuser.php.
oxUser.exists | ( | $ | sOXID = null |
) |
Checks if user exists in database.
string | $sOXID object ID (default null) |
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.
Definition at line 757 of file oxuser.php.
oxUser.getBasket | ( | $ | sName | ) |
Returns notice, wishlist or saved basket object
string | $sName name/type of basket |
Definition at line 917 of file oxuser.php.
oxUser.getBoni | ( | ) |
Return standart credit rating, can be set in config option iCreditRating;
Definition at line 995 of file oxuser.php.
oxUser.getEncodedDeliveryAddress | ( | ) |
oxUser.getIdByUserName | ( | $ | sUserName | ) |
retruns user id by user name
string | $sUserName user name |
Definition at line 2318 of file oxuser.php.
oxUser.getNewsSubscription | ( | ) |
Returns user newsletter subscription controller object
Definition at line 212 of file oxuser.php.
oxUser.getNoticeListArtCnt | ( | ) |
oxUser.getOrderCount | ( | ) |
oxUser.getOrders | ( | $ | iLimit = false , |
|
$ | iPage = 0 | |||
) |
Returns object with ordering information (order articles list).
int | $iLimit how many entries to load | |
int | $iPage which page to start |
Definition at line 663 of file oxuser.php.
oxUser.getPasswordHash | ( | ) |
Returns password hash. In case password in db is plain or decodable password is processed and hash returned
Definition at line 2137 of file oxuser.php.
oxUser.getRecommListsCount | ( | $ | sOx = null |
) |
Returns recommlist count
string | $sOx object ID (default is null) |
Definition at line 1816 of file oxuser.php.
oxUser.getReviewUserHash | ( | $ | sUserId | ) |
Generates user password and username hash for review
string | $sUserId userid |
Definition at line 2160 of file oxuser.php.
oxUser.getReviewUserId | ( | $ | sReviewUserHash | ) |
Gets from review user hash user id
string | $sReviewUserHash review user hash |
Definition at line 2174 of file oxuser.php.
oxUser.getSelectedAddress | ( | $ | sWishId = false |
) |
Sets in the array oxuser._aAddresses selected address. Returns user selected Address id.
bool | $sWishId wishlist user id |
Definition at line 393 of file oxuser.php.
oxUser.getSelectedAddressId | ( | ) |
Returns user chosen address id ("oxaddressid" or "deladrid")
Definition at line 353 of file oxuser.php.
oxUser.getState | ( | ) |
Returns string representation of user state
Definition at line 2186 of file oxuser.php.
oxUser.getUpdateId | ( | ) |
oxUser.getUpdateLinkTerm | ( | ) |
Return password update link validity term (seconds). Default 3600 * 6
Definition at line 2019 of file oxuser.php.
oxUser.getUserAddresses | ( | $ | sUserId = null |
) |
Returns user defined Address list object
string | $sUserId object ID (default is null) |
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)
string | $sCountryId country id (optional) | |
int | $iLang active language (optional) |
Definition at line 245 of file oxuser.php.
oxUser.getUserCountryId | ( | $ | sCountry = null |
) |
Returns user countryid according to passed name
string | $sCountry country |
Definition at line 270 of file oxuser.php.
oxUser.getUserGroups | ( | $ | sOXID = null |
) |
Returns assigned user groups list object
string | $sOXID object ID (default is null) |
Definition at line 286 of file oxuser.php.
oxUser.getUserPayments | ( | $ | sOXID = null |
) |
Returns user payment history list object
string | $sOXID object ID (default is null) |
Definition at line 438 of file oxuser.php.
oxUser.getUserRecommLists | ( | $ | sOXID = null |
) |
Returns user recommendation list object
string | $sOXID object ID (default is null) |
Definition at line 1785 of file oxuser.php.
oxUser.getWishListArtCnt | ( | ) |
oxUser.hasAccount | ( | ) |
returns true if user registered and have account
Definition at line 2335 of file oxuser.php.
oxUser.inGroup | ( | $ | sGroupID | ) |
Checks if this object is in group, returns true on success.
string | $sGroupID user group ID |
Definition at line 525 of file oxuser.php.
oxUser.isExpiredUpdateId | ( | $ | sKey | ) |
Checks if password update key is not expired yet
string | $sKey key |
Definition at line 2031 of file oxuser.php.
oxUser.isLoadedFromCookie | ( | ) |
oxUser.isPriceViewModeNetto | ( | ) |
Return user price view mode, true - if netto mode
Definition at line 2347 of file oxuser.php.
oxUser.isSamePassword | ( | $ | sNewPass | ) |
Checks if user entered password is the same as old
string | $sNewPass new password |
Definition at line 2116 of file oxuser.php.
oxUser.isTermsAccepted | ( | ) |
Checks if user accepted latest shopping terms and conditions version
Definition at line 2196 of file oxuser.php.
oxUser.load | ( | $ | oxID | ) |
Loads object (user) details from DB. Returns true on success.
string | $oxID User ID |
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.
bool | $blForceAdmin (default false) |
Definition at line 1443 of file oxuser.php.
oxUser.loadAdminUser | ( | ) |
Loads active admin user object (if possible). If user is not available - returns false.
Definition at line 1430 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
string | $sUid update id |
Definition at line 1983 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.
string | $sUser User username | |
string | $sPassword User password | |
bool | $blCookie (default false) |
oxConnectionException,oxCookieException,oxUserException |
Definition at line 1346 of file oxuser.php.
oxUser.logout | ( | ) |
Logs out session user. Returns true on success
Definition at line 1405 of file oxuser.php.
oxUser.onOrderExecute | ( | $ | oBasket, | |
$ | iSuccess | |||
) |
Called after saving an order.
object | $oBasket Shopping basket object | |
int | $iSuccess order success status |
Definition at line 880 of file oxuser.php.
oxUser.prepareSalt | ( | $ | sSalt | ) |
Returns safe salt value (heximal representation)
string | $sSalt any unique string value |
Definition at line 2073 of file oxuser.php.
oxUser.removeFromGroup | ( | $ | sGroupID = null |
) |
Removes user from passed user group.
string | $sGroupID group id |
Definition at line 857 of file oxuser.php.
oxUser.save | ( | ) |
Saves (updates) user object data information in DB. Return true on success.
Reimplemented from oxBase.
Definition at line 467 of file oxuser.php.
oxUser.setCreditPointsForInviter | ( | ) |
oxUser.setCreditPointsForRegistrant | ( | $ | sUserId, | |
$ | sRecEmail | |||
) |
Assigns registration points for invited user and its inviter (calls oxUser.setInvitationCreditPoints())
string | $sUserId inviter user id | |
string | $sRecEmail recipient (registrant) email |
Definition at line 2228 of file oxuser.php.
oxUser.setMallUsersStatus | ( | $ | blOn = false |
) |
Sets mall user status
bool | $blOn mall users is on or off |
Definition at line 161 of file oxuser.php.
oxUser.setNewsSubscription | ( | $ | blSubscribe, | |
$ | blSendOptIn, | |||
$ | blForceCheckOptIn = false | |||
) |
Sets newsletter subscription status to user
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 |
Definition at line 1097 of file oxuser.php.
oxUser.setPassword | ( | $ | sPassword = null |
) |
Sets new password for user ( save is not called)
string | $sPassword password |
Definition at line 2097 of file oxuser.php.
oxUser.setSelectedAddressId | ( | $ | sAddressId | ) |
Selected user address setter
string | $sAddressId selected address id |
Definition at line 343 of file oxuser.php.
oxUser.setUpdateKey | ( | $ | blReset = false |
) |
Generates or resets and saves users update key
bool | $blReset marker to reset update info |
Definition at line 1999 of file oxuser.php.
oxUser.updateFbId | ( | ) |
oxUser.updateInvitationStatistics | ( | $ | aRecEmail | ) |
Updating invitations statistics
array | $aRecEmail array of recipients emails |
Definition at line 2295 of file oxuser.php.
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() [static, protected] |
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] |
Reimplemented from oxBase.
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.