Download the PHP package tapp/filament-lms without Composer

Filament LMS

An opinionated LMS plugin for Filament containing a user facing LMS panel and Resources for an existing admin panel

Version Compatibility

Installation

Add the following to composer.json

or

Publish

Make sure that the Filament Form Builder migrations are published before.

Then publish the migrations:

[!WARNING]
If you are using multi-tenancy, please see the "Multi-Tenancy Support" section below before running migrations.

run migrations after publishing

Add plugin to admin panel

This will create resources that allow admin to manage course material.

Tailwind CSS Setup

This package uses Tailwind CSS classes in its Blade views. The configuration differs between Tailwind v3 and v4:

For Tailwind CSS v3

1. Install Tailwind CSS in your project (if not already installed):

2. Configure Tailwind to include the package's views in your tailwind.config.js:

3. Include the package CSS in your main CSS file (e.g., resources/css/app.css):

4. Build your CSS to include both Tailwind and the package styles:

For Tailwind CSS v4

1. Install Tailwind CSS v4 in your project:

2. Include the package CSS in your main CSS file (e.g., resources/css/app.css or resources/css/theme.css):

3. Build your CSS to include both Tailwind and the package styles:

Note: The package provides its own CSS for component-specific styling, while using Tailwind classes in views for layout and utilities. This approach ensures no dependency conflicts while maintaining the benefits of Tailwind CSS.

For more detailed Tailwind CSS configuration options, refer to the official Tailwind CSS documentation.

Development Reccomendations

• create the directory {project}/packages
• from within the packages directory, clone this repo
• (if necessary) add a type:path repository to project composer.json

Multi-Tenancy Support

Filament LMS includes built-in support for multi-tenancy, allowing you to scope courses, lessons, steps, and all learning materials to specific tenants (e.g., teams, organizations, workspaces).

⚠️ Important: Enable Tenancy Before Migrations

You MUST configure and enable tenancy in the config file BEFORE running the migrations. The migrations check the tenancy configuration to determine whether to add tenant columns to the database tables. If you enable tenancy after running migrations, you'll need to manually add the tenant columns to your database.

Quick Setup

1. Configure tenancy in config/filament-lms.php BEFORE running migrations:

2. Run migrations (which will now include tenant columns):

3. Implement required contracts on your User model:

4. Implement HasName contract on your Tenant model:

How It Works

Once tenancy is enabled:

URL Structure Changes:

• LMS URLs are now scoped to tenants: /lms/{tenant}/...
• Example: /lms/acme-corp/courses, /lms/acme-corp/certificates/...
• The {tenant} slug is automatically determined from your tenant model's route key

Data Scoping:

• All LMS queries are automatically scoped to the current tenant
• New courses, lessons, and materials are automatically associated with the current tenant
• Users can only access LMS content belonging to their current tenant

Permission Checking:

• Filament automatically verifies users have access to the tenant via canAccessTenant()
• Users can only see tenants returned by getTenants()
• Panel access is controlled by canAccessPanel()

LMS Features

Frontend LMS Panel

contains the LMS experience for the end user

Course Library

• user can view courses available to them
• completion status

  Course UI

• shown when progressing through a single course
• left sidebar showing lessons with steps expanding from them
• icons in sidebar indicating the type of material for each step
• middleware to resume current step
• middleware to prevent skipping steps

  Other Frontend

• profile
• anything else?

Admin Plugin

(should these be resource groups in existing panel or its own panel?)

LMS resource group contains the following resources:

Course

• Top level of learning material data structure
• courses do not have an order. they are independant
• courses can be public or invite only

  Lesson

• Intermediary level data structure
• Has Order (e.g. lesson 1 must be completed before starting lesson 2)
• in the future we may want to add support for lessons containing lessons to allow clients more customizability (lesson 1 contains lesson 1.1)
• name optional

  Step

• Represents a single view in the LMS
• has order
• has material
• name optional

  Material Resource Group

• Video (do we use vimeo or something else?)
• Survey (form for student to fill out)
• Quiz (unlike a survey, a quiz has correct answers and a score)
• Text (Wysiwyg?)
• Image

Configurations

This is the contents of the published config file:

top_navigation

Set it to true to enable top navigation on the LMS dashboard (courses list page).

Note: This configuration only affects the dashboard. Course pages (when viewing individual steps) always use sidebar navigation, regardless of this setting.

show_exit_lms_link

Use to display or not the Exit LMS link on top bar.

Certificate Customization

The LMS package generates PDF certificates when users complete courses. You can customize the appearance and content of certificates using the following configuration options:

certificate_logo

Specify a custom logo to display on certificates. If not set, it falls back to the brand_logo setting.

Recommended logo dimensions: Maximum height of 90px for optimal certificate layout.

Note: The path should be relative to your public directory or use a full URL.

certificate_show_signatures

Control whether signature lines are displayed on certificates. Default is true.

When enabled, the certificate will display signature lines for:

• An authorized signature (e.g., course instructor or administrator)
• The learner's signature

certificate_show_id

Control whether a unique certificate ID is displayed on certificates. Default is true.

The certificate ID helps with verification and tracking of issued certificates.

Example Certificate Configuration

Here's a complete example of certificate customization in your config/filament-lms.php:

Adding extra navigation items

To register new navigation items in the LMS panel, use the boot() method of your AppPanelProvider.php file:

Authorization

Gates

The LMS package uses Laravel Gates for authorization. You'll need to define the following Gates in your application's AuthServiceProvider:

Available Gates

• viewLmsReporting: Controls access to the LMS reporting page. Users must pass this Gate check to view the reporting interface.

Course Authorization

Restricting Course Visibility

To restrict users to only see courses they are assigned to, set the following in your config/filament-lms.php:

When enabled, users will only see courses assigned to them via the lms_course_user pivot table.

User-Course Management in Filament

This package provides a reusable CoursesRelationManager and AssignCoursesBulkAction for managing user-course assignments. To enable course assignment in your User resource:

1. Import the Relation Manager and Bulk Action:

2. Register the CoursesRelationManager:

3. Add the AssignCoursesBulkAction to your bulk actions:

Overriding Course Visibility

If you need custom logic to determine whether a course is visible to a user, you can override the isCourseVisibleForUser method provided by the FilamentLmsUser trait in your User model. This method is used to filter which courses are shown to the user when course visibility restrictions are enabled.

If you want to call the trait's original method within your override, you can alias it when importing the trait:

This allows you to implement any business rules you need for course visibility, while still leveraging the default logic from the trait if desired.

Step Access Control

Customizing Step Access

The LMS package provides a flexible way to control which steps users can access through the canAccessStep method. This method is available on any model that uses the FilamentLmsUser trait and can be overridden to implement custom access control logic.

Default Behavior

By default, the canAccessStep method checks if the step is available based on the completion of previous steps in the course. This ensures users must complete steps in the proper sequence.

Overriding Step Access Control

To implement custom step access logic, override the canAccessStep method in your User model:

Where Step Access is Enforced

The canAccessStep method is automatically used in the following places:

1. Step Page Access: When users try to access a step directly via URL
2. Navigation Links: Determines which step links are clickable in the course navigation
3. Current Step Detection: Used when determining which step to redirect users to

Integration with Existing Logic

The canAccessStep method works alongside the existing getAvailableAttribute() method in the Step model. While getAvailableAttribute() handles the basic sequential completion logic, canAccessStep provides an additional layer of access control that can be customized per user.

Customizing Step Edit Permissions

The LMS package also provides a way to control which users can edit steps through the canEditStep method. This method is separate from canAccessStep and specifically controls edit permissions.

Default Behavior

By default, the canEditStep method returns false, meaning no users have edit permissions. This ensures that step editing is disabled by default and must be explicitly enabled.

Overriding Step Edit Permissions

To implement custom step edit logic, override the canEditStep method in your User model:

Where Step Edit Permissions are Used

The canEditStep method is used in the following places:

1. Edit Button Visibility: Controls whether the "Edit" button appears on step pages
2. Admin Interface: Can be used to control access to step editing in the Filament admin panel
3. API Endpoints: Can be used to secure step editing API endpoints

Separation of Concerns

Note that canEditStep is separate from canAccessStep:

• canAccessStep: Controls whether a user can view/access a step
• canEditStep: Controls whether a user can edit/modify a step

This separation allows for fine-grained control over user permissions, where users might be able to view steps but not edit them.