naotake51/laravel-recursive-only

Register recursiveOnly() extending only() to Model, Collection and Arr.

v1.0.0 2022-04-21 17:07 UTC

Requires

• php: ^7.1 || ^8.0
• illuminate/database: ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0
• illuminate/support: ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0

Requires (Dev)

• orchestra/testbench: ^7.4

MIT

• n-takeshita

• library
• model
• laravel
• collection
• illuminate
• eloquent
• macro
• only

README

Make Laravel's only a little more useful.

• recursive
• *(any keys)
• callback

Requirements

• PHP: ^7.1 || ^8.0
• Laravel: ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0

Install

composer require naotake51/laravel-recursive-only

Motivation

I found deeply nested Laravel's Resource to be a pain to define.

I want to write Resource more simply.

Using

your model add trait RecursiveOnly

use Naotake51\RecursiveOnly\Contracts\HasRecursiveOnly;
use Naotake51\RecursiveOnly\Traits\RecursiveOnly;

class Post extends Model implements HasRecursiveOnly
{
    use RecursiveOnly;

    // ...
}

call recursiveOnly.

• * is mean any keys.
• The value can be changed in the callback.

$post = Post::with(['author', 'comments'])->find(1);

$data = $post->recursiveOnly([
    'author' => [
        'name'
    ],
    'comments' => [
        '*' => [
            'title' => fn ($value /**, ...parents */) => "# $value", // use callback
            'body',
        ]
    ]
]);

// $data => [
//     'author' => [
//         'name' => '...'
//     ],
//     'comments' => Illuminate\Support\Collection([
//         [
//             'title' => '# ...',
//             'body' => '...',
//         ],
//         ...
//     ])
// ]

$posts = Post::with(['author', 'comments'])->get();

$data = $posts->recursiveOnly([
    '*' => [
        'author' => [
            'name'
        ],
        'comments' => [
            '*' => [
                'body'
            ]
        ]
    ]
]);

// $data => Illuminate\Support\Collection([
//     [
//         'author' => [
//             'name' => '...'
//         ],
//         'comments' => Illuminate\Support\Collection([
//             [
//                 'body' => '...'
//             ],
//             ...
//         ])
//     ],
//     ...
// ])

For arrays, use Arr::recursiveOnly

$posts = Post::with(['author', 'comments'])->get()->toArray();

$data = Arr::recursiveOnly($posts, [
    '*' => [
        'author' => [
            'name'
        ],
        'comments' => [
            '*' => [
                'body'
            ]
        ]
    ]
]);

// $data => [
//     [
//         'author' => [
//             'name' => '...'
//         ],
//         'comments' => [
//             [
//                 'body' => '...'
//             ],
//             ...
//         ]
//     ],
//     ...
// ]