cakephp-dto

KO | EN

gitlite — search

#python #react #java #deep-learning #github-config #reactjs #telegram #machine-learning #rust #nodejs #javascript #docker

★ 30 Open GitHub ↗

CakePHP DTO plugin - quickly generate useful data transfer objects for your app (mutable/immutable)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# CakePHP DTO plugin

[![CI](https://github.com/dereuromark/cakephp-dto/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/dereuromark/cakephp-dto/actions/workflows/ci.yml?query=branch%3Amaster)
[![codecov](https://img.shields.io/codecov/c/github/dereuromark/cakephp-dto/master.svg)](https://codecov.io/gh/dereuromark/cakephp-dto)
[![Latest Stable Version](https://poser.pugx.org/dereuromark/cakephp-dto/v/stable.svg)](https://packagist.org/packages/dereuromark/cakephp-dto)
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%208.2-8892BF.svg)](https://php.net/)
[![License](https://poser.pugx.org/dereuromark/cakephp-dto/license.svg)](https://raw.githubusercontent.com/dereuromark/cakephp-dto/master/LICENSE)
[![Total Downloads](https://poser.pugx.org/dereuromark/cakephp-dto/d/total.svg)](https://packagist.org/packages/dereuromark/cakephp-dto)
[![Coding Standards](https://img.shields.io/badge/cs-PSR--2--R-purple.svg?style=flat-square)](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.

**Unique approach:** Unlike other PHP DTO libraries that use runtime reflection, this plugin generates actual PHP code from configuration files.
This provides the best possible IDE support, static analysis compatibility, and runtime performance.
See [Motivation](https://github.com/php-collective/dto/blob/master/docs/Motivation.md) for a comparison with alternatives.

- 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).

This plugin will provide you with a tool to quickly generate custom and optimized DTOs for your special use cases.

CakePHP integration for [php-collective/dto](https://github.com/php-collective/dto).

This branch is for use with **CakePHP 5.1+**. 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, mapper, 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.

cakephp-dto

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README