Movatterモバイル変換

coderflexx/laravel-ticketPublic

NotificationsYou must be signed in to change notification settings
Fork78
Star402

Laravel Ticket System, to help you manage your tickets easily.

coderflex.com/open-source/docs/laravel-ticket/introduction

License

MIT license

402 stars 78 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 132 Commits
.github		.github
art		art
config		config
database/migrations		database/migrations
src		src
tests		tests
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
LICENSE.md		LICENSE.md
README.md		README.md
SECURITY.md		SECURITY.md
composer.json		composer.json
phpstan-baseline.neon		phpstan-baseline.neon
phpstan.neon.dist		phpstan.neon.dist
phpunit.xml.dist		phpunit.xml.dist

Repository files navigation

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

AddHasTickets trait into yourUser model, along withCanUseTickets interface

...useCoderflex\LaravelTicket\Concerns\HasTickets;useCoderflex\LaravelTicket\Contracts\CanUseTickets;...class Userextends Modelimplements CanUseTickets{    ...use HasTickets;...}

Usage

The Basic Usage of this package, is to create aticket, then associate thelabels and thecategories to it.

You can associate as many ascategories/labels into a single ticket.

Here is an example

useCoderflex\LaravelTicket\Models\Ticket;useCoderflex\LaravelTicket\Models\Category;useCoderflex\LaravelTicket\Models\Label;...publicfunctionstore(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(...);returnredirect(route('tickets.show',$ticket->uuid))            ->with('success',__('Your Ticket Was created successfully.'));}publicfunctioncreateLabel(){// 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);}publicfunctioncreateCategory(){// 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

Column Name	Type	Default
ID	`integer`	`NOT NULL`
UUID	`string`	`NULL`
user_id	`integer`	`NOT NULL`
title	`string`	`NOT NULL`
message	`string`	`NULL`
priority	`string`	`low`
status	`string`	`open`
is_resolved	`boolean`	`false`
is_locked	`boolean`	`false`
assigned_to	`integer`	`NULL`
created_at	`timestamp`	`NULL`
updated_at	`timestamp`	`NULL`

Message Table Structure

Column Name	Type	Default
ID	`integer`	`NOT NULL`
user_id	`integer`	`NOT NULL`
ticket_id	`integer`	`NOT NULL`
message	`string`	`NULL`
created_at	`timestamp`	`NULL`
updated_at	`timestamp`	`NULL`

Label Table Structure

Column Name	Type	Default
ID	`integer`	`NOT NULL`
name	`string`	`NULL`
slug	`string`	`NULL`
is_visible	`boolean`	`false`
created_at	`timestamp`	`NULL`
updated_at	`timestamp`	`NULL`

Category Table Structure

Column Name	Type	Default
ID	`integer`	`NOT NULL`
name	`string`	`NULL`
slug	`string`	`NULL`
is_visible	`boolean`	`false`
created_at	`timestamp`	`NULL`
updated_at	`timestamp`	`NULL`

API Methods

Ticket API Methods

Theticket model came with handy methods to use, to make your building process easy and fast, and here is the list of the availableAPI:

Method	Arguments	Description	Example	Chainable
`archive`	`void`	archive the ticket	`$ticket->archive()`	✓
`close`	`void`	close the ticket	`$ticket->close()`	✓
`reopen`	`void`	reopen a closed ticket	`$ticket->reopen()`	✓
`markAsResolved`	`void`	mark the ticket as resolved	`$ticket->markAsResolved()`	✓
`markAsLocked`	`void`	mark the ticket as locked	`$ticket->markAsLocked()`	✓
`markAsUnlocked`	`void`	mark the ticket as unlocked	`$ticket->markAsUnlocked()`	✓
`markAsArchived`	`void`	mark the ticket as archived	`$ticket->markAsArchived()`	✓
`closeAsResolved`	`void`	close the ticket and marked it as resolved	`$ticket->closeAsResolved()`	✓
`closeAsUnresolved`	`void`	close the ticket and marked it as unresolved	`$ticket->closeAsUnresolved()`	✓
`reopenAsUnresolved`	`void`	reopen the ticket and marked it as unresolved	`$ticket->reopenAsUnresolved()`	✓
`isArchived`	`void`	check if the ticket archived	`$ticket->isArchived()`	✗
`isOpen`	`void`	check if the ticket open	`$ticket->isOpen()`	✗
`isClosed`	`void`	check if the ticket closed	`$ticket->isClosed()`	✗
`isResolved`	`void`	check if the ticket has a resolved status	`$ticket->isResolved()`	✗
`isUnresolved`	`void`	check if the ticket has an unresolved status	`$ticket->isUnresolved()`	✗
`isLocked`	`void`	check if the ticket is locked	`$ticket->isLocked()`	✗
`isUnlocked`	`void`	check if the ticket is unlocked	`$ticket->isUnlocked()`	✗
`assignTo`	`void`	assign ticket to a user	`$ticket->assignTo($user)` or`$ticket->assignTo(2)`	✓
`makePriorityAsLow`	`void`	make ticket priority as low	`$ticket->makePriorityAsLow()`	✓
`makePriorityAsNormal`	`void`	make ticket priority as normal	`$ticket->makePriorityAsNormal()`	✓
`makePriorityAsHigh`	`void`	make ticket priority as high	`$ticket->makePriorityAsHigh()`	✓

TheChainable 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

Theticket model has also a list of methods for interacting with another related models

Method	Arguments	Description	Example
`attachLabels`	`mixed` ID,`array` attributes,`bool` touch	associate labels into an existing ticket	`$ticket->attachLabels([1,2,3,4])`
`syncLabels`	`Model/array` IDs,`bool` detouching	associate labels into an existing ticket	`$ticket->syncLabels([1,2,3,4])`
`attachCategories`	`mixed` ID,`array` attributes,`bool` touch	associate categories into an existing ticket	`$ticket->attachCategories([1,2,3,4])`
`syncCategories`	`Model/array` IDs,`bool` detouching	associate categories into an existing ticket	`$ticket->syncCategories([1,2,3,4])`
`message`	`string` message	add new message on an existing ticket	`$ticket->message('A message in a ticket')`
`messageAsUser`	`Model/null` user,`string` message	add new message on an existing ticket as a different user	`$ticket->messageAsUser($user, 'A message in a ticket')`

TheattachCategories andsyncCategories methods, is an alternative forattach andsync laravel methods, and if you want to learn more, please take a look at thislink

ThecommentAsUser accepts a user as a first argument, if it's null, theauthenticated user will be user as default.

Ticket Scopes

Theticket model has also a list of scopes to begin filter with.

Method	Arguments	Description	Example
`closed`	`void`	get the closed tickets	`Ticket::closed()->get()`
`opened`	`void`	get the opened tickets	`Ticket::opened()->get()`
`archived`	`void`	get the archived tickets	`Ticket::archived()->get()`
`unArchived`	`void`	get the unArchived tickets	`Ticket::unArchived()->get()`
`resolved`	`void`	get the resolved tickets	`Ticket::resolved()->get()`
`locked`	`void`	get the locked tickets	`Ticket::locked()->get()`
`unlocked`	`void`	get the unlocked tickets	`Ticket::unlocked()->get()`
`withLowPriority`	`void`	get the low priority tickets	`Ticket::withLowPriority()->get()`
`withNormalPriority`	`void`	get the normal priority tickets	`Ticket::withNormalPriority()->get()`
`withHighPriority`	`void`	get the high priority tickets	`Ticket::withHighPriority()->get()`
`withPriority`	`string` $priority	get the withPriority tickets	`Ticket::withPriority('critical')->get()`

Category & Label Scopes

Method	Arguments	Description	Example
`visible`	`void`	get the visible model records	`Label::visible()->get()`
`hidden`	`void`	get the hidden model records	`Category::visible()->get()`

Handling File Upload

This package doesn't come with file upload feature (yet) Instead you can uselaravel-medialibrary bySpatie,to handle file functionality.

The steps are pretty straight forward, all what you need to do is the following.

Extends theTicket model, by creating a new model file in your application by

php artisan make:model Ticket

Then extend the baseTicket Model, then useInteractWithMedia trait by spatie package, and the interfaceHasMedia:

namespaceApp\Models\Ticket;useSpatie\MediaLibrary\HasMedia;useSpatie\MediaLibrary\InteractsWithMedia;class Ticketextends \Coderflex\LaravelTicket\Models\Ticketimplements HasMedia{use InteractsWithMedia;}