quantic-telecom/support

This package is abandoned and no longer maintained. No replacement package was suggested.

Quantic Telecom Support system

1.0.0-alpha1 2014-09-14 16:15 UTC

Requires

• php: >=5.4.0
• illuminate/support: 4.2.*
• laracasts/commander: ~1.0

MIT

• Thibaud Dauce

README

This package manages Quantic Telecom's support regardless models.

Installation

You can install Quantic Telecom Support through composer:

"require": {
    "quantic-telecom/support": "~1.0"
}

Next, update app/config/app.php to include a reference to this package's service provider in the providers array.

'providers' => [
    'QuanticTelecom\Support\SupportServiceProvider'
]

Package information

Controllers

Quantic Telecom support provides two controllers: QuanticTelecom\Support\Controllers\TicketsController and QuanticTelecom\Support\Controllers\CommentsController with some CRUD's methods.

• TicketsController

  • @create: show create form
  • @store: open a ticket

• CommentsController

  • @store: write a new comment

Routes

You may want to add your own routes for example in app/routes.php or in a service provider.

Contracts

Quantic Telecom support provides some contracts to implement.

Models

• Ticket & Comment: meaningless doc blocs contracts;

Factories

Factories contracts provides a clean way to create models. Concrete implementations need to know how to create a new model instance and how to attach (for comments) a model to another.

• OpenTicket: act like a ticket factory;
• WriteComment: same as OpenTicket for comments.

Repositories

Quantic Telecom support needs repositories to manage database connection:

• TicketRepository: get and save tickets;
• CommentRepository: save a comment.

Commands

Laravel Commander (https://github.com/laracasts/Commander) provides an easy way to leverage commands and domain events. This package has two commands (and two handlers):

• OpenTicketCommand & OpenTicketCommandHandler: use OpenTicket factory to create a new ticket and TicketRepository to save this ticket;
• WriteCommentCommand & WriteCommentCommandHandler: use WriteComment factory to create and attach a new comment to a ticket and then CommentRepository to save / persist it.

Usage

See an usage example here: https://github.com/QuanticTelecom/moloquent-support

Models

First, you need to create your models and implement Ticket and Comment contracts.

Repositories

Then, you need to create the repositories to implement both TicketRepository and CommentRepository.

Make sure to bind the interfaces to the concrete class(es) in a service provider for example.

Factories

Finally, you must build concrete classes for OpenTicket and WriteComment. Just follow the interfaces methods.