[v4] Update docs #658
[v4] Update docs #658
Conversation
| SongData::collect(Song::all()); // returns a DataCollection of SongData objects | ||
| SongData::collect(Song::paginate()); // returns a PaginatedDataCollection of SongData objects | ||
| SongData::collect(Song::cursorPaginate()); // returns a CursorPaginatedCollection of SongData objects | ||
| SongData::collection(Song::all()); // returns a DataCollection of SongData objects | ||
| SongData::collection(Song::paginate()); // returns a PaginatedDataCollection of SongData objects | ||
| SongData::collection(Song::cursorPaginate()); // returns a CursorPaginatedCollection of SongData objects |
There was a problem hiding this comment.
I haven't used the previous versions of this pacakge, so I am not sure if this change is correct or not.
|
|
||
| ```json | ||
| { | ||
| "type": "\\App\\Data\\CdRecordConfig", | ||
| "value": { | ||
| "data": { |
There was a problem hiding this comment.
I looked at the source code and it seems the data object value will be stored under the data key and not the value.
Please correct/revert this if I am wrong.
| public static function prepareForPipeline(Collection $properties) : Collection | ||
| public static function prepareForPipeline(array $properties): array | ||
| { | ||
| $properties->put('metadata', $properties->only(['release_year', 'producer'])); | ||
|
|
||
| return $properties; | ||
| $collection = collect($properties); | ||
| $collection->put('metadata', $collection->only(['release_year', 'producer'])); | ||
|
|
||
| return $collection->toArray(); |
There was a problem hiding this comment.
I think @alexrififi did it much better with his PR.
So maybe merge this PR first and then merge his PR, so it override this one.
I know it is much easier to change it here, but I didn't change it here because it felt like stealing 😁
| @@ -63,4 +63,6 @@ class ArrayableNormalizer implements Normalizer | |||
| } | |||
| ``` | |||
|
|
|||
| Normalizers are executed the order as they are defined in the `normalize` method. The first normalizer not returning null will be used to normalize the payload. Magical creation methods always have precedence on normalizers. | |||
There was a problem hiding this comment.
Let's keep these on one line, the spate docs site will make sure they're readable
| @@ -128,7 +129,9 @@ Since the collection type here is a `Collection`, the package will automatically | |||
|
|
|||
| ## DataCollection's, PaginatedDataCollection's and CursorPaginatedCollection's | |||
|
|
|||
| The package also provides a few collection classes which can be used to create collections of data objects, it was a requirement to use these classes in the past versions of the package when nesting data objects collections in data objects. This is no longer the case and there are still valid use cases for them. | |||
There was a problem hiding this comment.
Let's keep these on one line, the spate docs site will make sure they're readable
| @@ -30,7 +15,11 @@ Or transform a data object to an array: | |||
| SongData::from(Song::first())->toArray(); | |||
| ``` | |||
|
|
|||
| By default, calling `toArray` on a data object will transform all properties to an array. This means that nested data objects and collections of data objects will also be transformed to arrays. Other complex types like `Carbon`, `DateTime`, `Enums`, ... will be transformed into a string. We'll see in the [transformers](/docs/laravel-data/v4/as-a-resource/transformers) section how to configure and customize this behavior. | |||
There was a problem hiding this comment.
Let's keep these on one line, the spate docs site will make sure they're readable
| @@ -129,4 +118,5 @@ class AlbumData extends Data | |||
| } | |||
| ``` | |||
|
|
|||
| As always, don't forget to type collections of data objects by annotation or the `DataCollectionOf` attribute, this is essential to transform these collections correctly. | |||
| As always, remember to type collections of data objects by annotation or the `DataCollectionOf` attribute, | |||
There was a problem hiding this comment.
Let's keep these on one line, the spate docs site will make sure they're readable
| A data object can automatically be transformed into an array as such: | ||
|
|
||
| ```php | ||
| SongData::from(Song::first())->toArray(); | ||
| ``` | ||
|
|
||
| Which will output the following array: | ||
|
|
||
| ```php | ||
| [ | ||
| 'name' => 'Never gonna give you up', | ||
| 'artist' => 'Rick Astley' | ||
| ] | ||
| ``` | ||
|
|
There was a problem hiding this comment.
I think this is removed due to being repeated on line 30 but let's keep this introduction.
There was a problem hiding this comment.
@rubenvanassche Yep, exattly. As it will be repeated literraly right after it. So you can count the next one as the intro too 👀
Just give the last word on reverting or keeping this change and I'll update it accordingly. 💪
There was a problem hiding this comment.
Let's keep it as is, I'll fix it after merging the PR
|
Good PR, thanks! |
I just started using this awesome package and I thought It might be a good idea to fix/improve the docs as a way to contribute back while I am at it.
Ill mark it asreadywhen I can't find the time to continute working on it or I reach the end of the docs!