AdminMaintenanceController
extends Controller
in package
Admin maintenance management controller.
Manages platform-wide and per-store maintenance mode settings, scheduled maintenance windows, and advance notice configuration.
Tags
Table of Contents
Properties
- $layout : string
Methods
- cancelWindow() : void
- Cancel a scheduled maintenance window.
- createWindow() : void
- Create a scheduled maintenance window (platform-wide or per-store).
- index() : void
- Show maintenance management dashboard.
- storeMaintenanceOff() : void
- Take a specific store out of maintenance mode.
- storeMaintenanceOn() : void
- Put a specific store in maintenance mode.
- togglePlatform() : void
- Toggle platform-wide maintenance mode on/off.
- 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.
Properties
$layout
protected
string
$layout
= 'admin'
Layout for admin pages
Methods
cancelWindow()
Cancel a scheduled maintenance window.
public
cancelWindow(string $id) : void
Parameters
- $id : string
-
Window ID
createWindow()
Create a scheduled maintenance window (platform-wide or per-store).
public
createWindow() : void
index()
Show maintenance management dashboard.
public
index() : void
storeMaintenanceOff()
Take a specific store out of maintenance mode.
public
storeMaintenanceOff(string $id) : void
Parameters
- $id : string
-
Business ID
storeMaintenanceOn()
Put a specific store in maintenance mode.
public
storeMaintenanceOn(string $id) : void
Parameters
- $id : string
-
Business ID
togglePlatform()
Toggle platform-wide maintenance mode on/off.
public
togglePlatform() : void
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