Configuration

If you want to change the behavior of this plugin, create a config file config/responsiv/support/config.php and place the content inside:

<?php

return [

    /*
    |----------------------------------------------------------------------
    | Automatically close expired tickets
    |----------------------------------------------------------------------
    |
    | Set this to the number of days to wait before closing an expired ticket
    | automatically, or set to false to disable this feature.
    |
    */
    'expireInterval' => 7,

];

Implementing front-end pages

The plugin provides several components for building the support pages.

Ticket submission page

Use the supportTicketSubmit component to display a form used for submitting new tickets. The component has the following properties:

• redirect - a page name to redirect to after submitting a ticket.

The supportTicketSubmit component injects the following variables to the page where it's used:

• ticketTypes - a list of available ticket types loaded from the database.

The next example shows the basic component usage on the ticket submission page:

title = "Submit support ticket"
url = "/support/submit"

[supportTicketSubmit]
redirect = "support/ticket"
==
{% component 'supportTicketSubmit' %}

Ticket list page

Use the supportTickets component to display a list of tickets logged by a user. The component has the following properties:

• submitPage - a page name to link to for submitting a new ticket.
• ticketPage - a page name to link to for viewing a ticket.

The supportTickets component injects the following variables to the page where it's used:

• tickets - a list of support tickets loaded from the database.

The next example shows the basic component usage on the ticket listing page:

title = "Support tickets"
url = "/support/tickets"

[supportTickets]
submitPage = "support/submit"
ticketPage = "support/ticket"
==
{% component 'supportTickets' %}

Ticket page

Use the supportTicket component to display a single ticket. The component has the following properties:

• updatePage - a page name to link to for updating a user posted message.
• isPrimary - set this to true to use this page for generating links within mail notifications. Only one ticket page should be primary.

The supportTicket component injects the following variables to the page where it's used:

• ticket - the ticket object loaded from the database. If the ticket is not found, the variable value is null.

The next example shows the basic component usage on the ticket view page:

title = "Support ticket"
url = "/support/ticket/:id?"

[supportTicket]
updatePage = "support/update"
isPrimary = "1"
==

{% component 'supportTicket' %}

Ticket update page

Use the supportTicketUpdate component to allow a user to update the content of posted messages. The component has the following properties:

• ticketPage - a page name to link to for returning to the ticket view.

The supportTicketUpdate component injects the following variables to the page where it's used:

• model - the ticket or message object loaded from the database. If the object is not found, the variable value is null.
• updateMode - determines if this page is being used for updating ticket or message content. The value will either be message or ticket.

The next example shows the basic component usage on the ticket update page:

title = "Support tickets"
url = "/support/update/:id"

[supportTicketUpdate]
ticketPage = "support/ticket"
==

{% component 'supportTicketUpdate' %}