connorvg/laravel-transform

This package is abandoned and no longer maintained. The author suggests using the league/fractal package instead.

An array transformer, built for APIs, w/ Laravel bindings (Laravel not required)

1.0.1 2014-05-01 15:51 UTC

Requires

• php: >=5.3.0

Suggests

• connorvg/laravel-permissions: A Laravel permissions package that uses keys rather than roles
• connorvg/laravel-wolframalpha: A Laravel wrapper for the Wolfram|Alpha API
• connorvg/php-slack: An Eloquent ORM styled PHP implementation for the Slack API w/ Laravel binds to help out Laravel lovers
• connorvg/php-wtf: A PHP implementation of my WholeTextFunctions library

BSD

• Connor Parks

• api
• array
• laravel

README

In the require key of composer.json file add the following

"connorvg/laravel-transform": "dev-master"

Run the Composer update command

$ composer update

OR

You can run the command composer require connorvg/laravel-transform from the command line interface.

Laravel

If you're using laravel, add this service provider:

'ConnorVG\Transform\TransformServiceProvider'

Also, this Facade:

'Transform' => 'ConnorVG\Transform\TransformFacade'

Usage

Transform is a very simple package once you get the hang of it, I'll break it down as much as I can here:

The only function Transform actually has is

::make(
Array or something with ->toArray() as input,
Array of definitions,
Array of aliases *optional*
);

Input

Input can be anything that is an array or an object with a method 'toArray()' which returns an array. You can also have meta-arrays (multidimensional arrays) and the framework will figure this out for you.

EG:

[
    'this'  => 'that',
    'hey'   => 'bye',
    'more'  => [
        'go' => 'where?'
        'to' => 'there!'
    ]
]

Definitions

Definitions are used to define types, this will cast values to types where required.

EG:

Input

$input = [
    'some_number' => '18',
    'a_bool'      => '0',
    'more_stuff'  => [
        'yeah' => '1'
    ]
]

Definitions

Definitions are used to define a value as a type, this actually sets the object type (IE: from '5' to 5).

$defs = [
    'some_number' => 'int',
    'a_bool'      => 'bool',
    'more_stuff'  => [
        'yeah' => 'bool'
    ]
]

These, used as: Transform::make($input, $defs); will output:

[
    'some_number' => 18,
    'a_bool'      => false,
    'more_stuff'  => [
        'yeah' => true
    ]
]

You can also define iteratively for arrays of objects (arrays), so this:

$input = [
    [ 'id' => '1', 'active' => '1' ],
    [ 'id' => '2', 'active' => '0' ],
    [ 'id' => '3', 'active' => '1' ]
]

Can be defined using the index of 0, this is what is used to find iterative definitions:

$defs = [
    [ 'id' => 'int', 'active' => 'bool' ]
]

These, used as: Transform::make($input, $defs); will output:

[
    [ 'id' => 1, 'active' => true ],
    [ 'id' => 2, 'active' => false ],
    [ 'id' => 3, 'active' => true ]
]

NOTE: These types of definitions CAN be used together

Aliases

Aliases are ways of hiding are renaming fields, this is great for API usage. To hide a value just set it's alias to null.

$input = [
    [ 'id' => '1', 'active' => '1', 'password' => 'some_pass' ],
    [ 'id' => '2', 'active' => '0', 'password' => 'some_pass' ],
    [ 'id' => '3', 'active' => '1', 'password' => 'some_pass' ],

    'count' => '3'
]

You may alias these as so:

$aliases = [
    [ 'active' => 'alive', 'password' => null ],

    'count' => 'amount'
]

These, used as: Transform::make($input, [], $aliases); will output:

[
    [ 'id' => '1', 'alive' => '1' ],
    [ 'id' => '2', 'alive' => '0' ],
    [ 'id' => '3', 'alive' => '1' ],

    'amount' => '3'
]

To rename an array, it's simple. Either just do it as a variable (if you wish to leave it's contents alone, or set it to [ NEW_NAME, [ CONTENTS_ALIASES ] ], if NEW_NAME is null, it wont change the name of the array.

[
    'test' => [
        'this' => 'that'
    ]
]

With this alias array:

[
    'test' => [ null, [
        'this' => 'nope'
    ]]
]

Will output:

[
    'test' => [
        'nope' => 'this'
    ]
]

Don't be afraid to nest, full nesting is available because every array is treated as a root.

Example

// CALL //
User::with('account')->first();

// OUTPUT //
{
    id: "1",
    name: "Connor Parks",
    url_name: "connor-parks",
    created_at: "2014-04-30 09:50:08",
    updated_at: "2014-04-30 09:50:08",
    account: {
        id: "2",
        email: "[e-mail]",
        remember_token: "SOME_CODE",
        confirmation_code: "",
        confirmed: "1",
        accountable_id: "1",
        accountable_type: "User",
        created_at: "2014-04-30 09:50:08",
        updated_at: "2014-04-30 10:03:10"
    }
}

// CALL //
Transform::make(User::with('account')->first(),
    [
        'id'      => 'int',
        'account' => [
            'confirmed' => 'bool'
        ]
    ],
    [
        'created_at' => 'since',
        'updated_at' => null,
        'account'    => [ null, [
            'id'                => null,
            'remember_token'    => null,
            'confirmation_code' => null,
            'accountable_id'    => null,
            'accountable_type'  => 'type',
            'created_at'        => null,
            'updated_at'        => null
        ]]
    ]
);

// OUTPUT //
{
    id: 1,
    name: "Connor Parks",
    url_name: "connor-parks",
    since: "2014-04-30 09:50:08",
    account: {
        email: "[e-mail]",
        confirmed: true,
        type: "User"
    }
}