Download the PHP package zero-to-prod/data-model without Composer

Zerotoprod\DataModel

Simplify deserialization for your DTOs.

Use PHP Attributes to resolve and map values to properties on a class.

Transform data into hydrated objects by describing how to resolve values.

Features

• Simple Interface: A single entry point to create class instances from associative arrays or objects.
• Recursive Instantiation: Recursively instantiate classes based on their type.
• Type Casting: Supports primitives, custom classes, enums, and more.
• post.
• Transformations: Describe how to resolve a value before instantiation.
• Required Properties: Throw an exception when a property is not set.
• Default Values: Set a default property value.
• Nullable Missing Values: Resolve a missing value as null.
• Remapping: Re-map a key to a property of a different name.

Installation

You can install the package via Composer:

Examples

• Array of DataModels
• Collection of DataModels
• Laravel Validation

Additional Packages

• DataModelHelper: Helpers for a DataModel.
• DataModelFactory: A factory helper to set the value of your DataModel.
• Transformable: Transform a DataModel into different types.

Usage

Use the DataModel trait in a class.

Hydrating from Data

Use the from method to instantiate your class, passing an associative array or object.

Recursive Hydration

The DataModel trait recursively instantiates classes based on their type declarations. If a property’s type hint is a class, its value is passed to that class’s from() method.

In this example, the address element is automatically converted into an Address object, allowing direct access to its properties: $user->address->city.

Transformations

The DataModel trait provides a variety of ways to transform data before the value is assigned to a property.

The Describe attribute provides a declarative way describe how property values are resolved.

Describe Attribute

Resolve a value by adding the Describe attribute to a property.

The Describe attribute can accept these arguments.

Order of Precedence

There is an order of precedence when resolving a value for a property.

1. Property-level Cast
2. Method-level Cast
3. Union Types
4. Class-level Casts
5. Types that have a concrete static method from().
6. Native Types

Property-Level Cast

The using the Describe attribute directly on the property takes the highest precedence.

Life-Cycle Hooks

You can run methods before and after a value is resolved.

pre Hook

You can use pre to run a void method before the value is resolved.

post Hook

You can use post to run a void method after the value is resolved.

Method-level Cast

Use the Describe attribute to resolve values with class methods. Methods receive $value and $context as parameters.

Union Types

A value passed to property with a union type is directly assigned to the property. If you wish to resolve the value in a specific way, use a class method.

Class-Level Cast

You can define how to resolve different types at the class level.

Required Properties

Enforce that certain properties are required using the Describe attribute:

Default Values

You can set a default value for a property like this:

Nullable Missing Values

Set missing values to null by setting missing_as_null => true. This can be placed at the class or property level.

This prevents an Error when attempting to assess a property that has not been initialized.

Error: Typed property User::$age must not be accessed before initialization

Re-Mapping

You can map a key to a property of a different name like this:

Examples

Array of DataModels

This examples uses the DataModelHelper.

Collection of DataModels

This examples uses the DataModelHelper and Laravel Collections.

Laravel Validation

By leveraging the pre life-cycle hook, you run a validator before a value is resolved.

Testing