{"id":20672792,"url":"https://github.com/selective-php/transformer","last_synced_at":"2026-03-07T12:06:27.725Z","repository":{"id":45543248,"uuid":"332880751","full_name":"selective-php/transformer","owner":"selective-php","description":"Transformation simplified","archived":false,"fork":false,"pushed_at":"2025-06-03T18:27:50.000Z","size":71,"stargazers_count":38,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-04T03:49:13.431Z","etag":null,"topics":["conversion","converter","hydrator","mapper","php","transformer"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/selective-php.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-01-25T20:54:16.000Z","updated_at":"2025-06-03T18:23:05.000Z","dependencies_parsed_at":"2023-12-28T21:24:35.514Z","dependency_job_id":"f3e60dee-fe76-4548-8fa1-418cf71af2b6","html_url":"https://github.com/selective-php/transformer","commit_stats":{"total_commits":69,"total_committers":3,"mean_commits":23.0,"dds":0.04347826086956519,"last_synced_commit":"69e94a1c4c4e68e16d726d22d4476b4fd571cdbd"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/selective-php/transformer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selective-php%2Ftransformer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selective-php%2Ftransformer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selective-php%2Ftransformer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selective-php%2Ftransformer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/selective-php","download_url":"https://codeload.github.com/selective-php/transformer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selective-php%2Ftransformer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30212505,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T09:02:10.694Z","status":"ssl_error","status_checked_at":"2026-03-07T09:02:08.429Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["conversion","converter","hydrator","mapper","php","transformer"],"created_at":"2024-11-16T20:38:50.003Z","updated_at":"2026-03-07T12:06:27.690Z","avatar_url":"https://github.com/selective-php.png","language":"PHP","readme":"# selective/transformer\n\nA strictly typed array transformer with dot access and fluent interface. The mapped result can be used for JSON\nresponses and many other things.\n\n[![Latest Version on Packagist](https://img.shields.io/github/release/selective-php/transformer.svg)](https://packagist.org/packages/selective/transformer)\n[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE)\n[![Build Status](https://github.com/selective-php/transformer/workflows/build/badge.svg)](https://github.com/selective-php/transformer/actions)\n[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/selective-php/transformer.svg)](https://scrutinizer-ci.com/g/selective-php/transformer/code-structure)\n[![Quality Score](https://img.shields.io/scrutinizer/quality/g/selective-php/transformer.svg)](https://scrutinizer-ci.com/g/selective-php/transformer/?branch=master)\n[![Total Downloads](https://img.shields.io/packagist/dt/selective/transformer.svg)](https://packagist.org/packages/selective/transformer/stats)\n\n## Table of Contents\n\n* [Requirements](#requirements)\n* [Installation](#installation)\n* [Introduction](#introduction)\n* [Dot access](#dot-access)\n    * [Object access](#object-access)\n* [Transforming](#transforming)\n    * [Transforming list of arrays](#transforming-list-of-arrays)\n* [Mapping rules](#mapping-rules)\n    * [Simple mapping rules](#simple-mapping-rules)\n    * [Complex mapping rules](#complex-mapping-rules)\n* [Filter](#filter)\n    * [Custom Filter](#custom-filter)\n* [Examples](#examples)\n    * [JSON conversion](#json-conversion)\n    * [PDO resultset conversion](#pdo-resultset-conversion)\n* [License](#license)\n\n## Requirements\n\n* PHP 8.1+\n\n## Installation\n\n```bash\ncomposer require selective/transformer\n```\n\n## Introduction\n\nThis Transformer component provides functionality to map, cast and loop array values from an array or object to another array.\n\nConverting complex data with simple PHP works by using a lot of type casting, `if` conditions and looping through the\ndata with `foreach()`. This leads to very high cyclomatic complexity and nesting depth, and thus poor \"code rating\".\n\n**Before**: Conditions: 9, Paths: 256, CRAP Score: 9\n\u003cdetails\u003e\n  \u003csummary\u003eClick to expand!\u003c/summary\u003e\n\u003cimg src=\"https://user-images.githubusercontent.com/781074/107609324-e3c45880-6c3e-11eb-9ca0-ed27e420ec13.png\"\u003e\n\u003c/details\u003e\n\n**After**: Conditions: 1, Paths: 1, CRAP Score: 1\n\u003cdetails\u003e\n  \u003csummary\u003eClick to expand!\u003c/summary\u003e\n\u003cimg src=\"https://user-images.githubusercontent.com/781074/107609468-4584c280-6c3f-11eb-8f10-3cd42bc27b74.png\"\u003e\n\u003c/details\u003e\n\n### Use Cases\n\nWhen building an API it is common for people to just grab stuff from the database and pass it to `json_encode()`. This\nmight be passable for “trivial” APIs but if they are in use by the public, or used by mobile applications then this will\nquickly lead to inconsistent output. The Transformer is able to create a “barrier” between source data and output, so\nschema changes do not affect users.\n\nThe Transformer works also very well to put any kind of **database resultset**\n(e.g. from PDO) into a new data structure.\n\nThe uses cases are not limited.\n\n## Dot access\n\nYou can copy any data from the source array to any sub-element of the destination array using the dot-syntax.\n\n```php\n\u003c?php\nuse Selective\\Transformer\\ArrayTransformer;\n\n$transformer = new ArrayTransformer();\n\n$transformer-\u003emap('firstName', 'address.first_name')\n    -\u003emap('lastName', 'address.last_name')\n    -\u003emap('invoice.items', 'root.sub1.sub2.items');\n\n// ...\n```\n\n### Object access\n\nIt's possible to access the properties of an object using the dot notation.\n\n```php\nuse Selective\\Transformer\\ArrayTransformer;\n\n$transformer = new ArrayTransformer();\n\n$transformer-\u003emap('bar1', 'foo.bar', 'string')\n    -\u003emap('bar2', 'foo.bar2.0', 'string')\n    -\u003emap('sub.sub2.sub3', 'foo.bar2.1', 'string');\n\n$user = new stdClass();\n$user-\u003efoo = new stdClass();\n$user-\u003efoo-\u003ebar = 'Hello Bar';\n$user-\u003efoo-\u003ebar2 = [\n    0 =\u003e 'Test 0',\n    1 =\u003e 'Test 1',\n];\n\n$result = $transformer-\u003etoArray((array)$user);\n```\n\nThe result:\n\n```php\n[\n    'bar1' =\u003e 'Hello Bar',\n    'bar2' =\u003e 'Test 0',\n    'sub' =\u003e [\n        'sub2' =\u003e [\n            'sub3' =\u003e 'Test 1',\n        ],\n    ],\n];\n```\n\n## Transforming\n\n### Transforming arrays\n\nFor the sake of simplicity, this example has been put together as though it was one file. In reality, you would spread\nthe manager initiation, data collection and JSON conversion into separate parts of your application.\n\nSample data:\n\n```php\n$data = [\n    'first_name' =\u003e 'Sally',\n    'last_name' =\u003e '',\n    'email' =\u003e 'sally@example.com',\n];\n```\n\n```php\n\u003c?php\n\nuse Selective\\Transformer\\ArrayTransformer;\n\n$transformer = new ArrayTransformer();\n\n$transformer-\u003emap('firstName', 'first_name')\n    -\u003emap('lastName', 'last_name')\n    -\u003emap('email', 'email');\n    \n$result = $transformer-\u003etoArray($data);\n```\n\nThe result:\n\n```php\n[\n    'firstName' =\u003e 'Sally',\n    'email' =\u003e 'sally@example.com',\n];\n```\n\n### Transforming list of arrays\n\nThe method `toArrays` is able to transform a list of arrays.\n\nThis can be useful if you want to transform a resultset from a database query, or a response payload from an API.\n\n**Example:**\n\n```php\n$transformer = new ArrayTransformer();\n\n$transformer-\u003emap('id', 'id', $transformer-\u003erule()-\u003einteger())\n    -\u003emap('first_name', 'first_name', $transformer-\u003erule()-\u003estring())\n    -\u003emap('last_name', 'last_name', $transformer-\u003erule()-\u003estring())\n    -\u003emap('phone', 'phone', $transformer-\u003erule()-\u003estring())\n    -\u003emap('enabled', 'enabled', $transformer-\u003erule()-\u003eboolean());\n\n$rows = [];\n$rows[] = [\n    'id' =\u003e '100',\n    'first_name' =\u003e 'Sally',\n    'last_name' =\u003e '',\n    'phone' =\u003e null,\n    'enabled' =\u003e '1',\n];\n\n$rows[] = [\n    'id' =\u003e '101',\n    'first_name' =\u003e 'Max',\n    'last_name' =\u003e 'Doe',\n    'phone' =\u003e '+123456789',\n    'enabled' =\u003e '0',\n];\n\n$result = $transformer-\u003etoArrays($rows);\n```\n\nThe result:\n\n```php\n[\n    [\n        'id' =\u003e 100,\n        'first_name' =\u003e 'Sally',\n        'enabled' =\u003e true,\n    ],\n    [\n        'id' =\u003e 101,\n        'first_name' =\u003e 'Max',\n        'last_name' =\u003e 'Doe',\n        'phone' =\u003e '+123456789',\n        'enabled' =\u003e false,\n    ],\n]\n```\n\n## Mapping Rules\n\n### Simple mapping rules\n\nUsing strings, separated by `|`, to define a filter chain:\n\n```php\n\u003c?php\n\nuse Selective\\Transformer\\ArrayTransformer;\n\n$transformer = new ArrayTransformer();\n\n$transformer-\u003emap('firstName', 'first_name', 'string|required')\n    -\u003emap('lastName', 'last_name', 'string|required')\n    -\u003emap('email', 'email', 'string|required');\n\n$data = [\n    'first_name' =\u003e 'Sally',\n    'last_name' =\u003e '',\n    'email' =\u003e 'sally@example.com',\n];\n    \n$result = $transformer-\u003etoArray($data);\n```\n\nBecause `lastName` is blank but required the result looks like this:\n\n```php\n[\n    'firstName' =\u003e 'Sally',\n    'lastName' =\u003e '',\n    'email' =\u003e 'sally@example.com',\n];\n```\n\n### Complex mapping rules\n\nFor complexer mapping rules there is a fluent interface available. To create a new rule use the `rule` method and pass\nit as 3rd. parameter to the `map` method.\n\n```php\n\u003c?php\n\nuse Selective\\Transformer\\ArrayTransformer;\n\n$transformer = new ArrayTransformer();\n\n$transformer-\u003emap('firstName', 'first_name', $transformer-\u003erule()-\u003estring()-\u003erequired())\n    -\u003emap('lastName', 'last_name', $transformer-\u003erule()-\u003estring()-\u003erequired())\n    -\u003emap('email', 'email', $transformer-\u003erule()-\u003estring()-\u003erequired());\n\n$data = [\n    'first_name' =\u003e 'Sally',\n    'last_name' =\u003e '',\n    'email' =\u003e 'sally@example.com',\n];\n\n$result = $transformer-\u003etoArray($data);\n```\n\nBecause `lastName` is blank but required the result looks like this:\n\n```php\n[\n    'firstName' =\u003e 'Sally',\n    'lastName' =\u003e '',\n    'email' =\u003e 'sally@example.com',\n];\n```\n\n## Filter\n\nMost filters are directly available as method.\n\n```php\n// Cast value to string, convert blank to null\n$transformer-\u003erule()-\u003estring();\n\n// Cast value to string, allow blank string ''\n$transformer-\u003erule()-\u003estring(true);\n\n// Cast value to int\n$transformer-\u003erule()-\u003einteger();\n\n// Cast value to float\n$transformer-\u003erule()-\u003efloat();\n\n// Cast value to bool\n$transformer-\u003erule()-\u003eboolean();\n\n// Cast value to datetime string, default: Y-m-d H:i:s\n$transformer-\u003erule()-\u003edate();\n\n// Cast value to date string\n$transformer-\u003erule()-\u003edate('Y-m-d');\n\n// Format value to number using the number_format function\n$transformer-\u003erule()-\u003enumber();\n\n// Format value to number with a custom number format\n$transformer-\u003erule()-\u003enumber(2, '.', ',');\n\n// Cast value to array\n$transformer-\u003erule()-\u003earray();\n\n// Cast value using a custom callback function\n$transformer-\u003erule()-\u003ecallback(\n    function ($value) {\n        return 'My custom value: ' . $value;\n    }\n);\n\n// Set fixed value\n$transformer-\u003eset('bar.0.item', 'default-value');\n\n// Apply transformation to array item\n$transformer-\u003erule()-\u003etransform(\n    function (ArrayTransformer $transformer) {\n        $transformer\n            -\u003emap('id', 'id', 'integer')\n            -\u003emap('first_name', 'first_name', 'string');\n    }\n);\n\n// Apply transformation to a list of arrays\n$transformer-\u003erule()-\u003etransformList(\n    function (ArrayTransformer $transformer) {\n        $transformer\n            -\u003emap('id', 'id', 'integer')\n            -\u003emap('first_name', 'first_name', 'string');\n       }\n);\n```\n\n### Custom Filter\n\nYou can also add your own custom filter:\n\n```php\n$transformer = new ArrayTransformer();\n\n// Add a trim filter using the native trim function\n$transformer-\u003eregisterFilter('trim', 'trim');\n\n// Usage\n$transformer-\u003emap('destination', 'source', 'trim');\n\n// or\n\n$transformer-\u003emap('destination', 'source', $transformer-\u003erule()-\u003efilter('trim'));\n```\n\nAdd a custom filter using a callback:\n\n```php\n$transformer = new ArrayTransformer();\n\n$transformer-\u003eregisterFilter(\n    'custom1',\n    function ($value) {\n        return 'Custom value: ' . $value;\n    }\n);\n\n// Usage\n$transformer-\u003emap('destination', 'source', 'custom1');\n\n// or\n\n$transformer-\u003emap('destination', 'source', $transformer-\u003erule()-\u003efilter('custom1'));\n\n// It is possible to chain multiple filters\n$transformer-\u003emap(\n    'destination',\n    'source',\n    $transformer-\u003erule()-\u003efilter('custom1')-\u003efilter('trim')-\u003erequired()-\u003edefault('example')\n);\n```\n\nDefine a custom filter using a mapping specific callback:\n\n```php\n$transformer = new ArrayTransformer();\n\n$transformer-\u003emap(\n    'destination',\n    'source',\n    $transformer-\u003erule()-\u003ecallback(\n        function ($value) {\n            return 'Callback value: ' . $value;\n        }\n    )\n);\n```\n\nThere are even more filter classes available that can be registered manually:\n\n```php\nuse Selective\\Transformer\\Filter\\SprintfFilter;\n\n$transformer = new ArrayTransformer();\n\n// Convert the value using the sprintf function\n$transformer-\u003eregisterFilter('sprintf', new SprintfFilter());\n\n// Usage\n$transformer-\u003emap('destination', 'source', $transformer-\u003erule()-\u003efilter('sprintf', 'Count: %d'));\n```\n\nYou can also implement and register your own filter classes as well.\n\n## Examples\n\n### JSON conversion\n\nYou can use your own json component or just the native `json_encode` function.\n\n```php\n// Turn all of that into a JSON string\n$json = (string)json_encode($transformer-\u003etoArray($data));\n```\n\nWriting JSON to a PSR-7 response object:\n\n```php\n// Set correct header\n$response = $response-\u003ewithHeader('Content-Type', 'application/json');\n\n// Write json string to the response body\n$response-\u003egetBody()-\u003ewrite($json);\n\nreturn $response;\n```\n\n### PDO resultset conversion\n\n```php\nuse Selective\\Transformer\\ArrayTransformer;\n\n$pdo = new PDO($dsn, $username, $password, $options);\n\n$statement = $pdo-\u003equery('SELECT id, username, first_name FROM users');\n$rows = $statement-\u003efetchAll();\n\n$transformer = new ArrayTransformer();\n\n$transformer-\u003emap('id', 'id', 'integer')\n    -\u003emap('username', 'username', 'string|required')\n    -\u003emap('first_name', 'first_name', 'string|required');\n    \n$result = $transformer-\u003etoArrays($rows);\n```\n\nThe result:\n\n```php\n[\n    [\n        'id' =\u003e 1,\n        'username' =\u003e 'sally',\n        'first_name' =\u003e 'Sally',\n    ]  \n    // ... \n];\n```\n\n## Similar packages\n\n* \u003chttps://github.com/selective-php/array-reader\u003e\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE) for more information.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fselective-php%2Ftransformer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fselective-php%2Ftransformer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fselective-php%2Ftransformer/lists"}