Buffalo Eats Online API Documentation

CartController extends Controller
in package

Shopping cart controller for storefront.

Tags
author

J.J. Johnson visionquest716@gmail.com

copyright

2026 VisionQuestServices LLC

Table of Contents

Properties

$layout  : string
$cartService  : CartService

Methods

__construct()  : mixed
Initialize the cart controller.
add()  : void
Add an item to the cart.
index()  : void
Display the cart page.
remove()  : void
Remove an item from the cart.
summary()  : void
AJAX endpoint: return cart count and total for header updates.
update()  : void
Update cart item quantities.
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.

Properties

$layout

protected string $layout = 'storefront'

Layout for storefront pages

Methods

__construct()

Initialize the cart controller.

public __construct() : mixed

add()

Add an item to the cart.

public add(string $slug) : void
Parameters
$slug : string

Business URL slug

index()

Display the cart page.

public index(string $slug) : void
Parameters
$slug : string

Business URL slug

remove()

Remove an item from the cart.

public remove(string $slug) : void
Parameters
$slug : string

Business URL slug

summary()

AJAX endpoint: return cart count and total for header updates.

public summary(string $slug) : void
Parameters
$slug : string

Business URL slug

update()

Update cart item quantities.

public update(string $slug) : void
Parameters
$slug : string

Business URL slug

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

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>|null

        
On this page

Search results