se/opentrans

Allows to read, create and write OpenTRANS compatible documents

OpenTrans

, _(*1)

Allows you to read, create and write OpenTRANS compatible documents from PHP, _(*2)

Dev branch is master branch.

, _(*3)

Table of Contents

Installation, _(*4)

Usage, _(*5)

• Build document
• Document factory
• Run tests
• Symfony2 integration

Roadmap, _(*6)

, _(*7)

Installation

The recommended way to install is through Composer., _(*8)

{
    "require": {
        "se/opentrans": "dev-master"
    }
}

, _(*9)

Usage

, _(*10)

Build document

Assuming you already have a builder (See document factory), _(*11)

``` php getDocument(); $document->getHeader()->getOrderInfo()->setOrderId('00000000001'); $orderLine1 = new OpenTrans\Node\Order\ItemNode(); $orderLine1->setLineId('P00000001'); $document->addItem($orderLine1); $xml = $builder->serialize(); ``` Returns: ``` xml GENERATOR_INFO/ GENERATION_DATE/ 00000000001 P00000001 ORDER_SUMMARY/ , _(*12)

<a name="factory"></a>
### Document factory

``` php
<?php

use \SE\Component\OpenTrans;

// Pick a factory to create your document (i.e. an Order)
$loader = new OpenTrans\NodeLoader();
$factory = new OpenTrans\DocumentFactory\OrderFactory($loader);
$builder = new OpenTrans\DocumentBuilder($factory);
$builder->build(); // bootstraps the default document structure

$document = $builder->getDocument();
// ... build your document

Resolve document factory by document type

``` php <?php, <sub>(*13)</sub>

use \SE\Component\OpenTrans;, <sub>(*14)</sub>

// Let the DocumentFactoryResolver pick the factory you need, <sub>(*15)</sub>

$loader = new OpenTrans\NodeLoader(); $factoryClass = OpenTrans\DocumentFactory\DocumentFactoryResolver::resolveFactory( $loader, OpenTrans\DocumentType::DOCUMENT_ORDER );, <sub>(*16)</sub>

$factory = new $factoryClass($loader); $builder = new OpenTrans\DocumentBuilder($factory); $builder->build(); // bootstraps the default document structure, <sub>(*17)</sub>

$document = $builder->getDocument(); // ... build your document, <sub>(*18)</sub>

<a name="tests"></a>
### Run tests
``` bash
$> vendor/bin/phpunit

, <sub>(*19)</sub>

Symfony2 bundle

This library is integrated into Symfony2 through the OpenTransBundle., <sub>(*20)</sub>

, <sub>(*21)</sub>

Roadmap

• Implement Document types
  • (x) Order
  • ( ) Invoice
  • ( ) OrderChange
  • ( ) OrderResponse
  • ( ) Quotation
  • ( ) RFQ
  • ( ) ReceiptAcknowledgement