Buffalo Eats Online API Documentation

User extends Model
in package

User model for client owner and staff accounts.

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.
activate()  : bool
Activate a user account.
all()  : array<string|int, mixed>
Get all records from the table.
count()  : int
Count records matching optional conditions.
countByBusiness()  : int
Count users for a business, optionally by role.
create()  : int
Create a new record.
deactivate()  : bool
Deactivate a user account.
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.
findByBusiness()  : array<string|int, mixed>
Find all users belonging to a business.
findByBusinessAndRole()  : array<string|int, mixed>
Find users by business and role.
findByEmail()  : array<string|int, mixed>|null
Find a user by email address.
findOwnerByBusiness()  : array<string|int, mixed>|null
Find the owner user for a given business.
getDb()  : PDO
Get the underlying PDO connection.
paginate()  : array<string|int, mixed>
Paginate records matching conditions.
query()  : PDOStatement
Execute a raw SQL query with parameter binding.
update()  : bool
Update a record by primary key.
updateLastLogin()  : bool
Update the last login timestamp.
verifyPassword()  : bool
Verify a password against the stored hash.
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', 'email', 'password', 'role', 'permissions', 'phone', 'is_active', 'email_verified_at', 'last_login_at']

Mass-assignable fields

$primaryKey

protected string $primaryKey = 'id'

Primary key column

$table

protected string $table = 'users'

Database table name

Methods

__construct()

Initialize model with database connection.

public __construct() : mixed

activate()

Activate a user account.

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

User ID

Return values
bool

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

countByBusiness()

Count users for a business, optionally by role.

public countByBusiness(int $businessId[, string|null $role = null ]) : int
Parameters
$businessId : int

Business ID

$role : string|null = null

Optional role filter

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

deactivate()

Deactivate a user account.

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

User ID

Return values
bool

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

findByBusiness()

Find all users belonging to a business.

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

Business ID

Return values
array<string|int, mixed>

findByBusinessAndRole()

Find users by business and role.

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

Business ID

$role : string

User role

Return values
array<string|int, mixed>

findByEmail()

Find a user by email address.

public findByEmail(string $email) : array<string|int, mixed>|null
Parameters
$email : string

Email address

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

findOwnerByBusiness()

Find the owner user for a given business.

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

Business ID

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

getDb()

Get the underlying PDO connection.

public getDb() : PDO
Return values
PDO

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

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

updateLastLogin()

Update the last login timestamp.

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

User ID

Return values
bool

verifyPassword()

Verify a password against the stored hash.

public verifyPassword(string $password, string $hash) : bool
Parameters
$password : string

Plain-text password

$hash : string

Stored bcrypt hash

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