dynamark3-client

, _(*1)

A Dynamark Communication Protocol 3 client, written in PHP, _(*2)

Install

Via Composer, _(*3)

``` bash composer require graze/dynamark3-client, _(*4)


## Usage

### Instantiating a client

Use the `factory` method to return a `Dynamark3ClientInterface` instance:

``` php
$client = Graze\Dynamark3Client\Dynamark3Client::factory();
...

Issuing commands

Connect to a remote endpoint using connect:, _(*5)

...
$dsn = '127.0.0.1:20000';
$client->connect($dsn);
...

Commands are then simply method names that can be called directly on the client:, _(*6)

...
// issue a GETXML command
$resp = $client->getxml();
...

Commands containing spaces are represented using camelCase:, _(*7)

...
// issue a MARK STOP command
$resp = $client->markStop();
...

Command arguments are passed as method paramaters:, _(*8)

...
// issue a DELETEFILE command
$path = '\hard disk\domino\filecoding\codes.txt';
$resp = $client->deletefile($path);
...

Responses

The client will respond with a Dynamark3ResponseInterface object with the following methods:, _(*9)

/**
 * Any response from the server up until a prompt is encountered.
 *
 * @return string
 */
public function getResponseText();

/**
 * Whether an error prompt was encountered.
 *
 * @return bool
 */
public function isError();

/**
 * The error code returned from the Dynamark 3 server
 *
 * @return int
 */
public function getErrorCode();

Handling a response:, _(*10)

...
$resp = $client->getxml();
if ($resp->isError()) {
    echo sprintf('the server responded with error code: [%d]', $resp->getErrorCode());
    // look up the error code in the Dynamark 3 protocol docs
    return;
}

$xml = $resp->getResponseText();
// do something fun with the xml

Example success response:, _(*11)

Screenshot of terminal text showing a success response , _(*12)