OrderStaffAssignment
extends Model
in package
Order staff assignment model.
Manages the many-to-many relationship between orders and staff members, allowing multiple staff to be assigned to a single in-store order.
Tags
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.
- assign() : int|false
- Assign a staff member to an order.
- count() : int
- Count records matching optional conditions.
- 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.
- getDb() : PDO
- Get the underlying PDO connection.
- getForOrder() : array<string|int, mixed>
- Get all staff assigned to an order with user details.
- getOrdersForStaff() : array<string|int, mixed>
- Get orders assigned to a specific staff member.
- isAssigned() : bool
- Check if a staff member is assigned to an order.
- paginate() : array<string|int, mixed>
- Paginate records matching conditions.
- query() : PDOStatement
- Execute a raw SQL query with parameter binding.
- unassign() : bool
- Unassign a staff member from an order.
- 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
= ['order_id', 'user_id', 'assigned_by']
Mass-assignable fields
$primaryKey
protected
string
$primaryKey
= 'id'
Primary key column
$table
protected
string
$table
= 'order_staff_assignments'
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>assign()
Assign a staff member to an order.
public
assign(int $orderId, int $userId[, int|null $assignedBy = null ]) : int|false
Parameters
- $orderId : int
- $userId : int
- $assignedBy : int|null = null
Return values
int|false —Insert ID or false if duplicate
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
intcreate()
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
boolfind()
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>|nullfindBy()
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>|nullgetDb()
Get the underlying PDO connection.
public
getDb() : PDO
Return values
PDOgetForOrder()
Get all staff assigned to an order with user details.
public
getForOrder(int $orderId) : array<string|int, mixed>
Parameters
- $orderId : int
Return values
array<string|int, mixed>getOrdersForStaff()
Get orders assigned to a specific staff member.
public
getOrdersForStaff(int $userId[, int $limit = 50 ]) : array<string|int, mixed>
Parameters
- $userId : int
- $limit : int = 50
Return values
array<string|int, mixed>isAssigned()
Check if a staff member is assigned to an order.
public
isAssigned(int $orderId, int $userId) : bool
Parameters
- $orderId : int
- $userId : int
Return values
boolpaginate()
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
PDOStatementunassign()
Unassign a staff member from an order.
public
unassign(int $orderId, int $userId) : bool
Parameters
- $orderId : int
- $userId : int
Return values
boolupdate()
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
boolwhere()
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