bitandblack/idml-writer

Writes an Adobe IDML file out of a given content

1.1.0 2020-02-20 08:41 UTC

This package is auto-updated.

Last update: 2020-08-03 06:26:55 UTC


README

PHP from Packagist Codacy Badge Total Downloads License

IDML Writer

This library writes an Adobe IDML file out of a given content.

Installation

This library is available for the use with Composer. Add it to your project by running $ composer require bitandblack/idml-writer.

Usage

When creating a new instance of the Writer you need to pass your content as first parameter and the IDML tree as second parameter:

<?php

use IDML\Writer\File\Tree;
use IDML\Writer\Writer;

$writer = new Writer(
    $myContent, 
    new Tree()
);

The content which is $myContent in our example needs to be an object which implements the ContentInterface.

Since the structure of an IDML file is always the same, you don't need to customize or set up an own Tree object. But in case you want to you only have to implement the TreeInterface.

Create the IDML file by running create() like that:

<?php

$writer->create('myFile.idml');

Content of an IDML

This library doesn't provide creating any IDML content. Creating content can be done by using the bitandblack/idml-creator library. Please not that this one has a private license and is not listed public. You can find more information about the IDML Creator library and its documentation under idml-creator.bitandblack.com.

There is also a demo version which you can find under bitandblack/idml-creator-demo.

Validation of IDML files

Adobe provides a schema for the validation of IDML files, which can be found under www.adobe.com. They provide a JAVA based validation only.

We as Bit&Black made a port to PHP, which can be used and implemented with the help of Composer. It can be found at packagist.org by its name bitandblack/idml-validator.

Help

Feel free to contact us under idml-writer@bitandblack.com.