astronati/wordpress-api-response-parser

Allows to map responses provided by any Wordpress API.

, _(*1)

Wordpress API Response Parser

Allows to map responses provided by Wordpress API., _(*2)

Supported Responses

Not all responses are currently supported but we are happy to work for you if you need some of them., _(*3)

NOTE: To add another response into the supported list, please file a new issue., _(*4)

To do that please file a new issue., _(*5)

Installation

You can install the library and its dependencies using composer running:, _(*6)

$ composer require astronati/wordpress-api-response-parser

Usage

The library allows to return a model per each response and its content (post, tag, category, etc...)., _(*7)

Example

The following snippet can be helpful:, _(*8)

use WARP\Response\ResponseParser;
...
// Obtain a Response
$apiResponse = ['id' => 123, ...] // Save the response from a Wordpress API
$response = ResponseParser::create($apiResponse, ResponseParser::CREATE_POST);
...
// Get post
$post = $response->getPost();
echo $post->getID(); // 123

For more details please take a look at Response., _(*9)

Development

The environment requires phpunit, that has been already included in the dev-dependencies of the composer.json., _(*10)

Dependencies

To install all modules you just need to run following command:, _(*11)

$ composer install

Testing

Tests files are created in dedicates folders that replicate the src structure as follows:, _(*12)

.
+-- src
|   +-- [folder-name]
|   |   +-- [file-name].php
|   ...
+-- tests
|   +-- [folder-name]
|   |   +-- [file-name]Test.php

Execute following command to run the tests suite:, _(*13)

$ composer test

Run what follows to see the code coverage:, _(*14)

$ composer coverage

License

This package is released under the MIT license., _(*15)