Buffalo Eats Online API Documentation

Promotion extends Model
in package

Promotion model for managing sales and automatic discounts per business.

Supports item-level, category-level, and store-wide promotions with percentage or fixed-amount discounts.

Tags
author

J.J. Johnson visionquest716@gmail.com

copyright

2026 VisionQuestServices LLC

Table of Contents

Properties

$db  : PDO
$fillable  : array<string|int, mixed>
$primaryKey  : string
$table  : string

Methods

__construct()  : mixed
Initialize model with database connection.
all()  : array<string|int, mixed>
Get all records from the table.
count()  : int
Count records matching optional conditions.
countForBusiness()  : int
Count promotions for a business.
create()  : int
Create a new record.
delete()  : bool
Delete a record by primary key.
find()  : array<string|int, mixed>|null
Find a record by primary key.
findBy()  : array<string|int, mixed>|null
Find a record by a specific field value.
getActiveCategoryTargets()  : array<string|int, mixed>
Get all active category-scope promotion targets for a business.
getActiveForBusiness()  : array<string|int, mixed>
Get currently active promotions for a business.
getActiveItemTargets()  : array<string|int, mixed>
Get all active item-scope promotion targets for a business.
getCategoryIds()  : array<string|int, mixed>
Get linked category IDs for a promotion.
getDb()  : PDO
Get the underlying PDO connection.
getForBusiness()  : array<string|int, mixed>
Get all promotions for a business.
getItemIds()  : array<string|int, mixed>
Get linked menu item IDs for a promotion.
paginate()  : array<string|int, mixed>
Paginate records matching conditions.
query()  : PDOStatement
Execute a raw SQL query with parameter binding.
syncCategories()  : void
Sync linked categories for a category-scope promotion.
syncItems()  : void
Sync linked menu items for an item-scope promotion.
toggleActive()  : bool
Toggle the is_active status of a promotion.
update()  : bool
Update a record by primary key.
where()  : array<string|int, mixed>
Find records matching conditions.
filterFillable()  : array<string|int, mixed>
Filter data to only include fillable fields.

Properties

$db

protected PDO $db

Database connection

$fillable

protected array<string|int, mixed> $fillable = ['business_id', 'name', 'description', 'scope', 'discount_type', 'discount_value', 'valid_from', 'valid_until', 'is_active', 'priority', 'badge_text']

Mass-assignable fields

$primaryKey

protected string $primaryKey = 'id'

Primary key column

$table

protected string $table = 'promotions'

Database table name

Methods

__construct()

Initialize model with database connection.

public __construct() : mixed

all()

Get all records from the table.

public all([string $orderBy = 'id' ][, string $direction = 'ASC' ]) : array<string|int, mixed>
Parameters
$orderBy : string = 'id'

Column to order by

$direction : string = 'ASC'

Sort direction (ASC or DESC)

Return values
array<string|int, mixed>

count()

Count records matching optional conditions.

public count([array<string|int, mixed> $conditions = [] ]) : int
Parameters
$conditions : array<string|int, mixed> = []

Associative array of field => value pairs

Return values
int

countForBusiness()

Count promotions for a business.

public countForBusiness(int $businessId) : int
Parameters
$businessId : int

Business ID

Return values
int

create()

Create a new record.

public create(array<string|int, mixed> $data) : int
Parameters
$data : array<string|int, mixed>

Associative array of field => value pairs

Return values
int —

The ID of the newly created record

delete()

Delete a record by primary key.

public delete(int $id) : bool
Parameters
$id : int

Primary key value

Return values
bool

find()

Find a record by primary key.

public find(int $id) : array<string|int, mixed>|null
Parameters
$id : int

Primary key value

Return values
array<string|int, mixed>|null

findBy()

Find a record by a specific field value.

public findBy(string $field, mixed $value) : array<string|int, mixed>|null
Parameters
$field : string

Column name

$value : mixed

Value to match

Return values
array<string|int, mixed>|null

getActiveCategoryTargets()

Get all active category-scope promotion targets for a business.

public getActiveCategoryTargets(int $businessId) : array<string|int, mixed>
Parameters
$businessId : int

Business ID

Return values
array<string|int, mixed> —

Array of [promotion_id => [category_id, ...]]

getActiveForBusiness()

Get currently active promotions for a business.

public getActiveForBusiness(int $businessId) : array<string|int, mixed>
Parameters
$businessId : int

Business ID

Return values
array<string|int, mixed>

getActiveItemTargets()

Get all active item-scope promotion targets for a business.

public getActiveItemTargets(int $businessId) : array<string|int, mixed>
Parameters
$businessId : int

Business ID

Return values
array<string|int, mixed> —

Array of [promotion_id => [menu_item_id, ...]]

getCategoryIds()

Get linked category IDs for a promotion.

public getCategoryIds(int $promotionId) : array<string|int, mixed>
Parameters
$promotionId : int

Promotion ID

Return values
array<string|int, mixed> —

Array of category_id values

getDb()

Get the underlying PDO connection.

public getDb() : PDO
Return values
PDO

getForBusiness()

Get all promotions for a business.

public getForBusiness(int $businessId[, int $limit = 0 ][, int $offset = 0 ]) : array<string|int, mixed>
Parameters
$businessId : int

Business ID

$limit : int = 0
$offset : int = 0
Return values
array<string|int, mixed>

getItemIds()

Get linked menu item IDs for a promotion.

public getItemIds(int $promotionId) : array<string|int, mixed>
Parameters
$promotionId : int

Promotion ID

Return values
array<string|int, mixed> —

Array of menu_item_id values

paginate()

Paginate records matching conditions.

public paginate(array<string|int, mixed> $conditions, int $page, int $perPage[, string $orderBy = 'id' ][, string $direction = 'ASC' ]) : array<string|int, mixed>
Parameters
$conditions : array<string|int, mixed>

Associative array of field => value pairs

$page : int

Current page number (1-based)

$perPage : int

Records per page

$orderBy : string = 'id'

Column to order by

$direction : string = 'ASC'

Sort direction (ASC or DESC)

Return values
array<string|int, mixed> —

Pagination result with data, total, page, per_page, total_pages

query()

Execute a raw SQL query with parameter binding.

public query(string $sql[, array<string|int, mixed> $params = [] ]) : PDOStatement
Parameters
$sql : string

SQL query string

$params : array<string|int, mixed> = []

Bound parameters

Return values
PDOStatement

syncCategories()

Sync linked categories for a category-scope promotion.

public syncCategories(int $promotionId, array<string|int, mixed> $categoryIds) : void
Parameters
$promotionId : int

Promotion ID

$categoryIds : array<string|int, mixed>

Array of category_id values

syncItems()

Sync linked menu items for an item-scope promotion.

public syncItems(int $promotionId, array<string|int, mixed> $itemIds) : void
Parameters
$promotionId : int

Promotion ID

$itemIds : array<string|int, mixed>

Array of menu_item_id values

toggleActive()

Toggle the is_active status of a promotion.

public toggleActive(int $id) : bool
Parameters
$id : int

Promotion ID

Return values
bool

update()

Update a record by primary key.

public update(int $id, array<string|int, mixed> $data) : bool
Parameters
$id : int

Primary key value

$data : array<string|int, mixed>

Associative array of field => value pairs

Return values
bool

where()

Find records matching conditions.

public where(array<string|int, mixed> $conditions[, string $orderBy = 'id' ][, string $direction = 'ASC' ]) : array<string|int, mixed>
Parameters
$conditions : array<string|int, mixed>

Associative array of field => value pairs

$orderBy : string = 'id'

Column to order by

$direction : string = 'ASC'

Sort direction

Return values
array<string|int, mixed>

filterFillable()

Filter data to only include fillable fields.

protected filterFillable(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

Input data

Return values
array<string|int, mixed> —

Filtered data


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results