CustomerAuthController
extends Controller
in package
Customer authentication controller for storefront register/login/logout.
Tags
Table of Contents
Properties
- $layout : string
Methods
- forgotPassword() : void
- Process the forgot password request and send reset email.
- forgotPasswordForm() : void
- Show the forgot password form.
- login() : void
- Process customer login.
- loginForm() : void
- Show the customer login form.
- logout() : void
- Log out the customer.
- register() : void
- Process customer registration.
- registerForm() : void
- Show the customer registration form.
- resetPassword() : void
- Process the password reset.
- resetPasswordForm() : void
- Show the reset password form.
- baseUrl() : string
- Get the base URL for the application.
- buildPagination() : array<string|int, mixed>
- Build pagination metadata for views.
- clearOldInput() : void
- Clear stored old input data.
- flash() : void
- Set a flash message in the session.
- flashOldInput() : void
- Store current POST data as old input for form repopulation.
- getPage() : int
- Get the current page number from the query string.
- json() : void
- Send a JSON response.
- old() : mixed
- Get previous form input after validation failure.
- redirect() : void
- Send an HTTP redirect.
- requirePermission() : void
- Require that the authenticated client user has a specific permission.
- url() : string
- Generate a full URL for a given path.
- view() : void
- Render a view template wrapped in a layout.
- loadBusiness() : array<string|int, mixed>|null
- Load and validate a business by slug.
- validateRegistration() : array<string|int, mixed>
- Validate registration form input.
Properties
$layout
protected
string
$layout
= 'storefront'
Layout for storefront pages
Methods
forgotPassword()
Process the forgot password request and send reset email.
public
forgotPassword(string $slug) : void
Parameters
- $slug : string
-
Business URL slug
forgotPasswordForm()
Show the forgot password form.
public
forgotPasswordForm(string $slug) : void
Parameters
- $slug : string
-
Business URL slug
login()
Process customer login.
public
login(string $slug) : void
Parameters
- $slug : string
-
Business URL slug
loginForm()
Show the customer login form.
public
loginForm(string $slug) : void
Parameters
- $slug : string
-
Business URL slug
logout()
Log out the customer.
public
logout(string $slug) : void
Parameters
- $slug : string
-
Business URL slug
register()
Process customer registration.
public
register(string $slug) : void
Parameters
- $slug : string
-
Business URL slug
registerForm()
Show the customer registration form.
public
registerForm(string $slug) : void
Parameters
- $slug : string
-
Business URL slug
resetPassword()
Process the password reset.
public
resetPassword(string $slug) : void
Parameters
- $slug : string
-
Business URL slug
resetPasswordForm()
Show the reset password form.
public
resetPasswordForm(string $slug) : void
Parameters
- $slug : string
-
Business URL slug
baseUrl()
Get the base URL for the application.
protected
baseUrl() : string
Return values
stringbuildPagination()
Build pagination metadata for views.
protected
buildPagination(int $total, int $page, int $perPage, string $baseUrl) : array<string|int, mixed>
Parameters
- $total : int
-
Total record count
- $page : int
-
Current page number
- $perPage : int
-
Records per page
- $baseUrl : string
-
Base URL path (e.g., "client/orders")
Return values
array<string|int, mixed> —Pagination metadata
clearOldInput()
Clear stored old input data.
protected
clearOldInput() : void
flash()
Set a flash message in the session.
protected
flash(string $key, string $message) : void
Parameters
- $key : string
-
Flash message key (e.g., "success", "error")
- $message : string
-
The message text
flashOldInput()
Store current POST data as old input for form repopulation.
protected
flashOldInput() : void
getPage()
Get the current page number from the query string.
protected
getPage() : int
Return values
int —Page number (minimum 1)
json()
Send a JSON response.
protected
json(mixed $data[, int $status = 200 ]) : void
Parameters
- $data : mixed
-
Data to encode as JSON
- $status : int = 200
-
HTTP status code
old()
Get previous form input after validation failure.
protected
old(string $field[, mixed $default = '' ]) : mixed
Parameters
- $field : string
-
The form field name
- $default : mixed = ''
-
Default value if not found
redirect()
Send an HTTP redirect.
protected
redirect(string $url) : void
Parameters
- $url : string
-
The URL to redirect to
requirePermission()
Require that the authenticated client user has a specific permission.
protected
requirePermission(string $permission) : void
Redirects to the client dashboard with an error flash if denied.
Parameters
- $permission : string
-
Permission key (e.g., 'menu_manage')
url()
Generate a full URL for a given path.
protected
url([string $path = '' ]) : string
Parameters
- $path : string = ''
-
The path to append to the base URL
Return values
stringview()
Render a view template wrapped in a layout.
protected
view(string $template[, array<string|int, mixed> $data = [] ]) : void
Parameters
- $template : string
-
Path to view relative to app/Views/ (e.g., "admin/dashboard")
- $data : array<string|int, mixed> = []
-
Variables to extract into the view scope
loadBusiness()
Load and validate a business by slug.
private
loadBusiness(string $slug) : array<string|int, mixed>|null
Parameters
- $slug : string
-
Business URL slug
Return values
array<string|int, mixed>|nullvalidateRegistration()
Validate registration form input.
private
validateRegistration() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of error messages