Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dereuromark/cakephp-dto
CakePHP DTO plugin - quickly generate useful data transfer objects for your app (mutable/immutable)
https://github.com/dereuromark/cakephp-dto
data-transfer transfer-objects
Last synced: 3 months ago
JSON representation
CakePHP DTO plugin - quickly generate useful data transfer objects for your app (mutable/immutable)
- Host: GitHub
- URL: https://github.com/dereuromark/cakephp-dto
- Owner: dereuromark
- License: mit
- Created: 2018-12-07T22:03:29.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-31T22:09:54.000Z (3 months ago)
- Last Synced: 2024-03-31T23:21:30.487Z (3 months ago)
- Topics: data-transfer, transfer-objects
- Language: PHP
- Homepage:
- Size: 523 KB
- Stars: 24
- Watchers: 5
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Lists
- awesome-cakephp - CakeDto plugin - Quickly generate useful data transfer objects for your app (mutable/immutable), replacing messy arrays and leveraging your IDE through typehinting and autocomplete. (Miscellaneous)
README
# CakePHP DTO plugin
[](https://github.com/dereuromark/cakephp-dto/actions/workflows/ci.yml?query=branch%3Amaster)
[](https://codecov.io/gh/dereuromark/cakephp-dto)
[](https://packagist.org/packages/dereuromark/cakephp-dto)
[](https://php.net/)
[](LICENSE)
[](https://packagist.org/packages/dereuromark/cakephp-dto)
[](https://github.com/php-fig-rectified/fig-rectified-standards)
A Data Transfer Object (DTO) is an object used to pass typed data between layers in your application, similar in
concept to [Structs](https://en.wikipedia.org/wiki/Struct_(C_programming_language)) in C, Martin Fowler's [Transfer
Objects](http://martinfowler.com/eaaCatalog/dataTransferObject.html), or [Value Objects](https://en.wikipedia.org/wiki/Value_object).
The goal of this package is to structure "unstructured data", replacing simple (associative) arrays with a more speaking solution.
- By making all fields typeable, we can be sure that their values are never something we didn't expect.
Especially with modern PHP and more strict typehinting moving forward this is rather important to detect and fail early.
- We can have full IDE autocomplete and typehinting.
- We can use tools like PHPStan to statically analyze the code (more strictly).
- We can simplify the logic where required fields will now just throw a meaningful exception.
- We can work with different inflections of field names more easily.
- Easy way of immutable DTOs with required fields, to trust them in following code.
- Works out of the box with any [value object](https://github.com/Serhii-DV/awesome-php-value-objects) that is serializable (either as array or string).
For more see [Motivation and Background](/docs/Motivation.md).
This plugin will provide you with a tool to quickly generate custom and optimized DTOs for your special use cases.
This branch is for use with **CakePHP 5.0+**. For details see [version map](https://github.com/dereuromark/cakephp-dto/wiki#cakephp-version-map).
## Examples
Live examples in the Sandbox: [Github Demo](https://sandbox.dereuromark.de/sandbox/dto-examples/github).
See [Examples](docs/Examples.md) for basic, immutable and complex entity use cases.
The generated demo DTOs of those are in [tests/test_app/src/Dto/](tests/test_app/src/Dto/).
Note: Param/return types are enabled and strict types disabled by default.
## Installation
You can install this plugin into your CakePHP application using [Composer](https://getcomposer.org/).
```
composer require dereuromark/cakephp-dto
```
Then load the plugin with the following command:
```
bin/cake plugin load CakeDto
```
## Usage
See [Docs](docs/README.md) for details.