BxBaseServiceLogin Class Reference

Inheritance diagram for BxBaseServiceLogin:

Public Member Functions
	serviceTest ($n=1)
	serviceMemberAuthCode ($aAuthTypes=array())
	serviceLoginFormOnly ($sParams='', $sForceRelocate='')
	serviceLoginForm ($sParams='', $sForceRelocate='')
	serviceLoginFormStep2 ()
	serviceLoginFormStep3 ()
	serviceLogout ()

Detailed Description

System service for login form functionality.

Constructor & Destructor Documentation

__construct()

BxBaseServiceLogin::__construct

(

)

Reimplemented from BxDol.

Member Function Documentation

serviceLoginForm()

BxBaseServiceLogin::serviceLoginForm	(		$sParams = '',
			$sForceRelocate = '' )

login_form

API

login_form

Hooks:

'profile', 'show_login_form' - hook before dhow login form

• $unit_name - equals profile
• $action - equals show_login_form
• $object_id - not used
  
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • oForm - [object] by ref, object of BxDolForm, can be overridden in hook processing
  • sParams - [string] by ref, paramenters, can be overridden in hook processing
  • sCustomHtmlBefore - [string] by ref, html before form, can be overridden in hook processing
  • sCustomHtmlAfter - [string] by ref, html after form, can be overridden in hook processing
  • aAuthTypes - [array] by ref, Auth Types, can be overridden in hook processing

HOOKS

hook-account-show_login_form

serviceLoginFormOnly()

BxBaseServiceLogin::serviceLoginFormOnly	(		$sParams = '',
			$sForceRelocate = '' )

Display login form without join text

See also

::serviceLoginForm

serviceLoginFormStep2()

BxBaseServiceLogin::serviceLoginFormStep2

(

)

Hooks:

'account', 'before_2fa_send_sms' - hook after user performed login

• $unit_name - equals system
• $action - equals before_2fa_send_sms
• $object_id - account id
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • phone_number - [array] contains account info from $oAccount->getInfo()
  • sms_text - [string] the password entered by the user
  • override_result - [string] the password after encription, to save in db

HOOKS

'account', 'before_2fa_send_sms' - hook after user performed login

serviceLoginFormStep3()

BxBaseServiceLogin::serviceLoginFormStep3

(

)

Hooks:

'account', 'login_after' - hook on after login to rewrite url for redirect after login

• $unit_name - equals account
• $action - equals login_after
• $object_id - account id
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • account - [array] contains account info from $oAccount->getInfo()
  • url_relocate - [string] by ref, rl for redirect after login, can be overridden in hook processing

HOOKS

'account', 'login_after' - hook on after login to rewrite url for redirect after login

serviceLogout()

BxBaseServiceLogin::serviceLogout

(

)

logout

API

logout

serviceMemberAuthCode()

BxBaseServiceLogin::serviceMemberAuthCode

(

$aAuthTypes = array()

)

member_auth_code

serviceTest()

BxBaseServiceLogin::serviceTest

(

$n = 1

)

test

API

test

---

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

• template/scripts/BxBaseServiceLogin.php