16
Sep
Written by: Jonathan Maron. Stored in: LiveDocx.

The long term goal of phpLiveDocx is to be included in the official Zend Framework distribution file, hence, removing the need to explicitly download and install phpLiveDocx separately. Once in the Zend Framework, the family of components will occupy the Zend_Service_LiveDocx_* space.

Back in July, I was informed that my proposal had been accepted and that Zend_Service_LiveDocx_* may be developed in the Standard Incubator repository.

As of yesterday, I am very happy to report that all of the requirements to be included in the official Zend Framework have now been fulfilled. These include:

  • Fully functioning source code.
  • API documentation (as phpDocumentor).
  • Unit tests, testing all component parts.
  • End-user documentation.

Although not a requirement, I have also submitted a number of demonstration applications, which illustrate how the components work.

Using Subversion (SVN) you can anonymously checkout the Standard Incubator repository – the current location of Zend_Service_LiveDocx_*:

svn checkout http://framework.zend.com/svn/framework/standard/incubator/ ./

You can find Zend_Service_LiveDocx_* at the following locations:

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/*

End-User documentation (as raw XML)

/documentation/manual/en/module_specs/Zend_Service_LiveDocx.xml
/documentation/manual/en/figures/livedocx*

Demonstration applications

/demos/Zend/Service/LiveDocx/*

Learn more about the Zend Framework repository in the official wiki.

I would like to thank Matthew Weier O’Phinney, Zend Framework Project Lead for helping me meet the above four requirements.

I now look forward to the final migration to the official Zend Framework Trunk.

Updated on December 03, 2009: Zend_Service_LiveDocx has now been migrated to Zend Framework Standard Trunk. See this blog post for details.

6 Responses to “Moving to Zend Framework code repository”

  1. Jonathan Maron Says:

    The Zend Framework community has updated the parameters of the constructor:

    Zend_Service_LiveDocx_MailMerge::__construct

    $phpLiveDocx = new Zend_Service_LiveDocx_MailMerge(
        array (
            'username' => 'myUsername',
            'password' => 'myPassword'
        )
    );

    Tis_Service_LiveDocx_MailMerge::__construct

    $phpLiveDocx = new Tis_Service_LiveDocx_MailMerge('myUsername', 'myPassword');

    Apart from that, there are no changes to the public methods of the classes.

  2. Peter Hatton Says:

    When will Zend_Service_LiveDocx_MailMerge be part of the actual Zend Framework? i.e. when will be declared as stable? I would like to use it in my app, but do not want to use code from the incubator.

  3. Jonathan Maron Says:

    Hi Peter

    AFAIK, all requirements have been fulfilled for Zend_Service_LiveDocx_MailMerge to be an official Zend Framework component.

    It now lies in the hands of my Zend liaison and Zend Framework release manager to exactly when the component will be included in the official distribution file.

    I hope that it will not take too long :-)

    In the meantime, I would suggest downloading the component manually (see SVN instructions above). The code is well tested and we have been using it internally in our business for several months.

    Let me know how you come along.

    Jonathan Maron

  4. Matthew Weier O'Phinney Says:

    It will be included in 1.10, which will release sometime in Q4 of this year; we haven’t set a solid date yet.

    It will be in trunk before that, however, and likely as early as next week. :)

  5. Jonathan Maron Says:

    Hello Matthew

    Thank you for this great piece of news. We very much look forward to becoming an official part of the Zend Framework.

    Jonathan Maron

  6. Jonathan Maron Says:

    Zend_Service_LiveDocx has just appeared in the official roadmap for Zend Framework 1.10:

    http://framework.zend.com/roadmap/1.10.0

    Jonathan Maron

Leave a Reply