Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tarkhov/guzzle-xml
Guzzle XML request and response.
https://github.com/tarkhov/guzzle-xml
composer guzzle php xml
Last synced: 24 days ago
JSON representation
Guzzle XML request and response.
- Host: GitHub
- URL: https://github.com/tarkhov/guzzle-xml
- Owner: tarkhov
- License: mit
- Created: 2018-01-20T09:33:07.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2022-01-13T00:27:54.000Z (almost 3 years ago)
- Last Synced: 2024-09-14T17:22:52.454Z (about 2 months ago)
- Topics: composer, guzzle, php, xml
- Language: PHP
- Homepage:
- Size: 23.4 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Guzzle XML
Guzzle XML request and response.
### Contents
1. [Compatibility](#compatibility)
1. [Version support](#version-support)
2. [Installation](#installation)
1. [Composer](#composer)
3. [Usage](#usage)
1. [Request options](#request-options)
2. [Response](#response)
4. [Author](#author)
5. [License](#license)
## Compatibility
Library | Version
------- | -------
PHP | >=7.2.5
Guzzle | >=7.0 and < 8.0
Symfony Serializer | >=5.0 and < 6.0
### Version support
Guzzle | PHP | Repo
------- | ------- | -------
6.x | >=5.5 | [0.x](https://github.com/tarkhov/guzzle-xml/tree/0.x)
7.x | >=7.2 | [1.x](https://github.com/tarkhov/guzzle-xml/tree/1.x)
## Installation
### Composer
```bash
composer require tarkhov/guzzle-xml
```
## Usage
### Request options
Following example creates POST request with XML body. Option `xml` accepts an array that is converted to XML document. About array format and how converting works you can read in detail [Symfony XmlEncoder](https://symfony.com/doc/current/components/serializer.html#the-xmlencoder).
```php
push(XmlMiddleware::xml(), 'xml');
$client = new Client(['handler' => $stack]);
$response = $client->post('https://example.com', [
'xml' => [
'package' => [
'@language' => 'PHP',
'name' => 'Guzzle XML',
'author' => [
'@role' => 'developer',
'#' => 'Alexander Tarkhov',
],
'support' => [
'issues' => 'https://github.com/tarkhov/guzzle-xml/issues',
'source' => 'https://github.com/tarkhov/guzzle-xml',
],
],
],
]);
```
As a result, an xml request will be sent with the header `Content-type: text/xml` and data with the following content:
```xml
Guzzle XML
Alexander Tarkhov
https://github.com/tarkhov/guzzle-xml/issues
https://github.com/tarkhov/guzzle-xml
```
### Response
Automatically convert your JSON response to XML using middleware.
```php
push(XmlMiddleware::jsonToXml());
$client = new Client(['handler' => $stack]);
$response = $client->post('https://example.com');
$xml = $response->getBody();
echo $xml;
```
If you json response is:
```json
{
"package": {
"@language":"PHP",
"name":"Guzzle XML",
"author": {
"@role":"developer",
"#":"Alexander Tarkhov"
},
"support": {
"issues":"https:\/\/github.com\/tarkhov\/guzzle-xml\/issues",
"source":"https:\/\/github.com\/tarkhov\/guzzle-xml"
}
}
}
```
This will automatically convert to XML like this:
```xml
Guzzle XML
Alexander Tarkhov
https://github.com/tarkhov/guzzle-xml/issues
https://github.com/tarkhov/guzzle-xml
```
## Author
**Alexander Tarkhov**
* [Twitter](https://twitter.com/alextarkhov)
* [Medium](https://medium.com/@tarkhov)
* [LinkedIn](https://www.linkedin.com/in/tarkhov/)
* [Facebook](https://www.facebook.com/alextarkhov)
## License
This project is licensed under the **MIT License** - see the `LICENSE` file for details.