Module Ticket Laravel Package

Getting Started

Minimal Setup

1. Installation Add the package via Composer:

   composer require dimpak/module-ticket
   

   Publish the configuration (if needed):

   php artisan vendor:publish --provider="Dimpak\ModuleTicket\ModuleTicketServiceProvider"
   

2. Service Provider & Routes Ensure the package’s service provider is registered in config/app.php under providers. Run migrations (if applicable):

   php artisan migrate
   

3. First Use Case Create a ticket via the facade or service:

   use Dimpak\ModuleTicket\Facades\Ticket;
   
   $ticket = Ticket::create([
       'title' => 'Bug Report',
       'description' => 'Issue with login form',
       'priority' => 'high',
   ]);
   

   Access tickets via the API or Blade:

   $tickets = Ticket::all()->where('status', 'open');
   

Implementation Patterns

Core Workflows

1. Ticket Creation & Management

   • Use the Ticket facade or inject Dimpak\ModuleTicket\Services\TicketService for programmatic control.
   • Example: Bulk-create tickets from a CSV import:

     $tickets = collect($csvData)->map(fn($row) => Ticket::create($row));
     

2. Status & Priority Handling Leverage predefined statuses/priorities (e.g., open, closed, low, high) or extend via config:

   config(['ticket.statuses' => ['pending', 'resolved']]);
   

3. Attachments & Metadata Store files via Ticket::attach($ticketId, $filePath) or add custom metadata:

   $ticket->metadata = ['source' => 'webform'];
   $ticket->save();
   

4. Event-Driven Extensions Listen to ticket.created, ticket.updated events for side effects (e.g., notifications):

   event(new TicketCreated($ticket));
   

Integration Tips

• Laravel Nova: Extend the package with Nova resources for admin UI.
• APIs: Use TicketResource (if provided) or build custom API routes:

  Route::apiResource('tickets', 'TicketController')->middleware('auth:api');
  

• Queues: Defer non-critical actions (e.g., email notifications) with Laravel queues.

Gotchas and Tips

Pitfalls

1. Missing Migrations If the package lacks migrations, manually create tables for tickets, ticket_attachments, etc., matching the expected schema.

2. Configuration Overrides Ensure config/ticket.php is merged correctly—some settings may not apply if not explicitly defined.

3. Facade vs. Service Prefer dependency injection (TicketService) over facades in testable code to avoid singleton pitfalls.

4. Attachment Limits Validate file sizes/types in app/Providers/TicketServiceProvider if the package lacks built-in validation.

Debugging

• Log Events: Enable Laravel’s debug mode (APP_DEBUG=true) to trace event dispatches.
• Query Logs: Use DB::enableQueryLog() to inspect SQL generated by the package’s Eloquent models.

Extension Points

1. Custom Fields Extend the Ticket model to add fields:

   class Ticket extends \Dimpak\ModuleTicket\Models\Ticket {
       protected $casts = ['custom_field' => 'boolean'];
   }
   

2. Validation Rules Override validation in app/Providers/TicketServiceProvider:

   Ticket::extend(function ($service) {
       $service->validator = function ($data) {
           return Validator::make($data, ['title' => 'required|max:255']);
       };
   });
   

3. API Responses Modify responses via middleware or override the TicketController:

   public function show(Ticket $ticket) {
       return response()->json($ticket->toArray() + ['custom_data' => true]);
   }