This package comes with the much desired xml support for you Laravel project including middleware to accept only xml requests, http response in xml, and more utilities for xml conversions as well as validation.
Supports: Laravel versions v5.3 and above
$ composer require bmatovu/laravel-xml
Get the request content (body).
$request->xml();
* Returns Bmatovu\LaravelXml\Support\XMLElement
object.
Determine if the request content type is XML.
$request->isXml();
Determine if the current request is accepting XML.
$request->wantsXml();
Validate XML content
Xml::is_valid($request->xml());
Validation - Against XML Schema Definition
$errors = Xml::validate($request->xml(), 'path_to/sample.xsd');
if ($errors) {
return response()->xml(['error' => $errors], 422);
}
Expects an array, convent you're objects to arrays prior...
Route::get('/users', function () {
$users = App\User::all();
return response()->xml(['users' => $users->toArray()]);
});
Sample response from above snippet
<?xml version="1.0" encoding="UTF-8"?>
<document>
<users>
<id>1</id>
<name>John Doe</name>
<email>jdoe@example.com</email>
<created_at>2018-07-12 17:06:13</created_at>
<updated_at>2018-07-12 18:00:05</updated_at>
</users>
<users>
<id>2</id>
<name>Gary Plant</name>
<email>gplant@example.com</email>
<created_at>2018-07-12 18:02:26</created_at>
<updated_at>2018-07-13 11:22:44</updated_at>
</users>
</document>
And will automatically set the content type to xml
Content-Type → text/xml; charset=UTF-8
First register the middleware in app\Http\Kernel.php
protected $routeMiddleware = [
// ...
'xml' => \Bmatovu\LaravelXml\Http\Middleware\RequireXml::class,
];
Then use the middleware on your routes, or in the controllers.
Route::post('/user/store', function (Request, $request) {
// do something...
})->middleware('xml');
In case of the request content-type
is not xml, the response will be;
[415
- Unsupported Media Type]
<?xml version="1.0" encoding="UTF-8"?>
<document>
<error>Only accepting xml content</error>
</document>
Encode: Array to Xml
Xml::encode(['key' => 'value']);
Or
xml_encode(['key' => 'value']);
Decode: Xml to Array
Xml::decode('<?xml version="1.0" encoding="UTF-8"?><document><key>value</key></document>');
Or
xml_decode('<?xml version="1.0" encoding="UTF-8"?><document><key>value</key></document>');
Under the hood, I'm using;
Spatie's array to XML convernsion
Hakre's XML to JSON conversion
If you've stumbled across a bug, please help us by leaving as much information about the bug as possible, e.g.
- Steps to reproduce
- Expected result
- Actual result
This will help us to fix the bug as quickly as possible, and if you do wish to fix it yourself; feel free to fork the package on GitHub and submit a pull request!