detain/myadmin-kayako-support

Kayako handling plugin for MyAdmin

v2.0.0 2019-04-04 08:07 UTC

Requires

• php: >=5.0.0
• ext-soap: *
• detain/myadmin-plugin-installer: dev-master
• symfony/event-dispatcher: >=2.8.26

Requires (Dev)

• codacy/coverage: dev-master
• codeclimate/php-test-reporter: dev-master
• phpunit/phpunit: *
• phpunit/phpunit-mock-objects: *
• satooshi/php-coveralls: *
• vlucas/phpdotenv: *

LGPL-2.1-only

• Joe Huss

• spam
• administration
• Abuse

README

A MyAdmin plugin that integrates with the Kayako ticket and helpdesk system. It provides event-driven hooks for API registration, requirement loading, and settings management within the MyAdmin platform. The package exposes SOAP-compatible API functions for creating, listing, viewing, and replying to support tickets through Kayako.

Features

• Registers ticket management API endpoints (create, list, view, reply)
• Hooks into MyAdmin's event dispatcher for seamless plugin integration
• Manages Kayako connection settings (API URL, key, secret)
• Input validation with descriptive error messages on all API calls
• Pagination support for ticket listing

Installation

Install with Composer:

composer require detain/myadmin-kayako-support

Configuration

The plugin uses three configuration constants that should be defined in your MyAdmin environment:

• KAYAKO_API_URL - The base URL for the Kayako REST API
• KAYAKO_API_KEY - Your Kayako API key
• KAYAKO_API_SECRET - Your Kayako API secret

Usage

The plugin registers itself through MyAdmin's event dispatcher. The Plugin::getHooks() method returns the event-to-handler mappings:

use Detain\MyAdminKayako\Plugin;

$hooks = Plugin::getHooks();
// Returns: ['api.register' => ..., 'function.requirements' => ..., 'system.settings' => ...]

Running Tests

composer install
vendor/bin/phpunit

License

Licensed under the LGPL-2.1. See LICENSE for details.