BxBaseServiceAccount Class Reference

Inheritance diagram for BxBaseServiceAccount:

Public Member Functions
	serviceCreateAccountForm ($aParams=array())
	serviceAccountSettingsEmail ($iAccountId=false)
	serviceAccountSettingsPassword ($iAccountId=false)
	serviceAccountSettingsInfo ($iAccountId=false)
	serviceAccountSettingsDelAccount ($iAccountId=false)
	serviceUnsubscribeNews ()
	serviceUnsubscribeNotifications ()
	serviceGetConfirmationTypes ()
	serviceEmailConfirmation ($sMsg=false)
	servicePhoneConfirmation ($sMsg=false)
	confirmEmail ($sKey)
	serviceConfirmEmail ($sKey)
	serviceGetOptionsResetPasswordRedirect ()
	serviceGetOptionsSwitchToProfileRedirect ()
	serviceGetOptionsPruningInterval ()
	serviceForgotPassword ()
	serviceSwitchProfile ($iSwitchToProfileId)
	resetPassword ()
	generateUserNewPwd ($iAccountId)

Protected Member Functions
	_unsubscribeForm ($sDisplay)
	_confirmEmail ($sKey)

Protected Attributes
	$_oAccountForms
	$_oAccountQuery

Detailed Description

System service for creating system profile functionality.

Constructor & Destructor Documentation

__construct()

BxBaseServiceAccount::__construct

(

)

Reimplemented from BxDol.

Member Function Documentation

confirmEmail()

BxBaseServiceAccount::confirmEmail

(

$sKey

)

Perform email confirmation

Hooks:

'account', 'after_email_confirmation' - hook after email confirmed

• $unit_name - equals account
• $action - equals after_email_confirmation
• $object_id - account id
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • override_result - [string] by ref, url for redirect after email confirmed, can be overridden in hook processing

    HOOKS

    'account', 'after_email_confirmation' - hook after email confirmed

generateUserNewPwd()

BxBaseServiceAccount::generateUserNewPwd

(

$iAccountId

)

Generate new password.

Hooks:

'account', 'edited' - hook on account edited $oAccount->updatePassword

• $unit_name - equals account
• $action - equals edited
• $object_id - account id
• $sender_id - account id
• $extra_params - array of additional params with the following array keys:
  • action - [string] can be forgot_password/change_password or $sDisplayName (display name for current form)

    HOOKS

    'account', 'edited' - hook on account edited $oAccount->updatePassword

resetPassword()

BxBaseServiceAccount::resetPassword

(

)

Reset password procedure

serviceCreateAccountForm()

BxBaseServiceAccount::serviceCreateAccountForm

(

$aParams = array()

)

create_account_form

serviceEmailConfirmation()

BxBaseServiceAccount::serviceEmailConfirmation

(

$sMsg = false

)

Display email confirmation form, if confirmation code is provided then try to confirm profile

serviceForgotPassword()

BxBaseServiceAccount::serviceForgotPassword

(

)

forgot_password

Hooks:

'account', 'before_forgot_password_send_sms' - hook in $oAccount->isConfirmed check

• $unit_name - equals account
• $action - equals before_forgot_password_send_sms
• $object_id - account id
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • phone_number - [string] by ref, phone number to send sms, can be overridden in hook processing
  • sms_text - [string] by ref, text for sms, can be overridden in hook processing
  • override_result - [mixed] by ref, can be object, can be overridden in hook processing

    HOOKS

    'account', 'before_forgot_password_send_sms' - hook in $oAccount->isConfirmed check

serviceGetConfirmationTypes()

BxBaseServiceAccount::serviceGetConfirmationTypes

(

)

Display confirmation statuses list

servicePhoneConfirmation()

BxBaseServiceAccount::servicePhoneConfirmation

(

$sMsg = false

)

Display phone confirmation forms, if confirmation code is provided then try to confirm profile

Hooks:

'account', 'before_confirm_phone_send_sms' - hook in confirm phone

• $unit_name - equals account
• $action - equals before_confirm_phone_send_sms
• $object_id - account id
• $sender_id - logged profile_id
• $extra_params - array of additional params with the following array keys:
  • phone_number - [string] by ref, phone number to send sms, can be overridden in hook processing
  • sms_text - [string] by ref, text for sms, can be overridden in hook processing
  • override_result - [mixed] by ref, can be object, can be overridden in hook processing

    HOOKS

    'account', 'before_confirm_phone_send_sms' - hook in confirm phone

serviceSwitchProfile()

BxBaseServiceAccount::serviceSwitchProfile

(

$iSwitchToProfileId

)

switch_profile

Hooks:

'account', 'check_switch_context' - hook on switch profile

• $unit_name - equals account
• $action - equals check_switch_context
• $object_id - account id
• $sender_id - viewer profile_id
• $extra_params - array of additional params with the following array keys:
  • switch_to_profile - [int] profile_id to switch
  • viewer_account - [int] viewer's profile_id, can be overridden in hook processing
  • override_result - [bool] by ref, true if allow switch profile, otherwise false, can be overridden in hook processing

    HOOKS

    'account', 'check_switch_context' - hook on switch profile

serviceUnsubscribeNews()

BxBaseServiceAccount::serviceUnsubscribeNews

(

)

Display unsubscribe from newsletters form

serviceUnsubscribeNotifications()

BxBaseServiceAccount::serviceUnsubscribeNotifications

(

)

Display unsubscribe from notifications form

---

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

• template/scripts/BxBaseServiceAccount.php