PHPackages                             lukebeer/broadworks-ocip - 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. [Framework](/categories/framework)
4. /
5. lukebeer/broadworks-ocip

ActiveLibrary[Framework](/categories/framework)

lukebeer/broadworks-ocip
========================

PHP ORM-like framework for the Broadworks OCIP API

v3.0.2(6y ago)2757615[8 issues](https://github.com/lukebeer/broadworks-ocip/issues)[1 PRs](https://github.com/lukebeer/broadworks-ocip/pulls)proprietaryPHPPHP >=5.3

Since Sep 6Pushed 5y ago7 watchersCompare

[ Source](https://github.com/lukebeer/broadworks-ocip)[ Packagist](https://packagist.org/packages/lukebeer/broadworks-ocip)[ RSS](/packages/lukebeer-broadworks-ocip/feed)WikiDiscussions master Synced 3w ago

READMEChangelogDependencies (2)Versions (3)Used By (0)

Broadworks OCI-P PHP Framework
==============================

[](#broadworks-oci-p-php-framework)

BTC: bc1q9n0v6l3ch2pjfhld4rj9y2eph3m9wl9xpmznlx

Features
--------

[](#features)

####  SOAP or TCP Stream transport

[](#-soap-or-tcp-stream-transport)

It's now possible to choose between SOAP over HTTPS or a TCP stream (default) for interaction with the Broadworks API. Basic benchmarks suggest 15/requests/second with SOAP and 150/requests/second for TCP Stream. UserGetRequest17sp4 was used for the benchmark.

####  Session management

[](#-session-management)

Sessions can be exported out of and into the Client, this was added to allow Broadworks OCI-P scripts triggered by methods such as cronjobs to execute using external session data. Porting Sessions are a secure way to execute commands as the user that requested it as the password is not stored, cookies/sessionId are used for authentication.

####  IDE Autocompletion

[](#-ide-autocompletion)

All elements of the framework have been built with IDE autocompletion in mind so there isn't a need to remember the details of a data type, below is an example of disabling CallForwardingAlways for all users within a group. [![](https://camo.githubusercontent.com/f8766e6c5d7e015412fb9d93b8d21853133290a2f0fb6f35d1141fb2335fc541/687474703a2f2f6c756b65626565722e6769746875622e696f2f62726f6164776f726b732d6f6369702f696d672f6366612d616c6c696e67726f75702e676966)](https://camo.githubusercontent.com/f8766e6c5d7e015412fb9d93b8d21853133290a2f0fb6f35d1141fb2335fc541/687474703a2f2f6c756b65626565722e6769746875622e696f2f62726f6164776f726b732d6f6369702f696d672f6366612d616c6c696e67726f75702e676966)

#### Interactive console

[](#interactive-console)

An interacting CLI is built in that requires zero programming knowledge. The user navigates through the schema in the same way you would directories and files on a linux file system. Commands can be executed in the CLI with results printed to screen. Tab autocompletion works - (broken in latest release)

####  Data export

[](#-data-export)

Objects support serialisation to allow saving of messages in plain-text format that can be unserialised back into data types the framework can understand then replayed back into Broadworks for example

---

- Friendlier alternative to writing XML directly
- PHP classes generated from XSD schema files
- SOAP transport support, good for unreliable connections
- TCP stream transport support provides minimal overhead & maximum throughput
- SimpleTypes may contain Restriction objects for input validation such as maxLength of minLength
- Automatic mapping of data types (userGetResponse17sp4 --> userAddRequest17sp4)
- Blood, sweat and tears from countless hours of my time when I should of been at the pub

---

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

[](#installation)

###### Use this for master branch

[](#use-this-for-master-branch)

```
$ composer require lukebeer/broadworks-ocip

```

###### Use this for the development branch with untested fixes

[](#use-this-for-the-development-branch-with-untested-fixes)

```
$ composer require lukebeer/broadworks-ocip:development

```

---

Basic usage
-----------

[](#basic-usage)

```