PHPackages                             kamranahmedse/laraformer - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. kamranahmedse/laraformer

ActiveLibrary[API Development](/categories/api)

kamranahmedse/laraformer
========================

A Laravel package to help you in implementing the transformers logic in your applications with ease

v1.0.0(10y ago)321437MITPHPPHP >=5.4.0

Since Mar 4Pushed 10y ago4 watchersCompare

[ Source](https://github.com/kamranahmedse/laraformer)[ Packagist](https://packagist.org/packages/kamranahmedse/laraformer)[ RSS](/packages/kamranahmedse-laraformer/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (1)Dependencies (1)Versions (2)Used By (0)

Laraformer
==========

[](#laraformer)

> Laraformer is a laravel 5.\* package that lets you easily introduce a transformation layer for your data.

Laraformer (originated from Laravel Transformers) is a Laravel 5.\* package that lets you easily introduce the transformer logic in your Laravel applications.

Features
========

[](#features)

- Automatic transformation of the models. Also support for manual transformation
- Lets you transform *almost* any kind of data i.e. arrays, objects, collections, paginated data etc
- Not only you can transform models but also any dataset
- Supports both Eloquent and Moloquent
- Ease of use; for automatic transformation, you just need a `transform` function in your models and for manual, there is a single function call. More to it in a moment.
- Lets you keep your transformation logic separate
- Lets you make sure of the fact that any changes in schema doesn't affect the output

Two steps installation
======================

[](#two-steps-installation)

All you have to do is install the package and add the service provider

- Run `composer require kamranahmedse/laraformer` in the terminal
- Add Service Provider Open `config/app.php` and add `KamranAhmed\Laraformer\TransformerServiceProvder::class` to the end of providers array:

    ```
    'providers' => array(
        ....
        KamranAhmed\Laraformer\TransformerServiceProvder::class,
    ),
    ```

How to use
==========

[](#how-to-use)

The installation will automatically setup everything that is there to use the package. Lets get into the real stuff now, shall we?!

Transforming Models
===================

[](#transforming-models)

> Just add the transformation logic to a method called `transform` in your model and directly respond with model/collection of models/paginated model response.

You can transform your models in one of the two ways:

- Automatic transformation of the response
- Manually transform the response

Let me explain the usage with an example.

### Example

[](#example)

**Sample Table/Collection** Lets say that we have a `users` table/collection with the associated model called `User`. The table/collection looks like following

ColumnTypeSample Dataid`int`120name`string`John Doeprofession`string`Engineerdesign\_options`string` (JSON for example)\[{"theme\_name": "larology", "fields":\[{"type": "integer", "name": "some-dummy-field"}\]}\]is\_admin`bool`truecreated\_at`datetime`2016-03-04**Required Output** And here is the output we need

```
[
    {
        "public_id": "x72sl1",
        "name": "John Doe",
        "slug": "john-doe",
        "occupation": "Engineer",
        "is_admin": true,
        "joined_on": "2 days ago",
        "profile_design": [
            {
                "theme_name": "larology",
                "fields": [
                    {
                        "type": "integer",
                        "name": "some-dummy-field"
                    }
                ]
            }
        ]
    }
]
```

**The Model**In order to generate the above ouput, all you need to do is, add a `transform` method in your model i.e.

```
class User extends Eloquent
{
    ...
    public function transform(User $user) {
        return [
            'public_id' => $this->amalgamate($user->id),
            'name' => $user->name,
            'slug' => str_slugify($user->name),
            'occupation' => $user->profession,
            'is_admin' => (bool) $user->is_admin,
            'joined_on' => DateHelper::humanize($user->created_at),
            'profile_design' => json_decode($user->design_options, true)
        ];
    }
}
```

### a) Automatically transform the response

[](#a-automatically-transform-the-response)

For the automatic transformation, all you have to do is return the models directly i.e. with the model object, collection of models or a paginated models in the response. For example, the controller may look like below:

```
class UserController extends Controller
{
    ...
    // Works well with model object
    public function show($id) {
        return User::find($id);
    }
    ...
    // Or you can return the collection
    public function all() {
        return User::all();
    }
    ...
    // Also paginated data is gracefully handled
    public function paginate() {
        return User::paginate(10);
    }
}
```

### b) Manual transformation

[](#b-manual-transformation)

If you would like to transform your model data for internal use, you can also do it. For that, you can either do it using a provided facade called `\KamranAhmed\Laraformer\Facades\Transformer` by using an alias called `Laraformer` i.e.

```
// Use the registered alias
$user = User::find(120);
$transformedUser = Laraformer::transformModel($user);
// Do something with $transformedUser
```

Also note that you still have to specify the `transform` method in the model.

Transforming any Dataset
------------------------

[](#transforming-any-dataset)

Not only models, but you can also use laraformer to transform any kind of dataset whether it some data from an external source, some dataset that you magically generated etc. In order to do that, you can do one of the following.

- Pass an object of a transformer class having a `transform` method
- Pass a callback function

For example:

```
// Transforming using callback function
return Laraformer::forceTransform($dataset, function ($item) {
    return [
        'name' => $item['name'],
        'slug' => str_slugify($item['name']),
        'occupation' => $item['profession'],
        'is_admin' => (bool) $item['is_admin'],
        'joined_on' => DateHelper::humanize($item['created_at']),
        'profile_design' => json_decode($item['design_options'], true)
    ];
})

// Transforming using Transformer class object
$userTransformer = new UserTransformer;
return Laraformer::forceTransform($dataset, $userTransformer)
```

Contributing
------------

[](#contributing)

- Feel free to add some new functionality, polish some existing functionality etc and open up a pull request explaining what you did.
- Report any issues in the [issues section](https://github.com/kamranahmedse/laraformer/issues)
- Also you can reach me directly at  with any feedback

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 50% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

3722d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e119260b816ceaf3e92000b32fc38122e255b463ec0c23b37568f46da2ac0b77?d=identicon)[kamranahmedse](/maintainers/kamranahmedse)

---

Top Contributors

[![kamranahmedse](https://avatars.githubusercontent.com/u/4921183?v=4)](https://github.com/kamranahmedse "kamranahmedse (1 commits)")[![themagnifico](https://avatars.githubusercontent.com/u/4053150?v=4)](https://github.com/themagnifico "themagnifico (1 commits)")

---

Tags

middlewareapitransformerskamranahmedselaravel-transformerapi-transformers

### Embed Badge

![Health badge](/badges/kamranahmedse-laraformer/health.svg)

```
[![Health](https://phpackages.com/badges/kamranahmedse-laraformer/health.svg)](https://phpackages.com/packages/kamranahmedse-laraformer)
```

###  Alternatives

[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

2.9k34.0M112](/packages/darkaonline-l5-swagger)[knuckleswtf/scribe

Generate API documentation for humans from your Laravel codebase.✍

2.3k12.2M45](/packages/knuckleswtf-scribe)[shahghasiadil/laravel-api-versioning

Elegant attribute-based API versioning solution for Laravel applications with built-in deprecation management and version inheritance

2913.6k](/packages/shahghasiadil-laravel-api-versioning)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)