Documentation

Configuration

Go to Settings > Redmine in the October CMS backend and fill in:

Environment Variables

SSL verification can be configured via environment variables:

REDMINE_VERIFY_HOST=true
REDMINE_VERIFY_PEER=true

User Mapping

The plugin maps October CMS frontend users to Redmine accounts through the dgline_redmine_user_map database table. Each record links an October CMS user_id to a redmine_user_id and redmine_login.

When a frontend user accesses a component, the plugin resolves the mapping automatically and impersonates the Redmine user via the X-Redmine-Switch-User header. If no mapping exists for a user, it is created automatically by looking up the user's email in Redmine.

This requires the RainLab.User plugin.

Components

TicketList

Displays a paginated list of support tickets authored by the logged-in user.

Properties

Page Variables

The tickets variable has the following structure:

tickets.items     - Array of Redmine issue objects
tickets.total     - Total number of matching tickets
tickets.page      - Current page number
tickets.lastPage  - Last page number
tickets.limit     - Current page size
tickets.search    - Current search query

AJAX Handlers

onChangePage — Reloads the ticket list with new pagination, search, or page size.

POST parameters:

• page (int) — Page number (default: 1)
• limit (int) — Items per page (default: value of itemsPerPage property)
• search (string) — Search query to filter by subject

Example

url = "/tickets"

[ticketList]
itemsPerPage = 20
statusFilter = "open"
ticketPage = "ticket-detail"
==
{% component 'ticketList' %}

TicketDetail

Displays a single ticket with its journals (conversation history) and attachments. Users can reply to the ticket and attach files.

Only tickets authored by the logged-in user are accessible. If the ticket does not exist or belongs to another user, a 404 page is returned.

Properties

Page Variables

The ticket variable contains the full Redmine issue data, including:

ticket.id              - Issue ID
ticket.subject         - Issue subject
ticket.description     - Issue description
ticket.status.name     - Status name
ticket.status.is_closed - Whether the status is closed
ticket.author.name     - Author display name
ticket.created_on      - Creation date (ISO 8601)
ticket.updated_on      - Last update date (ISO 8601)
ticket.journals[]      - Array of journal entries (replies)
ticket.attachments[]   - Array of file attachments

AJAX Handlers

onReply — Submits a reply to the ticket with optional file attachments.

POST parameters:

• notes (string, required) — Reply text
• attachments[] (files, optional) — File attachments

On success, a flash message is displayed and the ticket data is reloaded.

Example

url = "/tickets/:id"

[ticketDetail]
slug = "{{ :id }}"
listPage = "tickets"
==
{% component 'ticketDetail' %}

TicketCreate

Form for creating new support tickets with subject, description, and file attachments.

Properties

Page Variables

AJAX Handlers

onSubmit — Creates a new ticket in Redmine.

POST parameters:

• subject (string, required) — Ticket subject
• description (string, optional) — Ticket description
• attachments[] (files, optional) — File attachments

The ticket is created under the configured project with the default tracker and priority (if set in backend settings). On success, a flash message is displayed and the user is redirected to redirectPage if configured.

Example

url = "/tickets/new"

[ticketCreate]
redirectPage = "ticket-detail"
cancelPage = "tickets"
==
{% component 'ticketCreate' %}

API Usage

Static Facades

The plugin provides static facades under the Redmine\Facades namespace for quick access to all endpoints:

use Redmine\Facades\Issues;
use Redmine\Facades\Projects;
use Redmine\Facades\Users;

// List open issues
$issues = Issues::all(statusId: 'open', projectId: 1, sort: 'updated_on:desc');

// Get single issue with journals
$issue = Issues::find(123, include: ['journals', 'attachments']);

// Create issue
$newIssue = Issues::create(
    projectId: 1,
    subject: 'Bug report',
    description: 'Steps to reproduce...',
    trackerId: 1,
    priorityId: 2,
);

// Update issue
Issues::update(id: 123, statusId: 2, notes: 'Fixed in v1.2');

// Delete issue
Issues::destroy(123);

Direct Client Usage

For impersonation or more control, use the Client class directly:

use DGline\Redmine\Classes\Api\Client;

$client = new Client();

// Impersonate a user (sets X-Redmine-Switch-User header)
$client->impersonate('johndoe');
$issues = $client->issues()->all(authorId: 'me');
$client->uploads()->upload($fileContent, 'document.pdf');

// Clear impersonation
$client->impersonate(null);

Available Endpoints

All endpoints are accessible via $client->methodName() or their corresponding facade:

Issues API Reference

Filters

Watchers

Issues::addWatcher(issueId: 123, userId: 5);
Issues::removeWatcher(issueId: 123, userId: 5);

Projects API Reference

Include Options

• trackers — Project trackers
• issue_categories — Issue categories
• enabled_modules — Enabled modules
• time_entry_activities — Time entry activities (Redmine 3.4+)
• issue_custom_fields — Issue custom fields (Redmine 4.2+)

Archive/Unarchive (Redmine 5.0+)

Projects::archive('my-project');
Projects::unarchive('my-project');

Users API Reference

Status Constants

use Redmine\Facades\Users;

Users::STATUS_ACTIVE     // 1 - Can login
Users::STATUS_REGISTERED // 2 - Email not confirmed
Users::STATUS_LOCKED     // 3 - Cannot login

Error Handling

All API errors throw ApplicationException with translated messages:

use ApplicationException;

try {
    $issue = Issues::find(99999);
} catch (ApplicationException $e) {
    // "Redmine API Error: 404 - Not Found"
    Log::error($e->getMessage());
}

Console Commands

Test API Connection

php artisan redmine:test

Tests the API connection and displays issues assigned to the current user, projects, and current user information.