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

Zerotoprod\DataModelHelper

Contents

• Introduction
• Requirements
• Installation
• Documentation Publishing
  • Automatic Documentation Publishing
• Usage
  • Including the Trait
• Helper Methods
  • when: Create a map of any type by using
  • mapOf: Create a map of any type by using
  • pregReplace: Perform a regular expression search and replace.
  • pregMatch: Perform a regular expression match.
  • isUrl: Validates a url.
  • isEmail: Validates an email.
  • isMultiple: Validate a value is a multiple of another.
• Local Development
• Contributing

Introduction

Utilities for casting values using the DataModel package.

Requirements

• PHP 8.1 or higher.
• The DataModel Composer package

Installation

Install Zerotoprod\DataModelHelper via Composer:

This will add the package to your project’s dependencies and create an autoloader entry for it.

Documentation Publishing

You can publish this README to your local documentation directory.

This can be useful for providing documentation for AI agents.

This can be done using the included script:

Automatic Documentation Publishing

You can automatically publish documentation by adding the following to your composer.json:

Usage

Including the Trait

Include the DataModelHelper trait in your class to access helper methods:

Helper Methods

when

Use when to call a function based on a condition.

mapOf

Create a map of any type by using the DataModelHelper::mapOf() method.

Usage

In this case the mapOf() method returns an array of Alias instances.

This method will also work with enums.

Laravel Collection Example

The mapOf helper is designed to work will with the \Illuminate\Support\Collection class.

Coercing

Sometimes, an attribute may contain either a single element or an array of elements. By setting 'coerce' => true, you can ensure that single elements are coerced into an array.

Using a Custom Mapping Function

Specify your mapping function by setting the using option.

Specifying a Custom Mapping Method

By default, the map method is used to map over elements. You can specify a different method using the map_via option.

Deep Mapping

You can set the level for mapping deep arrays.

KeyBy

Key an array by an element value by using the key_by argument.

This also supports deep mapping.

Note: this only applies to arrays.

Map

Call a function for that value.

Note: This does not work with arrays.

pregReplace

Use pregReplace to perform a regular expression search and replace.

pregMatch

Use pregMatch to perform a regular expression match.

isUrl

Use isUrl to validate an url.

isEmail

Use isEmail to validate an email.

isMultiple

Use isMultiple to validate a value is a multiple of another.

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page if you want to contribute.

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Commit changes (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature-branch).
5. Create a new Pull Request.