PHPackages                             shoppimon/ockham - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. shoppimon/ockham

ActiveLibrary[API Development](/categories/api)

shoppimon/ockham
================

Support / ticketing system API abstraction layer

01.4k[1 issues](https://github.com/shoppimon/ockham/issues)PHP

Since Apr 29Pushed 11y ago1 watchersCompare

[ Source](https://github.com/shoppimon/ockham)[ Packagist](https://packagist.org/packages/shoppimon/ockham)[ RSS](/packages/shoppimon-ockham/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Ockham - a PHP abstraction layer for 3rd party support / ticketing systems
==========================================================================

[](#ockham---a-php-abstraction-layer-for-3rd-party-support--ticketing-systems)

Ockham is a minimal abstraction layer, wrapping different APIs to 3rd party support ticketing systems. Its purpose is not to provide the full functionality one would expect from a ticketing system API, but rather a "lowest common denominator" implementation of what most apps need when integrating with a ticketing system - i.e. creating tickets, and possibly a few more actions, but not more than that.

Installation
------------

[](#installation)

Ockham is available via [Composer](http://getcomposer.org/). Add it to your project by running the following composer command on your project root:

```
$ composer require shoppimon/ockham

```

In addition, most service adapter implementations need to be required explicitly (they are only suggested by the composer package and not required because most people won't use all of them). So, you need to require the specific underlying library(ies) as well, for example:

```
$ composer require uservoice/uservoice

```

This will bring any required dependencies along as well.

Note that composer will set up the include path is required, so assuming you don't already do so (usually your framework will), you need to `require`composer's autoloader file from `vendor/autoload.php`

Implemented Adapters
--------------------

[](#implemented-adapters)

- `uservoice` - Create tickets on [uservoice.com](http://uservoice.com)requires the `uservoice/uservoice` composer package
- `zendmail` - "Create a ticket" by sending an email to a given address using the Zend\\Mail ZF2 component. requires the `zendframework/zend-mail` composer package
- `mock` - A mock implementation, doesn't really do anything and has no requirements; Should be used for testing purposes only.

Usage
-----

[](#usage)

Once installed, you can use the Factory method to get an instance of the required backend class:

```
use Ockham\Factory;

$options = array(
    'transport' => array(
        'type' => 'smtp',
        'options' => array()
    ),
    'to' => array('feedback@shoppimon.com', 'Shoppimon Support'),
    'from' => array('do-not-reply@shoppimon.com'),
    'subject_prefix' => '[Support Request]'
);
$ticketService = Factory::createService('zendmail', $options);
$ticketService->createTicket('noob@example.com', 'I need help!', $message);

```

Some additional options and functionality is documented in the code (for now, sorry).

Framework Wrappers
------------------

[](#framework-wrappers)

It is our goal to ship Ockham with no stict dependancies on any PHP Framework. That said, we aim to ship some optional "Framework Wrappers" that wrap the Factory class with some framework-specific service provider API.

Currently, Zend Framework 2 users can use the `Ockham\Wrapper\Zf2` class as a Service Manager Factory to easily provide Ockham as an app-wide service. See the class PHPDoc comment for details.

Contributing, TODO
------------------

[](#contributing-todo)

You can contribute by forking the project's canonical repo and sending out pull requeusts. The following is a non-comprehensive TODO list:

- Unit tests
- Documentation
- Create additional adapters (e.g. ZenDesk, more mail adapters)

Copyright
---------

[](#copyright)

(c) 2015 Shoppimon LTD, all rights reserved.

Ockham is an open-source project released by the development team of [Shoppimon](https://www.shoppimon.com), under the MIT license.

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/2c68e8ff48017d38c4fd58a250ddeb19f390902374300761c23b8713250ea076?d=identicon)[shevron](/maintainers/shevron)

---

Top Contributors

[![shevron](https://avatars.githubusercontent.com/u/65563?v=4)](https://github.com/shevron "shevron (5 commits)")

### Embed Badge

![Health badge](/badges/shoppimon-ockham/health.svg)

```
[![Health](https://phpackages.com/badges/shoppimon-ockham/health.svg)](https://phpackages.com/packages/shoppimon-ockham)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[facebook/php-business-sdk

PHP SDK for Facebook Business

90821.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

74513.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

265103.1M454](/packages/google-gax)[google/common-protos

Google API Common Protos for PHP

173103.7M50](/packages/google-common-protos)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
