›
›
›
  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

Configuration.

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"

Table names

KeyDefault
table_names.templateschecklist_templates
table_names.template_versionschecklist_template_versions
table_names.sectionschecklist_sections
table_names.itemschecklist_items
table_names.checklistschecklists
table_names.responseschecklist_responses
table_names.evidencechecklist_evidence
table_names.ruleschecklist_rules
table_names.scheduleschecklist_schedules
table_names.actionschecklist_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.

Section depth

'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

'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

'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.

Notification settings

'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.

Published assets

TagOutput
checklist-configconfig/checklist.php
checklist-migrationsseven timestamped package migrations
checklist-translationsnotification language lines

Publish configuration before migrations when table names differ from the defaults. Translation publication is optional.

What to read next

  • Installation and setup for the required publication order.
  • Customize notifications for resolver and class examples.
  • Troubleshooting for boot-time configuration failures.
PreviousComposing with sibling packagesNextBuilder API
View source

On this page

  1. Table names
  2. Section depth
  3. Evidence disk
  4. Due-soon lead time
  5. Notification settings
  6. Published assets
  7. What to read next