Zend Framework: Zend_Xml Component Proposal

Proposed Component Name	Zend_Xml
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Xml
Proposers	Daniele Orlando
Revision	0.1 - 1 August 2006: Initial Release (wiki revision: 8)

Zend_Xml is a component that allow you to read nodes, create roots, append childs, set attributes, create texts in a XML resource, simply passing an XPath string or an array of strings with few or no parameters.
For instance, recursive operation on different xml node can be done passing an array of xpath strings.
In the same way, passing an xpath string and an array of node name strings, we can add many childs in just one function call.
This is possible combining the simplicity of the XPath syntax with the DOM versatility.
Simply useful.

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

Zend_Xml is a low level library for XML Document creation and manipulation.

This component will not supports conversion in other markup languages or document types.
This component must supports all PHP DOM methods.

4. Dependencies on Other Framework Components

Zend_Exception

5. Theory of Operation

Instantiate Zend_Xml with the root name(s) of the xml document and, if required, the external stylesheet.
Now, you are ready to build your XML document quickly and with total control on every operation.

6. Milestones / Tasks

Milestone 1: [DONE] Base operations support
Milestone 2: Full support for PHP DOM methods
Milestone 3: Support for pre-existent DOMDocument and SimpleXML objects
Milestone 4: Performance tuning

7. Class Index

Zend_Xml - xml creation and manipulation class
Zend_Xml_Exception - exception handler

8. Use Cases

UC-01

Creation of a new XML document with an external stylesheet:

<?php

$xml = new Zend_Xml( 'Service' , 'http://www.domain.dom/xsl/stylesheet.xsl' ) ;

?>

<?xml version="1.0" encoding="UTF-8"?>
<?xmlstylesheet type="text/xsl" encoding="UTF-8" href="http://www.domain.dom/xsl/stylesheet.xsl" indent="yes"?>
<Service/>

UC-02

Basic editing:

<?php

$xml = new Zend_Xml( 'Service' ) ;
$xml->appendChild( '//' , array('username'=>'Daniele Orlando') , array('type'=>'string') ) ;

?>

<?xml version="1.0" encoding="UTF-8"?>
<Service>
    <username type="string">
        Daniele Orlando
    </username>
</Service>

UC-03

Recursive operations:

<?php

$xml = new Zend_Xml( 'Service' ) ;
$xml->appendChild( '//' , array('users'=>'','devel'=>'') ) ;
$xml->appendChild( array('//users','//devel') , array('username'=>'Daniele Orlando') , array('type'=>'string') ) ;
$xml->setAttribute( '//users' , array('level'=>'restricted') ) ;

?>

<?xml version="1.0" encoding="UTF-8"?>
<Service>
    <users level="restricted">
        <username type="string">
            Daniele Orlando
        </username>
    </users>
    <devel>
        <username type="string">
            Daniele Orlando
        </username>
    </devel>
</Service>

9. Class Skeletons

The complete class is in "Attachments"

<?php

class Zend_Xml
{
    public $Dom ;

    public function __construct( $roots = null , $stylesheet = null ) ;

    public function getNode( $xpath , $index = null ) ;

    public function existsNode( $xpath , $index = null ) ;

    public function appendRoot( $roots ) ;

    public function appendChild( $xpaths , $childs , array $attributes = array() , $text = null ) ;

    public function setAttribute( $xpaths , $attributes ) ;

    public function createText( $xpaths , $texts ) ;
}

?>

Page Operations

Browse Space

Zend_Xml - Daniele Orlando

Labels