›
byrcsc/laravel-checklist · 1.x
Configure table names, section depth, evidence storage, due warnings, and shipped notifications.
Publishing config/checklist.php is optional. Publish it before migrating when
you need different table names, or later when the storage, schedule, or
notification defaults do not fit your application.
php artisan vendor:publish --tag="checklist-config"| Key | Default |
|---|---|
table_names.templates | checklist_templates |
table_names.template_versions | checklist_template_versions |
table_names.sections | checklist_sections |
table_names.items | checklist_items |
table_names.checklists | checklists |
table_names.responses | checklist_responses |
table_names.evidence | checklist_evidence |
table_names.rules | checklist_rules |
table_names.schedules | checklist_schedules |
table_names.actions | checklist_actions |
Every key must exist and contain a non-blank string. The service provider validates the map during boot. Package models and migrations resolve names through the same map.
Changing a value after migration does not rename an existing table.
'max_section_depth' => 3,A top-level section has depth one. The builder checks depth while authoring, and publication checks the persisted tree again. Integer values and unsigned numeric strings are accepted. Invalid values fall back to three.
'evidence' => [
'disk' => env('CHECKLIST_EVIDENCE_DISK', 'local'),
],The value must name a Laravel filesystem disk. A missing or blank runtime value
falls back to local.
The package writes and deletes on this disk. It does not configure visibility or generate URLs.
'due_soon_lead_time' => env(
'CHECKLIST_DUE_SOON_LEAD_TIME',
24 * 60,
),The value is minutes before due_at. Non-negative integers and digit-only
strings are accepted. Negative integers become zero. Other values fall back to
1,440 minutes.
The transition fires once per open checklist when
checklist:generate-due runs inside this window.
'notifications' => [
'enabled' => env('CHECKLIST_NOTIFICATIONS', true),
'recipient_resolver' =>
ByRcsc\LaravelChecklist\Notifications\DefaultRecipientResolver::class,
'classes' => [],
],enabled disables only shipped notification delivery when its value is the
boolean false.
recipient_resolver must name a class implementing
Contracts\RecipientResolver. The dispatcher resolves that class from the
container.
classes maps an event class to a Laravel notification class or null. A
missing event key uses the shipped default. A null value silences that event.
| Tag | Output |
|---|---|
checklist-config | config/checklist.php |
checklist-migrations | seven timestamped package migrations |
checklist-translations | notification language lines |
Publish configuration before migrations when table names differ from the defaults. Translation publication is optional.