README

A comprehensive FilamentPHP 3 plugin for managing partner support tickets with separate panels for partners and administrators.

Features

🎫 Partner Panel: Partners can create and manage their support tickets
🛠️ Admin Panel: Administrators can view, assign, and respond to support tickets
📊 Status Management: Track tickets through various states (Open, In Progress, Waiting for Customer, etc.)
⚡ Priority Levels: Set ticket priorities (Low, Normal, High, Urgent)
📎 File Attachments: Upload and download attachments with tickets and replies
📝 Internal Notes: Admin-only internal notes for team collaboration
👤 Assignment System: Assign tickets to specific admin users
✍️ Rich Text Editing: Full WYSIWYG editor for ticket descriptions and replies
🔍 Filtering & Tabs: Filter tickets by status, priority, assignment, etc.
📈 Dashboard Widget: Real-time support statistics
🔔 Event System: Dispatch events for custom notifications and integrations
🔐 Access Control: Built-in policies for authorization
🚀 Laravel 12 Compatible: Built for the latest Laravel version

Quick Start

# Install the package
composer require visio-soft/support

# Publish and run migrations
php artisan vendor:publish --tag="support-migrations"
php artisan migrate

# Optional: Publish config
php artisan vendor:publish --tag="support-config"

// Partner Panel
use VisioSoft\Support\Filament\Partner\Resources\PartnerSupportResource;

$panel->resources([
    PartnerSupportResource::class,
]);

// Admin Panel
use VisioSoft\Support\Filament\Admin\Resources\PartnerSupportResource;
use VisioSoft\Support\Filament\Widgets\SupportStatsWidget;

$panel->resources([
    PartnerSupportResource::class,
])->widgets([
    SupportStatsWidget::class,
]);

That's it! You now have a fully functional support system.

Documentation

📖 Installation Guide - Detailed installation and setup instructions
🏗️ Architecture - Complete architecture documentation
📚 Usage Examples - Code examples for customization
📝 Changelog - Version history and changes
🤝 Contributing - Contribution guidelines

Installation

You can install the package via composer:

composer require visio-soft/support

Publish and run the migrations:

php artisan vendor:publish --tag="support-migrations"
php artisan migrate

Optionally, you can publish the config file:

php artisan vendor:publish --tag="support-config"

For detailed installation instructions, see INSTALLATION.md.

Configuration

The config file config/support.php allows you to customize:

Table names
Status and priority options
File attachment settings (disk, path, max size, allowed types)
Middleware for partner and admin panels

Example configuration:

return [
    'statuses' => [
        'open' => 'Open',
        'in_progress' => 'In Progress',
        'waiting_customer' => 'Waiting for Customer',
        'waiting_admin' => 'Waiting for Admin',
        'resolved' => 'Resolved',
        'closed' => 'Closed',
    ],
    
    'priorities' => [
        'low' => 'Low',
        'normal' => 'Normal',
        'high' => 'High',
        'urgent' => 'Urgent',
    ],
    
    'attachments' => [
        'enabled' => true,
        'disk' => 'public',
        'max_size' => 10240, // KB
    ],
];

Usage

Partner Panel

use VisioSoft\Support\Filament\Partner\Resources\PartnerSupportResource;

public function panel(Panel $panel): Panel
{
    return $panel
        // ... other configuration
        ->resources([
            PartnerSupportResource::class,
        ]);
}

Partners can:

Create new support tickets
View their own tickets
Add replies to open tickets
Upload attachments
Track ticket status

Admin Panel

use VisioSoft\Support\Filament\Admin\Resources\PartnerSupportResource;
use VisioSoft\Support\Filament\Widgets\SupportStatsWidget;

public function panel(Panel $panel): Panel
{
    return $panel
        // ... other configuration
        ->resources([
            PartnerSupportResource::class,
        ])
        ->widgets([
            SupportStatsWidget::class, // Optional dashboard widget
        ]);
}

Admins can:

View all support tickets
Assign tickets to team members
Change ticket status and priority
Add replies and internal notes
Upload attachments
Close and reopen tickets
Filter and search tickets
View ticket statistics

Database Schema

partner_support table

id: Primary key
park_id: Optional park identifier
user_id: User who created the ticket
subject: Ticket subject
content: Ticket description
status: Current status (open, in_progress, waiting_customer, waiting_admin, resolved, closed)
priority: Ticket priority (low, normal, high, urgent)
assigned_to: Admin user assigned to the ticket
closed_at: When the ticket was closed
closed_by: User who closed the ticket
created_at, updated_at, deleted_at: Timestamps

partner_support_replies table

id: Primary key
partner_support_id: Foreign key to partner_support
user_id: User who created the reply
content: Reply content
is_admin_reply: Whether the reply is from an admin
is_internal_note: Whether the reply is an internal note (admin-only)
attachments: JSON array of attachment file paths
created_at, updated_at, deleted_at: Timestamps

Models

PartnerSupport

// Scopes
PartnerSupport::open()->get(); // Get open tickets
PartnerSupport::closed()->get(); // Get closed tickets
PartnerSupport::forUser($userId)->get(); // Get tickets for specific user
PartnerSupport::assignedTo($userId)->get(); // Get tickets assigned to user
PartnerSupport::byPriority('high')->get(); // Get tickets by priority

// Methods
$ticket->isOpen(); // Check if ticket is open
$ticket->isClosed(); // Check if ticket is closed
$ticket->close($userId); // Close the ticket
$ticket->reopen(); // Reopen the ticket
$ticket->assignTo($userId); // Assign ticket to admin

PartnerSupportReply

// Scopes
PartnerSupportReply::public()->get(); // Get public replies
PartnerSupportReply::internal()->get(); // Get internal notes
PartnerSupportReply::adminReplies()->get(); // Get admin replies
PartnerSupportReply::customerReplies()->get(); // Get customer replies

// Methods
$reply->hasAttachments(); // Check if reply has attachments
$reply->getAttachmentUrls(); // Get URLs for all attachments

Events

The plugin dispatches several events that you can listen to:

SupportTicketCreated: When a new ticket is created
SupportReplyAdded: When a reply is added to a ticket
SupportTicketClosed: When a ticket is closed
SupportTicketAssigned: When a ticket is assigned to an admin

Example listener registration:

// In EventServiceProvider.php
protected $listen = [
    \VisioSoft\Support\Events\SupportTicketCreated::class => [
        \App\Listeners\SendTicketCreatedNotification::class,
    ],
    \VisioSoft\Support\Events\SupportReplyAdded::class => [
        \App\Listeners\SendReplyNotification::class,
    ],
];

See examples directory for implementation examples.

Customization

Custom Policies

Customize authorization logic by extending the policies:

use VisioSoft\Support\Policies\PartnerSupportPolicy as BasePolicy;

class CustomPartnerSupportPolicy extends BasePolicy
{
    protected function isAdmin($user): bool
    {
        return $user->hasRole('admin');
    }
}

Custom Event Listeners

Implement custom notifications or integrations by listening to events:

class SendTicketCreatedNotification implements ShouldQueue
{
    public function handle(SupportTicketCreated $event): void
    {
        Mail::to('admin@example.com')->send(new TicketCreatedMail($event->ticket));
    }
}

See the examples directory for more customization examples.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

visio / support

Maintainers

Details