kijho/kijho-help-desk

1.0.1 2017-07-12 19:27 UTC

Requires

• php: >=5.3.9
• doctrine/doctrine-bundle: ~1.4
• doctrine/orm: ^2.4.8
• symfony/swiftmailer-bundle: ~2.3
• symfony/symfony: 2.8.*|^3.0

MIT

• Luis Fernando Granados
• Cesar Giraldo

README

Bundle para Symfony 2.8 and 3.x, para administrar tickets de soporte de clientes

Aplicación Demo

Descargue la aplicación demo

Instalación

En la consola del proyecto ejecute:

    composer require kijho/kijho-help-desk 1.0.0

Registramos el bundle en el archivo AppKernel.php

    $bundles = array(
        ...
        new Kijho\HelpDeskBundle\HelpDeskBundle(),
    );

En la consola del proyecto ejecute:

    php bin/console d:s:u --force

    php bin/console assets:install

Editamos los proveedores de usuarios del bundle de tickets en el archivo config.yml

    # bin/config.yml
    help_desk:
        client_provider: 'Acme\DemoBundle\Entity\YourClient'
        operator_provider: 'Acme\DemoBundle\Entity\YourOperator'

En tus entidades proveedores de usuarios, debes implementar la siguiente interface:

    use Kijho\HelpDeskBundle\Model\UserInterface as HelpDeskUserInterface;
    
    /**
    * @ORM\Table()
    * @ORM\Entity
    */
   class YourClient implements HelpDeskUserInterface {
    
   }

    use Kijho\HelpDeskBundle\Model\UserInterface as HelpDeskUserInterface;
    
    /**
    * @ORM\Table()
    * @ORM\Entity
    */
   class YourOperator implements HelpDeskUserInterface {
   
   }

Al implementar la interface anterior, es necesario implementar las siguientes funciones:

    /**
     * Returns client or operator identifier
     * @return string
     */
    public function getId();

    /**
     * Returns client or operator name
     * @return string
     */
    public function getName();

    /**
     * Return client or operator email
     * @return string
     */
    public function getEmail();
    
    /**
     * Return boolean if the user is an allowed Ticket Operator
     * @return boolean
     */
    public function getIsTicketOperator();

NOTA: Es posible usar una misma entidad para ser el proveedor de usuarios de Clientes y Operadores.

Los Operadores son las personas que atenderán los Tickets de Soporte enviados por los clientes, para ello la función getIsTicketOperator() debe retornar true, o una variable booleana de la entidad para elegir quienes de tus administradores podrán atender Tickets de Soporte.

Habilitamos el servicio "ticket_provider" en las variables globales de twig, archivo config.yml:

    # bin/config.yml
    # Twig Configuration
    twig:
        globals:
            ticket_provider: @ticket_provider

Asegurese de haber configurado el idioma:

    # bin/config.yml
    parameters:
        locale: es

    framework:
        #esi:             ~
        translator:      { fallbacks: ["%locale%"] }

Configura las rutas del bundle de soporte en el archivo routing.yml

    # bin/routing.yml
    help_desk_clients:
        resource: "@HelpDeskBundle/Resources/config/routing/client.yml"
        prefix:   /help-desk-client
    
    help_desk_operator:
        resource: "@HelpDeskBundle/Resources/config/routing/operator.yml"
        prefix:   /help-desk-operator

Configura tus reglas de control de accesos en el archivo security.yml

    access_control:
        - { path: '^/help-desk-client/*', roles: YOUR_CLIENT_ROLE }
        - { path: '^/help-desk-operator/*', roles: YOUR_ADMIN_ROLE }

Para acceder al menú del cliente, crea un enlace en cualquiera de tus templates con la siguiente ruta:

    href="{{path('help_desk_client_tickets',{'status':'all'})}}"

Para acceder al menú del operador, crea un enlace en cualquiera de tus templates con la siguiente ruta:

    href="{{path('help_desk_operator_tickets',{'status':'all'})}}"

NOTA: Puedes modificar el enlace para abrir el modulo en un iframe, en una ventana emergente o como lo desees.

Desde tus plantillas Twig, puedes acceder a diferentes funciones para obtener información acerca de los Tickets de soporte:

Para el cliente:

    {# Número total de tickets del cliente #}
    {{ ticket_provider.getCountClientTickets(app.user.id) }}

    {# Número de tickets activos del cliente #}
    {{ticket_provider.getCountClientTickets(app.user.id, 'active')}}

    {# Número de tickets cerrados del cliente #}
    {{ticket_provider.getCountClientTickets(app.user.id, 'closed')}}

Para el administrador:

    {# Número total de tickets #}
    {{ticket_provider.getCountTickets()}}

    {# Número de tickets activos #}
    {{ticket_provider.getCountTickets('active')}}

    {# Número de tickets cerrados #}
    {{ticket_provider.getCountTickets('closed')}}

Categorías de Tickets y Notificaciones por Correo: Para que un cliente pueda crear tickets de soporte, debe haber existir en base de datos al menos una categoría de tickets. Estas categorías son administradas por los operadores en su respectivo modulo, asi que una vez tengas todo configurado asegurate de crear tus categorías de tickets y colocar los emails a donde llegarán las notificaciones por correo electrónico.