Buffalo Eats Online API Documentation

ThemeController extends Controller
in package

Client theme management controller.

Allows restaurant owners to select, customize, and preview storefront themes for their business.

Tags
author

J.J. Johnson visionquest716@gmail.com

copyright

2026 VisionQuestServices LLC

Table of Contents

Properties

$layout  : string

Methods

applyPreview()  : void
Apply a previewed theme.
customize()  : void
Show the customization form.
index()  : void
Show the theme gallery with current selection.
preview()  : void
Preview a theme on the storefront.
saveCustomizations()  : void
Save theme customizations.
select()  : void
Apply a theme selection.
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.
deleteBannerFile()  : void
Delete existing banner file for a business.
processBannerUpload()  : array{success: bool, banner_path?: string, error?: string}
Process a banner image upload.

Properties

Methods

applyPreview()

Apply a previewed theme.

public applyPreview() : void

index()

Show the theme gallery with current selection.

public index() : void

preview()

Preview a theme on the storefront.

public preview(string $themeId) : void
Parameters
$themeId : string

Theme ID to preview

saveCustomizations()

Save theme customizations.

public saveCustomizations() : void

baseUrl()

Get the base URL for the application.

protected baseUrl() : string
Return values
string

buildPagination()

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
string

view()

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

deleteBannerFile()

Delete existing banner file for a business.

private deleteBannerFile(array<string|int, mixed> $business) : void
Parameters
$business : array<string|int, mixed>

Business record

processBannerUpload()

Process a banner image upload.

private processBannerUpload(array<string|int, mixed> $file, array<string|int, mixed> $business) : array{success: bool, banner_path?: string, error?: string}
Parameters
$file : array<string|int, mixed>

Uploaded file ($_FILES entry)

$business : array<string|int, mixed>

Business record

Return values
array{success: bool, banner_path?: string, error?: string}

        
On this page

Search results