›
›
›
  1. docs
  2. ›
  3. byrcsc/laravel-checklist
1.x
Browse documentationOpenClose

Getting started

  • Introduction
  • Installation and setup
  • Quick start

Core concepts

  • Templates and versions
  • Items and sections
  • Checklist lifecycle
  • Answers and evidence
  • Conditional rules
  • Scoring
  • Recurring schedules
  • Audit history

Operations

  • Author a template
  • Run a checklist
  • Create a schedule
  • Customize notifications
  • Export and report
  • Verify audit history
  • Composing with sibling packages

Reference

  • Configuration
  • Builder API
  • Models and scopes
  • Events and notifications
  • Console commands
  • Enums and contracts
  • Testing
  • Troubleshooting

Getting started

  • Introduction
  • Installation and setup
  • Quick start

Core concepts

  • Templates and versions
  • Items and sections
  • Checklist lifecycle
  • Answers and evidence
  • Conditional rules
  • Scoring
  • Recurring schedules
  • Audit history

Operations

  • Author a template
  • Run a checklist
  • Create a schedule
  • Customize notifications
  • Export and report
  • Verify audit history
  • Composing with sibling packages

Reference

  • Configuration
  • Builder API
  • Models and scopes
  • Events and notifications
  • Console commands
  • Enums and contracts
  • Testing
  • Troubleshooting

byrcsc/laravel-checklist · 1.x

Console commands.

Reference checklist generation and audit verification commands, output, options, and exit behavior.

The package registers two Artisan commands. One creates checklists from due schedules; the other verifies the hash chain behind the audit history.

checklist:generate-due

php artisan checklist:generate-due

The command uses the current application time to:

  1. create at most one checklist for each due active schedule;
  2. advance claimed schedules past the current time;
  3. dispatch due-soon transitions for open checklists inside the lead window;
  4. dispatch overdue transitions for open checklists past their due time.

Example summary:

Created 2 checklist(s), skipped 1 schedule(s). Announced 3 due soon and 1 overdue.

A due schedule without a published template version prints a warning and keeps its due time. Overlap-policy skips count in the skipped total.

The command has no arguments or options and returns success after processing. Schedule it every fifteen minutes for typical use.

checklist:verify

php artisan checklist:verify
php artisan checklist:verify --checklist=42
php artisan checklist:verify -v
OptionMeaning
--checklist=Verify only the matching checklist identifier.
-vPrint an intact line for each verified checklist.

The command returns failure when any chain is broken or when --checklist matches no row. An empty database without a filter returns success with a warning.

Example failure:

Checklist 42: BROKEN at action #109 (position 7) - its contents no longer hash to the value stored with it.
1 of 1 checklist(s) have a broken audit chain.

Scheduler registration

use Illuminate\Support\Facades\Schedule;

Schedule::command('checklist:generate-due')->everyFifteenMinutes();
Schedule::command('checklist:verify')->daily();

The package registers commands but does not register application schedules.

What to read next

  • Create a schedule to persist recurrence settings.
  • Verify audit history to act on command failures.
  • Configuration for due-soon timing.
PreviousEvents and notificationsNextEnums and contracts
View source

On this page

  1. checklist:generate-due
  2. checklist:verify
  3. Scheduler registration
  4. What to read next