Skip to content

Commit bf95d97

Browse files
committed
Update docs and Readme, fix Code Coverage
1 parent 6c87df8 commit bf95d97

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ JsonApiClient can be used as a validator for JSON API contents:
6868
```php
6969
$wrong_jsonapi = '{"data":{},"meta":{"info":"This is wrong JSON API. `data` has to be `null` or containing at least `type` and `id`."}}';
7070

71-
if ( \Art4\JsonApiClient\Utils\Helper::isValid($wrong_jsonapi) )
71+
if ( \Art4\JsonApiClient\Utils\Helper::isValidResponseBody($wrong_jsonapi) )
7272
{
7373
echo 'string is valid.';
7474
}

docs/exception-introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ $wrong_jsonapi = '{"data":{},"meta":{"info":"This is wrong JSON API. `data` has
2323

2424
try
2525
{
26-
$document = \Art4\JsonApiClient\Utils\Helper::parse($wrong_jsonapi);
26+
$document = \Art4\JsonApiClient\Utils\Helper::parseResponseBody($wrong_jsonapi);
2727
}
2828
catch (\Art4\JsonApiClient\Exception\ValidationException $e)
2929
{

docs/objects-document.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ You can check for all possible values using the `has()` method.
2929
```php
3030
$jsonapi_string = '{"meta":{"info":"Testing the JsonApiClient library."}}';
3131

32-
$document = \Art4\JsonApiClient\Utils\Helper::parse($jsonapi_string);
32+
$document = \Art4\JsonApiClient\Utils\Helper::parseResponseBody($jsonapi_string);
3333

3434
var_dump($document->has('data'));
3535
var_dump($document->has('errors'));

docs/objects-introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ You can check for all possible values using the `has()` method.
5454
```php
5555
$jsonapi_string = '{"meta":{"info":"Testing the JsonApiClient library."}}';
5656

57-
$document = \Art4\JsonApiClient\Utils\Helper::parse($jsonapi_string);
57+
$document = \Art4\JsonApiClient\Utils\Helper::parseResponseBody($jsonapi_string);
5858

5959
var_dump($document->has('meta'));
6060
```

docs/utils-helper.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Assuming you have get a response from a JSON API server. Use `parse()` to work w
1212
// The Response body from a JSON API server
1313
$jsonapi_string = '{"meta":{"info":"Testing the JsonApiClient library."}}';
1414

15-
$document = \Art4\JsonApiClient\Utils\Helper::parse($jsonapi_string);
15+
$document = \Art4\JsonApiClient\Utils\Helper::parseResponseBody($jsonapi_string);
1616
```
1717

1818
This returns a [Document](objects-document.md) object which provided all contents.
@@ -46,7 +46,7 @@ JsonApiClient can be used as a validator:
4646
```php
4747
$wrong_jsonapi = '{"data":{},"meta":{"info":"This is wrong JSON API. `data` has to be `null` or containing at least `type` and `id`."}}';
4848

49-
if ( \Art4\JsonApiClient\Utils\Helper::isValid($wrong_jsonapi) )
49+
if ( \Art4\JsonApiClient\Utils\Helper::isValidResponseBody($wrong_jsonapi) )
5050
{
5151
echo 'string is valid.';
5252
}

tests/Unit/Utils/HelperTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ public function testParseWithValidJsonapiReturnsDocument()
161161
{
162162
$jsonapi = '{"meta":{}}';
163163

164-
$this->assertInstanceOf('Art4\JsonApiClient\Document', Helper::parseResponseBody($jsonapi));
164+
$this->assertInstanceOf('Art4\JsonApiClient\Document', Helper::parse($jsonapi));
165165
}
166166

167167
/**
@@ -173,7 +173,7 @@ public function testParseWithInvalidJsonapiThrowsException()
173173
{
174174
$invalid_jsonapi = '["This is valid JSON", "but invalid JSON API"]';
175175

176-
$output = Helper::parseResponseBody($invalid_jsonapi);
176+
$output = Helper::parse($invalid_jsonapi);
177177
}
178178

179179
/**
@@ -185,7 +185,7 @@ public function testParseWithInvalidJsonThrowsException()
185185
{
186186
$invalid_json = 'invalid_json_string';
187187

188-
$output = Helper::parseResponseBody($invalid_json);
188+
$output = Helper::parse($invalid_json);
189189
}
190190

191191
/**

0 commit comments

Comments
 (0)