LiveDocx in PHP

I am delighted to announce that the final, stable version of Zend_Service_LiveDocx in Zend Framework 1.10 has just been released.

Download Zend Framework 1.10.0 Full and read the updated documentation on ZendFramework.com.

You can find Zend_Service_LiveDocx_* at the following locations in the distribution tree:

Source code

/library/Zend/Service/LiveDocx.php
/library/Zend/Service/LiveDocx/MailMerge.php
/library/Zend/Service/LiveDocx/Exception.php

Unit tests

/tests/Zend/Service/LiveDocx/LiveDocxTest.php
/tests/Zend/Service/LiveDocx/MailMergeTest.php
/tests/Zend/Service/LiveDocx/MailMerge/*

Demonstration applications

/demos/Zend/Service/LiveDocx/*

I really recommend taking a look at the demonstration applications, as they illustrate all of Zend_Service_LiveDocx functionality.

You can check that your server environment is set up correctly to run Zend_Service_LiveDocx, by executing check-environment.php in the directory /demos/Zend/Service/LiveDocx/.

I would like to thank Matthew Weier O’Phinney, Zend Framework Project Lead and all other members of the Zend Framework community, who have contributed to Zend_Service_LiveDocx.

The first implementation of LiveDocx in PHP was in a family of classes called Tis_Service_LiveDocx. It was necessary to give the classes the prefix Tis_ as the Zend Framework coding standards allow the prefix Zend_ to be used only for classes, which are part of the official Zend Framework.

As of the first alpha version of Zend Framework 1.10, the functionality of Tis_Service_LiveDocx is available directly in the Zend Framework in Zend_Service_LiveDocx.

As of today, the use of Tis_Service_LiveDocx is deprecated. Instead use Zend_Service_LiveDocx.

With the exception of the constructor, the API of Zend_Service_LiveDocx is 100% backward compatible to that of Tis_Service_LiveDocx.

At the wish of the Zend Framework community, the constructor was updated from:

1
2

// deprecated - do not use
$phpLiveDocx = new Tis_Service_LiveDocx_MailMerge('myUsername', 'myPassword');

to:

1
2
3
4
5
6
7
8
9
10
11
12
13

// correct - do use
$phpLiveDocx = new Zend_Service_LiveDocx_MailMerge(
    array (
        'username' => 'myUsername',
        'password' => 'myPassword'
    )
);
 
// alternatively
$phpLiveDocx = new Zend_Service_LiveDocx_MailMerge();
 
$phpLiveDocx->setUsername('myUsername')
            ->setPassword('myPassword');

I would encourage you to update your projects to use the Zend_Service_LiveDocx family of classes.

If you need any assistance in migrating your code, please post a support request into the support forum.

You can now download the first beta version of the Zend Framework that contains Zend_Service_LiveDocx. The final stable version will be released in the next few days.

Please go to the download section of ZendFramework.com and download Zend Framework 1.10.0 Beta 1 Full.

The paths to the demonstration applications and documentation remain the same as listed in the previous post.