vierbergenlars/xml

XML

, _(*1)

A sane wrapper around SimpleXML, _(*2)

• Installation
• Usage
• Reference
  • XmlElementInterface
  • XmlCollectionInterface
  • XmlAttributesInterface
• License

Installation

composer require vierbergenlars/xml:@stable, _(*3)

Protip: you should browse the vierbergenlars/xml page to choose a stable version to use, avoid the @stable meta constraint., _(*4)

Usage

Only the XmlElement class should be instanciated in your code., _(*5)

use vierbergenlars\Xml\XmlElement;

$simpleXml = new \SimpleXMLElement($xml);
$xmlElement = new XmlElement($simpleXml);

The examples are based around following xml structure:, _(*6)

<?xml version="1.0" encoding="UTF-8"?>
<result page="1" items_per_page="2" total="2">
  <entry id="30">
    <filename><![CDATA[Screenshot from 2013-10-21 19:31:42.png]]></filename>
    <course id="1"><![CDATA[Algebra]]></course>
    <type id="1"><![CDATA[Exercise]]></type>
    <link rel="self" href="/files/30" type="api"/>
    <link rel="self" href="http://example.invalid/file/Algebra/Exercise/Screenshot%20from%202013-10-21%2019:31:42.png" type="www"/>
    <link rel="author" href="/users/vierbergenlars"/>
  </entry>
  <entry id="40">
    <filename><![CDATA[Screen Shot 2013-11-17 at 13.34.30.xcf]]></filename>
    <course id="1"><![CDATA[Analyse]]></course>
    <type id="1"><![CDATA[Slides]]></type>
    <link rel="self" href="/files/40" type="api"/>
    <link rel="self" href="http://example.invalid/file/Algebra/Slides/Screen%20Shot%202013-11-17%20at%2013.34.30.xcf" type="www"/>
    <link rel="author" href="/users/vierbergenlars"/>
  </entry>
</result>

This example is a copy of example.php, which is available in the repository for experimentation., _(*7)

$totalPages = ceil($xmlElement->attr('total') / $xmlElement->attr('items_per_page'));
echo $xmlElement->attr('page') . '/' . $totalPages . "\n";

XmlElement::attr($name) gets the value of the XML attribute $name on the current element., _(*8)

$files = $xmlElement->children();
/* @var $files XmlCollectionInterface */

XmlElement::children() gets the immediate children of the current element. The result implements XmlCollectionInterface. It is an Iterator, implements ArrayAccess and Countable., _(*9)

For easier chaining in PHP 5.3, a $XmlCollectionInterface->get($idx) function is provided, which has the same effect as $XmlCollectionInterface[$idx]., _(*10)

A ->find($attrs = array()) function is provided that returns a new XmlCollectionInterface, which only contains elements with the attributes passed to the function., _(*11)

foreach($files as $file) {
    /* @var $file XmlElementInterface */
    echo 'File ' . $file->attr('id') . ":\n";
    echo '  Filename: ' . $file->child('filename')->text() . "\n";

The first element is selected, and the text between its tags is returned (with ->text()).`, _(*12)

    echo "  Links:\n";
    foreach($file->children('link') as $link) {

Here, the children of $file are filtered to contain only elements with tagname <link>., _(*13)

        /* @var $link XmlElementInterface */
        echo '    ' . $link->attr('href');
        foreach($link->attributes() as $attr => $value) {

All attributes from the <link> element are selected. $link->attributes() returns an implementation of XmlAttributesInterface. The object acts as a read-only array with attribute names as keys and attribute values as value. Additionally, it has a ->get($idx) function for easier chaining., _(*14)

            if($attr != 'href')
                echo ' (' . $attr . '=' . $value . ')';
        }
        echo "\n";
    }

    echo '  Weblink: ' . $file->children('link')->find(array('rel'  => 'self', 'type' => 'www'))->get(0)->attr('href') . "\n";

This is an example of using XmlCollectionInterface::find() to only select the one <link> element with the desired attributes. An equivalent using XmlElementInterface::child() is commented-out below., _(*15)

//    echo '  Weblink: ' . $file->child('link', array('rel'  => 'self', 'type' => 'www'))->attr('href') . "\n";
}

echo 'Total: ' . $files->count() . "\n";

Reference

XmlElementInterface

XmlCollectionInterface

Implements interfaces Iterator, ArrayAccess, Countable, _(*16)

1. This object implements ArrayAccess:, _(*17)

   • $xmlCollectionInterface[$offset] calls $xmlCollectionInterface->offsetGet($offset)
   • isset($xmlCollectionInterface[$offset]) calls $xmlCollectionInterface->offsetExists($offset)
   • $xmlCollectionInterface[$offset] = $mixed calls $xmlCollectionInterface->offsetSet($offset, $mixed) and throws an exception.
   • unset($xmlCollectionInterface[$offset]) calls $xmlCollectionInterface->offsetUnset($offset)

2. This object implements Countable:, _(*18)

   • count($xmlCollectionInterface) calls $xmlCollectionInterface->count()

3. This object implements Iterator, _(*19)

   • foreach($xmlCollectionInterface as $key => $value){} calls $xmlCollectionInterface->rewind() once, $xmlCollectionInterface->valid() before each iteration, and if it returns true sets $key = $xmlCollectionInterface->key(); $value = $xmlCollectionInterface->current(). Finally calls $xmlCollectionInterface->next().

XmlAttributesInterface

Implements interfaces Iterator, ArrayAccess, Countable, _(*20)

1. This object implements ArrayAccess:, _(*21)

   • $xmlAttributesInterface[$offset] calls $xmlAttributesInterface->offsetGet($offset)
   • isset($xmlAttributesInterface[$offset]) calls $xmlAttributesInterface->offsetExists($offset)
   • $xmlAttributesInterface[$offset] = $mixed calls $xmlAttributesInterface->offsetSet($offset, $mixed)
   • unset($xmlAttributesInterface[$offset]) calls $xmlAttributesInterface->offsetUnset($offset)

2. This object implements Countable:, _(*22)

   • count($xmlAttributesInterface) calls $xmlAttributesInterface->count()

3. This object implements Iterator, _(*23)

   • foreach($xmlAttributesInterface as $key => $value){} calls $xmlAttributesInterface->rewind() once, $xmlAttributesInterface->valid() before each iteration, and if it returns true sets $key = $xmlAttributesInterface->key(); $value = $xmlAttributesInterface->current(). Finally calls $xmlAttributesInterface->next().

License

MIT, _(*24)