Skip to content

Commit 7360166

Browse files
author
Phil Sturgeon
committed
Updated README and whatnot.
1 parent e9865cc commit 7360166

File tree

3 files changed

+28
-12
lines changed

3 files changed

+28
-12
lines changed

CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
## 0.8.0 (2014-05-27)
2+
3+
Features:
4+
5+
- Added Serializers with ArraySerializer, DataArraySerializer (default) and a provisional JsonApiSerializer. See [Issue #47].
6+
- Added `ResourceAbstract::setMeta('foo', mixed)` to allow custom meta data
7+
- Replaced `Manager::setRequestedScopes()` with `Manager::parseIncludes('foo,bar')` which can be an array or CSV string. It can
8+
also take "Smart Syntax" such as `Manager::parseIncludes('bars:limit(5|1):order(-something)')`, which can come from a URL query
9+
param: `/foo?include=bars:limit(5|1):order(-something)`.
10+
- Made all pagination (paginators and cursors) use meta output logic, so it sits with your custom meta data
11+
- Moved `League\Fractal\Cursor\Cursor` and `League\Fractal\Cursor\CursorInterface` into `League\Fractal\Pagination`.
12+
13+
[Issue #27]: https://github.com/thephpleague/fractal/issues/27
14+
[Issue #47]: https://github.com/thephpleague/fractal/pull/47
15+
116
## 0.7.0 (2014-02-01)
217

318
Features:

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,23 @@
66
[![Latest Stable Version](https://poser.pugx.org/league/fractal/v/stable.png)](https://packagist.org/packages/league/fractal)
77

88
Fractal provides a presentation and transformation layer for complex data output, the like found in
9-
RESTful APIs, and works really well with JSON.
9+
RESTful APIs, and works really well with JSON. Think of this as a view layer for your JSON/YAML/etc.
1010

1111
When building an API it is common for people to just grab stuff from the database and pass it
12-
to `json_encode()`. This might be passable for "trivial" API's but if they are in use by the public,
13-
or used by an iPhone application then this will quickly lead to inconsistent output.
12+
to `json_encode()`. This might be passable for "trivial" APIs but if they are in use by the public,
13+
or used by mobile applications then this will quickly lead to inconsistent output.
1414

1515
## Goals
1616

1717
* Create a "barrier" between source data and output, so schema changes do not affect users
18-
* Systematic type-casting of data, to avoid foreach()ing through and (bool)ing everything
19-
* Embed (or nest) relationships for complex data structures
18+
* Systematic type-casting of data, to avoid `foreach()`ing through and `(bool)`ing everything
19+
* Include (a.k.a embedding, nesting or side-loading) relationships for complex data structures
20+
* Work with standards like HAL and JSON-API but also allow custom serialization
2021
* Support the pagination of data results, for small and large data sets alike
2122
* Generally ease the subtle complexities of outputting data in a non-trivial API
2223

23-
This package is compliant with [PSR-1][], [PSR-2][] and [PSR-4][]. If you
24-
notice compliance oversights, please send a patch via pull request.
24+
This package is compliant with [PSR-1], [PSR-2] and [PSR-4]. If you notice compliance oversights,
25+
please send a patch via pull request.
2526

2627
[PSR-1]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md
2728
[PSR-2]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
@@ -48,9 +49,7 @@ The following versions of PHP are supported by this version.
4849
* PHP 5.4
4950
* PHP 5.5
5051
* PHP 5.6
51-
52-
HHVM support is also experimentally supported. It basically works, but CodeSniffer installation is screwing it up on
53-
Travis-CI.
52+
* HHVM
5453

5554
## Documentation
5655

@@ -61,7 +60,7 @@ Contribute to this documentation in the [sculpin branch](https://github.com/thep
6160
## Todo
6261

6362
- Wrap optional params in a ParamBag object or similar
64-
- Complete JSON-API and HAL serializers
63+
- Add JSON-API (kinda done) and HAL serializers
6564

6665
## Testing
6766

@@ -76,6 +75,7 @@ Please see [CONTRIBUTING](https://github.com/thephpleague/fractal/blob/master/CO
7675

7776
## Credits
7877

78+
- [Jason Lewis](https://github.com/jasonlewis)
7979
- [Phil Sturgeon](https://github.com/philsturgeon)
8080
- [All Contributors](https://github.com/thephpleague/fractal/contributors)
8181

composer.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
"keywords": [
55
"league",
66
"api",
7-
"json"
7+
"json",
8+
"rest"
89
],
910
"homepage": "http://fractal.thephpleague.com/",
1011
"license": "MIT",

0 commit comments

Comments
 (0)