coderflex / laravel-ticket
Laravel Ticket System, to help you manage your tickets eaisly
Fund package maintenance!
Ko Fi
www.buymeacoffee.com/ousid
Installs: 20 199
Dependents: 0
Suggesters: 0
Security: 0
Stars: 345
Watchers: 5
Forks: 69
Open Issues: 1
Requires
- php: ^8.1
- illuminate/contracts: ^9.0|^10.0
- spatie/laravel-package-tools: ^1.13.0
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^6.0|^7.0
- nunomaduro/larastan: ^2.0.1
- orchestra/testbench: ^7.0|^8.0
- pestphp/pest: ^1.21
- pestphp/pest-plugin-laravel: ^1.1
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpunit/phpunit: ^9.5|^10.0
README
- Introduction
- Installation
- Configuration
- Preparing your model
- Usage
- API Methods
- Handling File Upload
- Testing
- Changelog
- Contributing
- Security Vulnerabilities
- Credits
- License
Introduction
Laravel Ticket package, is a Backend API to handle your ticket system, with an easy way.
Installation
You can install the package via composer:
composer require coderflex/laravel-ticket
Configuration
You can publish the config file with:
php artisan vendor:publish --tag="ticket-config"
You can publish and run the migrations with:
php artisan vendor:publish --tag="ticket-migrations"
Before Running the migration, you may publish the config file, and make sure the current tables does not make a conflict with your existing application, and once you are happy with the migration table, you can run
php artisan migrate
Preparing your model
Add HasTickets
trait into your User
model, along with CanUseTickets
interface
... use Coderflex\LaravelTicket\Concerns\HasTickets; use Coderflex\LaravelTicket\Contracts\CanUseTickets; ... class User extends Model implements CanUseTickets { ... use HasTickets; ... }
Usage
The Basic Usage of this package, is to create a ticket
, then associate the labels
and the categories
to it.
You can associate as many as categories
/labels
into a single ticket.
Here is an example
use Coderflex\LaravelTicket\Models\Ticket; use Coderflex\LaravelTicket\Models\Category; use Coderflex\LaravelTicket\Models\Label; ... public function store(Request $request) { /** @var User */ $user = Auth::user(); $ticket = $user->tickets() ->create($request->validated()); $category = Category::first(); $label = Label::first(); $ticket->attachCategories($category); $ticket->attachLabels($label); // or you can create the categories & the tickets directly by: // $ticket->categories()->create(...); // $ticket->labels()->create(...); return redirect(route('tickets.show', $ticket->uuid)) ->with('success', __('Your Ticket Was created successfully.')); } public function createLabel() { // If you create a label seperated from the ticket and wants to // associate it to a ticket, you may do the following. $label = Label::create(...); $label->tickets()->attach($ticket); // or maybe $label->tickets()->detach($ticket); } public function createCategory() { // If you create a category/categories seperated from the ticket and wants to // associate it to a ticket, you may do the following. $category = Category::create(...); $category->tickets()->attach($ticket); // or maybe $category->tickets()->detach($ticket); } ...
Ticket Table Structure
Message Table Structure
Label Table Structure
Category Table Structure
API Methods
Ticket API Methods
The ticket
model came with handy methods to use, to make your building process easy and fast, and here is the list of the available API:
The Chainable column, is showing the state for the method, that if it can be chained or not, something like
$ticket->archive() ->close() ->markAsResolved();
Ticket Relationship API Methods
The ticket
model has also a list of methods for interacting with another related models
The
attachCategories
andsyncCategories
methods, is an alternative forattach
andsync
laravel methods, and if you want to learn more, please take a look at this link
The commentAsUser
accepts a user as a first argument, if it's null, the authenticated user will be user as default.
Ticket Scopes
The ticket
model has also a list of scopes to begin filter with.
Category & Label Scopes
Handling File Upload
This package doesn't come with file upload feature (yet) Instead you can use laravel-medialibrary by Spatie, to handle file functionality.
The steps are pretty straight forward, all what you need to do is the following.
Extends the Ticket
model, by creating a new model file in your application by
php artisan make:model Ticket
Then extend the base Ticket Model
, then use InteractWithMedia
trait by spatie package, and the interface HasMedia
:
namespace App\Models\Ticket; use Spatie\MediaLibrary\HasMedia; use Spatie\MediaLibrary\InteractsWithMedia; class Ticket extends \Coderflex\LaravelTicket\Models\Ticket implements HasMedia { use InteractsWithMedia; }
The rest of the implementation, head to the docs of spatie package to know more.
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.