Pass Roster

Subscriby\Connector\Core\PassRoster. The dashboard draws the Pass Roster as a grid of members against dates; a chat has no grid, so this port walks it the way a conversation can. Every call takes the CreatorRef of the account talking and runs as that creator under the members list's own permission, and every refusal reaches you as PassRosterRefused with a stable reason. The words are the core's: a standing and a move reason cross as enums with the dashboard's translated word beside them, and a date with its range in the plan's own time zone, so your surface prints what the page prints. The Telegram platform bot's 📋 Pass Roster screens and Discord's /subscriby-admin roster are the first callers.

plansFor()Copy Anchor Link

foreach ($this->roster->plansFor($creator, $project) as $plan) {
    // $plan->name, $plan->kind, $plan->datesAhead
}

The plans that sell dates, passes and seasons alike, by name, each a PassRosterPlan: the id, the project, the name, the kind (PlanKind::Pass or PlanKind::PassSeries) and how many of its dates are still to come, cancelled ones left out.

datesFor()Copy Anchor Link

$list = $this->roster->datesFor($creator, $plan->id, weeksAhead: 8);

foreach ($list->dates as $date) {
    // $date->localRange, $date->dayLabel, $date->isCancelled(), $date->sold, $date->queued
}

A PassRosterDates: the plan, and its dates that have not ended and start within the weeks, soonest first, cancelled ones included and marked. Each is a PassRosterDate with its range and its day label in the plan's zone, its state as an AccessWindowState (scheduled, open, closed, cancelled) and its roll call: sold counts every purchase ever bound to the date, refunded and cancelled ones included, and active, queued, notQueued and refunded explain the gap between it and how many will walk in. A plan that sells no dates is refused as plan_unknown.

holdersOf()Copy Anchor Link

$page = $this->roster->holdersOf($creator, $date->id, page: 1, perPage: 8);

foreach ($page->holders as $holder) {
    // $holder->memberName, $holder->standing, $holder->standingWord, $holder->movedFrom, $holder->passId
}

A PassHolderPage: the date with its roll call and one page of its holders in the order they bought. A holder is a pass, so the same member holding a date through two purchases is two holders; each PassHolder carries the pass id, the purchase, the member and their name, their standing beside the dashboard's translated word for it, the plan, whether the date is held through a season, the date the pass last came from and its id, when they bought and when they were last reminded. lastPage(), hasPrevious() and hasNext() page it; a page carries at most a hundred.

trailOf()Copy Anchor Link

$trail = $this->roster->trailOf($creator, $holder->passId);

foreach ($trail->hops as $hop) {
    // $hop->fromLabel, $hop->toLabel, $hop->reasonWord, $hop->movedByName, $hop->movedAt
}

A PassHolderTrail: the holder, the date their pass is on now with its roll call, and every hop the pass made from the core's move log, oldest first. Each PassHop names both dates by id and by day label (toDateId and toLabel are null when the pass was ended instead), the reason as a PassMoveReason (window_cancelled, series_date_substituted, paid_after_window) beside its translated label, who made it when a person did, and when. A pass that never moved has no hops.

RefusalsCopy Anchor Link