nacosvel/transformer

rule-driven data projection and transformation.

v1.0.0 2025-12-16 09:41 UTC

Requires

• php: ^8.0
• nacosvel/pipeline: ^1.1

Requires (Dev)

• code-lts/doctum: ^5.0

MIT

• jundayw

• transformer
• Nacosvel

README

Transformer

rule-driven data projection and transformation.

Table of Contents

1. Installation
2. Usage
3. Contributing
4. Contributors
5. License

Installation

You can install the package via Composer:

composer require nacosvel/transformer

[back to top]

规则类说明表

规则	类型	作用	适用场景
ConditionRule	条件规则	根据指定条件过滤、筛选或转换数据，仅当满足条件时执行对应的转换逻辑	1. 仅对特定状态（如“已支付”）的数据进行转换； 2. 根据字段值范围（如金额>100）调整数据展示； 3. 多分支条件下的差异化数据处理
DefaultValueRule	默认值规则	为字段设置预设默认值，保证数据完整性	1. 未填写的用户昵称默认填充为“匿名用户”； 2. 接口返回的空数字字段默认设为0； 3. 缺失的时间字段默认填充为当前时间
FieldMappingRule	字段映射规则	映射源字段与目标字段的名称/值对应关系，实现字段名重命名或值的静态映射	1. 第三方接口字段名（如user_name）映射为本地规范字段（如userName）； 2. 枚举值映射（如1→“男”、2→“女”）； 3. 多数据源字段统一命名
InvokeRule	调用规则	调用自定义方法/函数/服务对字段进行动态转换，支持复杂业务逻辑的嵌入	1. 对手机号进行脱敏处理（调用脱敏函数）； 2. 通过用户ID调用用户服务获取用户名； 3. 对金额字段调用汇率转换方法进行币种换算
MetadataRule	源数据规则	基于源数据填充	--
NestedMappingRule	嵌套映射规则	处理嵌套结构（如对象、数组）的字段映射，支持多层级数据的转换	1. 嵌套对象（如user.address）的字段重命名； 2. 数组内元素的字段映射（如order.items中的price字段）； 3. 多层嵌套数据的扁平化处理

Rule Class Description Table

Rule Type	Function	Applicable Scenarios
ConditionRule	Filter, screen or transform data according to specified conditions, and execute the corresponding transformation logic only when the conditions are met	1. Transform data only for specific status (e.g., "Paid"); 2. Adjust data display according to field value range (e.g., amount > 100); 3. Differentiated data processing under multi-branch conditions
DefaultValueRule	Set default values for fields to ensure data integrity.	1. Default fill "Anonymous User" for unfilled user nicknames; 2. Default set empty numeric fields returned by the interface to 0; 3. Default fill missing time fields with current time
FieldMappingRule	Map the name/value correspondence between source fields and target fields to realize field name renaming or static mapping of values	1. Map third-party interface field names (e.g., user_name) to local standard fields (e.g., userName); 2. Enumeration value mapping (e.g., 1→"Male", 2→"Female"); 3. Unified naming of multi-data source fields
InvokeRule	Call custom methods/functions/services to dynamically transform fields, supporting the embedding of complex business logic	1. Desensitize mobile phone numbers (call desensitization function); 2. Get username by calling user service via user ID; 3. Convert currency of amount fields by calling exchange rate conversion method
MetadataRule	Metadata-based population	--
NestedMappingRule	Handle field mapping of nested structures (e.g., objects, arrays) and support transformation of multi-level data	1. Field renaming of nested objects (e.g., user.address); 2. Field mapping of elements in arrays (e.g., price field in order.items); 3. Flattening of multi-level nested data

Usage

$originals = [
    'total_fee'           => 9900,
    'intent'              => 'CAPTURE',
    'purchase_units'      => [
        [
            'reference_id' => 'ORD20250520001',
            'amount'       => [
                'currency_code' => 'USD',
                'value'         => '99.00',
            ],
        ],
    ],
    'application_context' => [
        'return_url' => 'https://example.com/pay/return',
        'cancel_url' => 'https://example.com/pay/notify/paypal',
    ],
];

$targets = [];

Converter::convert

$response = Converter::convert($originals, [
    $rule = new FieldMappingRule(
        'total_fee',
        'amount',
        fn($value) => $value / 100
    ),
    $rule = new NestedMappingRule(
        'purchase_units.0.amount.currency_code',
        'payment_code',
    ),
], [
    'default_value' => '1234567890',
]);

{
    "default_value": "1234567890",
    "amount": 99,
    "payment_code": "USD"
}

ConditionRule::class

use Nacosvel\Transformer\ConditionRule;

$rule = new ConditionRule(
    fn($originals, $targets) => isset($originals['total_fee']),
    function ($originals, $targets) {
        $targets['amount'] = $originals['total_fee'] / 100;
        return $targets;
    }
);

{
    "amount": 99
}

DefaultValueRule::class

use Nacosvel\Transformer\DefaultValueRule;

$rule = new DefaultValueRule(
    'trade_type', 'JSAPI'
);

{
    "trade_type": "JSAPI"
}

FieldMappingRule::class

use Nacosvel\Transformer\FieldMappingRule;

$rule = new FieldMappingRule(
    'total_fee',
    'amount',
    fn($value) => $value / 100
);

{
    "amount": 99
}

InvokeRule::class

use Nacosvel\Transformer\InvokeRule;

$rule = new InvokeRule(function ($originals, $targets) {
    return [
        'amount' => $originals['total_fee'] / 100,
    ];
});

{
    "amount": 99
}

NestedMappingRule::class

use Nacosvel\Transformer\NestedMappingRule;

$rule = new NestedMappingRule(
    'purchase_units.0.amount.currency_code',
    'application.context.0.code',
);

{
    "application": {
        "context": [
            {
                "code": "USD"
            }
        ]
    }
}

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

[back to top]

Contributors

Thanks goes to these wonderful people:

Contributions of any kind are welcome!

[back to top]

License

Distributed under the MIT License (MIT). Please see License File for more information.

[back to top]