mtownsend5512 / collection-xml

The missing XML support for Laravel's Collection class.

The missing XML support for Laravel's Collection class.

This package is designed to work with the Laravel framework.

Installation

Install via composer:

composer require mtownsend/collection-xml

Registering the service provider

For Laravel 5.4 and lower, add the following line to your config/app.php:

/*
 * Package Service Providers...
 */
Mtownsend\CollectionXml\Providers\CollectionXmlServiceProvider::class,

For Laravel 5.5 and greater, the package will auto register the provider for you.

Using Lumen

To register the service provider, add the following line to app/bootstrap/app.php:

$app->register(Mtownsend\CollectionXml\Providers\CollectionXmlServiceProvider::class);

Quick start

Collection to xml

Convert data inside a Laravel Collection into valid XML:

$collection = collect([
    'carrier' => 'fedex',
    'id' => 123,
    'tracking_number' => '9205590164917312751089',
]);

$xml = $collection->toXml();

// Returns
<?xml version="1.0"?>
<root>
    <carrier>fedex</carrier>
    <id>123</id>
    <tracking_number>9205590164917312751089</tracking_number>
</root>

Collection to soap xml

Heads up, this method is the most temperamental part of this package. Please thoroughly check your SOAP endpoint and requirements for best usage.

$collection = collect([
    'carrier' => 'fedex',
    'id' => 123,
    'tracking_number' => '9205590164917312751089',
]);

$xml = $collection->toSoapXml('request', 'xmlBody', 'https://yourwebserver/service.asmx?wsdl');

// Returns
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ns1="https://yourwebserver/service.asmx?wsdl">
    <SOAP-ENV:Body>
        <ns1:ProcessXMLRequest>
            <ns1:xmlBody>
                <?xml version="1.0"?>
                <request>
                    <carrier>fedex</carrier>
                    <id>123</id>
                    <tracking_number>9205590164917312751089</tracking_number>
                </request>
            </ns1:xmlBody>
        </ns1:ProcessXMLRequest>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Please note: the SoapFactory class will ping the $fullUrl to see if it is valid as it builds the SOAP xml. It will not trigger an api interaction, but you will experience an exception if your url is invalid.

Array to xml

Convert an array into xml without using a collection:

$array = [
    'carrier' => 'fedex',
    'id' => 123,
    'tracking_number' => '9205590164917312751089',
];

$xml = array_to_xml($array);

Helpers, methods, and arguments

Helper

array_to_xml($array, $root = '')

The $root argument allows you to customize the root xml element. Default is <root>.

Collection method

->toXml($root)

See array_to_xml() above.

Collection method

->toSoapXml($root = '', $soapRoot = '', $fullUrl, array $options = [])

The $root argument allows you to customize the inner root xml element. Default is <root>.

$soapRoot is the outer xml root element. Default is xmlBody.

$fullUrl will be the fully qualified SOAP endpoint e.g. https://yourwebserver/service.asmx?wsdl. Please note: the SoapFactory class will ping the $fullUrl to see if it is valid as it builds the SOAP xml. It will not trigger an api interaction, but you will experience an exception if your url is invalid.

$options will be an array of valid options for PHP's SoapClient class. By default ['trace' => 1] is set.

Purpose

Laravel has always favored json over xml with its api structure. Inevitably, developers will be required to interact with files or apis that require xml, and they are often left to figure it out for themselves.

This package aims to bring painless xml support to Laravel's Collection class, and bring a few useful helpers along.

Other packages you may be interested in

• mtownsend/request-xml
• mtownsend/response-xml
• mtownsend/xml-to-array

Credits

• Mark Townsend
• Spatie
• All Contributors

Testing

You can run the tests with:

./vendor/bin/phpunit

License

The MIT License (MIT). Please see License File for more information.

collection-xml's Issues

Using attributes

How can I create xml with attributes?

for example, to generate this

<?xml version="1.0"?>
<root>
  <element>value</element>
  <nested_element attribute="attribute_value">nested_value</nested_element>
</root>

Add namespaces to the root element

How can I add namespaces to the root element?
So that it returns something like:

<CustomRoot xmlns:ds="XXX" xmlns:p="YYY" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" parameter="ZZZ" xsi:schemaLocation="http://someurl/file.xsd">

At the moment I'm using str_replace

Thanks in advance!

Laravel 9 compatibility

It is not working with the latest version of Laravel, L9. Used it in L8 and intend to upgrade to the latest version but it is not working.