Download the PHP package rkt/magento-data without Composer

Rkt_MageData

A powerful, lightweight Data Object & DTO (Data Transfer Object) system for Magento 2 — supporting smart instantiation, validation, and serialization.

🚀 Installation

✨ Features Overview

1. ✅ Easy Data Object Instantiation

Use the static from() or create() methods to easily instantiate data objects.

Example

You can instantiate it like this:

Or using create():

2. 🛡 Validation Built In

This module includes built-in validation using somnambulist/validation.

🔹 Basic Validation

Just define a rules() method in your data object:

You can validate array elements (like street.0) using dot notation.

🔹 Custom Validation Messages

Override messages():

🔹 Custom Field Aliases

Override aliases():

In error messages, email will now appear as "Email Address".

3. 🧩 Nested Object Validation

Nested and recursive validation works out of the box:

✅ In this setup:

• father and mother are required and must pass Person validation.
• children can be a list of Person, and they’ll be validated too (if provided).

4. 🔹 Custom Validation Rules via customRules()

You can define reusable or inline validation rules using customRules(). The package supports closure and class-based custom rules, and can also provide built-in reusable rules.

✅ 1. Closure-Based Rules

Use closures for simple, inline validation logic.

ℹ️ The closure is automatically registered using the callback rule provided by somnambulist/validation.

✅ 2. Custom Rule Class

For more reusable or complex logic, use a rule class. The given rule must be in compliance with somnambulist/validation. Basically the rule class must extend Somnambulist\Components\Validation\Rule.

✅ You can also return an instantiated object if needed — it will be registered directly.

🔹 Built-in Custom Rules

Rkt_MageData also contains reusable custom rules that you can register in customRules().

Current built-in rules:

• form_key → Rkt\MageData\Model\Validation\Rule\FormKeyRule

Example:

If you think that any other custom rules should be part of the package, then feel free to create an issue for it.

5. 🧵 Event-Driven Rule Customization

You can dynamically modify validation rules/messages/aliases using Magento events.

🔹 Example

🔸 Event Name

When validate() is called, the event rkt_example_data_mydata_validate_before is dispatched.

🔹 Observer Configuration (events.xml)

🔹 Sample Observer

✅ Now your validation dynamically adds the email rule and alias based on observer logic.

6. 🔄 Serialization Support

Convert data objects to array or JSON easily:

7. Fetch validations rules applicable to the data

You can get the validation rules applicable for a payload like this.

Now if you call

Will provide you below result:

📌 Notes

• This module is under active development — more features and integrations are coming soon!
• Built for flexibility, testability, and ease of use in Magento 2 backend and frontend service layers.

💬 Stay Connected

Got feedback or feature requests? PRs and ideas are welcome!