PHP Class BookStack\Http\Controllers\Auth\RegisterController

Inheritance: extends BookStack\Http\Controllers\Controller, use trait Illuminate\Foundation\Auth\RegistersUsers
Datei anzeigen Open project: ssddanbrown/bookstack

Protected Properties

Property Type Description
$emailConfirmationService
$redirectPath
$redirectTo string Where to redirect users after login / registration.
$socialAuthService
$userRepo

Public Methods

Method Description
__construct ( SocialAuthService $socialAuthService, EmailConfirmationService $emailConfirmationService, UserRepo $userRepo ) Create a new controller instance.
confirmEmail ( $token ) : Illuminate\Http\RedirectResponse | Redirector Confirms an email via a token and logs the user into the system.
detachSocialAccount ( $socialDriver ) : Illuminate\Http\RedirectResponse | Redirector Detach a social account from a user.
getRegister ( ) : Illuminate\Http\Response Show the application registration form.
getRegisterConfirmation ( ) Show the page to tell the user to check their email and confirm their address.
postRegister ( Illuminate\Http\Request $request ) : Illuminate\Http\Response Handle a registration request for the application.
resendConfirmation ( Illuminate\Http\Request $request ) : Illuminate\View\View Resend the confirmation email
showAwaitingConfirmation ( ) : Illuminate\View\View Shows a notice that a user's email address has not been confirmed, Also has the option to re-send the confirmation email.
socialCallback ( $socialDriver ) : Illuminate\Http\RedirectResponse | Redirector The callback for social login services.
socialRegister ( $socialDriver ) : mixed Redirect to the social site for authentication intended to register.

Protected Methods

Method Description
checkRegistrationAllowed ( ) Check whether or not registrations are allowed in the app settings.
create ( array $data ) : User Create a new user instance after a valid registration.
registerUser ( array $userData, boolean | false | SocialAccount $socialAccount = false ) : Illuminate\Http\RedirectResponse | Redirector The registrations flow for all users.
socialRegisterCallback ( $socialDriver ) : Illuminate\Http\RedirectResponse | Redirector Register a new user after a registration callback.
validator ( array $data ) : Illuminate\Contracts\Validation\Validator Get a validator for an incoming registration request.

Method Details

__construct() public method

Create a new controller instance.
public __construct ( SocialAuthService $socialAuthService, EmailConfirmationService $emailConfirmationService, UserRepo $userRepo )
$socialAuthService BookStack\Services\SocialAuthService
$emailConfirmationService BookStack\Services\EmailConfirmationService
$userRepo BookStack\Repos\UserRepo

checkRegistrationAllowed() protected method

Check whether or not registrations are allowed in the app settings.
protected checkRegistrationAllowed ( )

confirmEmail() public method

Confirms an email via a token and logs the user into the system.
public confirmEmail ( $token ) : Illuminate\Http\RedirectResponse | Redirector
$token
return Illuminate\Http\RedirectResponse | Illuminate\Routing\Redirector

create() protected method

Create a new user instance after a valid registration.
protected create ( array $data ) : User
$data array
return BookStack\User

detachSocialAccount() public method

Detach a social account from a user.
public detachSocialAccount ( $socialDriver ) : Illuminate\Http\RedirectResponse | Redirector
$socialDriver
return Illuminate\Http\RedirectResponse | Illuminate\Routing\Redirector

getRegister() public method

Show the application registration form.
public getRegister ( ) : Illuminate\Http\Response
return Illuminate\Http\Response

getRegisterConfirmation() public method

Show the page to tell the user to check their email and confirm their address.
public getRegisterConfirmation ( )

postRegister() public method

Handle a registration request for the application.
public postRegister ( Illuminate\Http\Request $request ) : Illuminate\Http\Response
$request Illuminate\Http\Request
return Illuminate\Http\Response

registerUser() protected method

The registrations flow for all users.
protected registerUser ( array $userData, boolean | false | SocialAccount $socialAccount = false ) : Illuminate\Http\RedirectResponse | Redirector
$userData array
$socialAccount boolean | false | SocialAccount
return Illuminate\Http\RedirectResponse | Illuminate\Routing\Redirector

resendConfirmation() public method

Resend the confirmation email
public resendConfirmation ( Illuminate\Http\Request $request ) : Illuminate\View\View
$request Illuminate\Http\Request
return Illuminate\View\View

showAwaitingConfirmation() public method

Shows a notice that a user's email address has not been confirmed, Also has the option to re-send the confirmation email.
public showAwaitingConfirmation ( ) : Illuminate\View\View
return Illuminate\View\View

socialCallback() public method

The callback for social login services.
public socialCallback ( $socialDriver ) : Illuminate\Http\RedirectResponse | Redirector
$socialDriver
return Illuminate\Http\RedirectResponse | Illuminate\Routing\Redirector

socialRegister() public method

Redirect to the social site for authentication intended to register.
public socialRegister ( $socialDriver ) : mixed
$socialDriver
return mixed

socialRegisterCallback() protected method

Register a new user after a registration callback.
protected socialRegisterCallback ( $socialDriver ) : Illuminate\Http\RedirectResponse | Redirector
$socialDriver
return Illuminate\Http\RedirectResponse | Illuminate\Routing\Redirector

validator() protected method

Get a validator for an incoming registration request.
protected validator ( array $data ) : Illuminate\Contracts\Validation\Validator
$data array
return Illuminate\Contracts\Validation\Validator

Property Details

$emailConfirmationService protected_oe property

protected $emailConfirmationService

$redirectPath protected_oe property

protected $redirectPath

$redirectTo protected_oe property

Where to redirect users after login / registration.
protected string $redirectTo
return string

$socialAuthService protected_oe property

protected $socialAuthService

$userRepo protected_oe property

protected $userRepo