Unduhan smokescreen laravel php - unduhan kode sumber smokescreen laravel php

smokescreen laravel php

Kategori lainnya

4.0.0

Unduh

Tabir Asap Laravel

Ringkasan

Laravel Smokescreen adalah paket untuk mengubah model Laravel Anda, dan entitas lainnya.

Ubah respons API
Transformasi muatan Pekerjaan dan Acara
Pelat ketel dan bootstrap minimal
Mendukung hubungan kompleks untuk data yang disematkan
Mendukung pemuatan hubungan yang bersemangat
Memungkinkan transformasi berbagai jenis sumber daya
Dapat menangani serialisasi ke format yang dapat disesuaikan

Paket ini mengintegrasikan paket rexlabs/smokescreen (Vanilla PHP) dengan framework Laravel, untuk memberikan kenyamanan dan boilerplate minimal saat bekerja dengan aplikasi Laravel.

Penggunaan

 <?php
class MyController extends Controller
{
    public function index ()
    {
        return Smokescreen:: transform (Post:: paginate ());
    }
    
     public function show ( Post $ post )
     {
        return Smokescreen:: transform ( $ post );
     }
}

laravel-smokescreen di-bootstrap ke dalam wadah aplikasi Laravel, sehingga Anda juga dapat mengetikkan petunjuk untuk dimasukkan ke dalam konstruktor atau metode pengontrol Anda.
Disarankan menggunakan fasad (seperti di atas) dalam metode pengontrol, gunakan petunjuk tipe di kelas layanan (jika diperlukan)
Anda juga dapat menggunakannya langsung dari container melalui app('smokescreen') seperti gambar di atas.
Karena kami menerapkan antarmuka Responsable , Anda cukup mengembalikan tabir asap dari metode pengontrol apa pun.

Persyaratan

PHP >= 7.0
Laravel >= 5.5

Instalasi

Paket ini saat ini dihosting di repositori paket pribadi RexSoftware. Pertama, pastikan Anda telah mengonfigurasi composer.json untuk menggunakan repositori ini.

Instal paket

composer require rexlabs/laravel-smokescreen

Paket ini akan ditemukan secara otomatis, dan tidak diperlukan konfigurasi tambahan.

Konfigurasi

Untuk mempublikasikan file konfigurasi ke folder app/config Anda, jalankan perintah berikut:

php artisan vendor:publish --provider= ' RexlabsLaravelSmokescreenProvidersServiceProvider --tag=config '

Ini akan membuat config/smokescreen.php :

 <?php
return [
    // Set the default namespace for resolving transformers when
    // they are not explicitly provided.
    ' transformer_namespace ' => ' AppTransformers ' ,
    
    // Override the default serializer to be used.
    // If not specified - the Smokescreen DefaultSerializer will be used.
    ' default_serializer ' => null ,

    // Set the default request parameter key which is parsed for
    // the list of includes.
    ' include_key ' => ' include ' ,
];

API

transform(): Mengatur sumber daya yang akan diubah

$smokescreen->transform(mixed $resource, mixed $transformer = null);

 <?php
$ smokescreen -> transform (Post:: find ( 1 ));
$ smokescreen -> transform (Post:: all ());
$ smokescreen -> transform (Post:: paginate ());
$ smokescreen -> transform (Post:: find ( 1 ), new SomeOtherTransformer );

Smokescreen akan secara otomatis menentukan jenis sumber daya yang diubah.
Ini juga akan menyimpulkan kelas Transformer untuk digunakan jika tidak disediakan.

item(): Mengatur sumber daya item tunggal yang akan diubah

$smokescreen->item(mixed $item, mixed $transformer = null);

 <?php
$ smokescreen -> item (Post:: find ( 1 ));
$ smokescreen -> item (Post:: find ( 1 ), new SomeOtherTransformer );

Mirip dengan transform() tetapi hanya menerima item.

collection(): Mengatur sumber daya koleksi yang akan diubah

$smokescreen->collection(mixed $collection, mixed $transformer = null);

 <?php
$ smokescreen -> collection (Post:: all ());
$ smokescreen -> collection (Post:: paginate ());
$ smokescreen -> collection (Post:: paginate (), new SomeOtherTransformer );

Mirip dengan transform() tetapi hanya menerima koleksi.

transformWith(): Mengatur transformator untuk digunakan pada sumber daya yang ditetapkan sebelumnya

$smokescreen->transformWith(TransformerInterface|callable $transformer);

 <?php
$ smokescreen -> transform (Post:: find ( 1 ))
    -> transformWith ( new SomeOtherTransformer );

Ini merupakan alternatif untuk meneruskan trafo langsung ke metode sumber daya.

serializeWith(): Mengganti serializer yang akan digunakan

 <?php
$ smokescreen -> serializeWith ( new MyCustomSerializer );

Anda hanya perlu mengatur ini jika Anda berencana menggunakan serialisasi yang berbeda dari default.
Kami menyediakan DefaultSerializer sebagai default, ia mengembalikan koleksi yang bersarang di bawah node "data" , dan sumber daya item tanpa sarang apa pun.
Serializer khusus Anda harus mengimplementasikan antarmuka SerializerInterface .

loadRelationsVia(): Mengganti pemuat relasi Laravel default

$smokescreen->loadRelationsVia(RelationsLoaderInterface $loader);

 <?php
$ smokescreen -> loadRelationsVia ( new MyRelationsLoader );

Anda hanya perlu mengatur ini jika Anda berencana menggunakan loader yang berbeda dari default,
Kami menyediakan RelationsLoader sebagai default yang memuat hubungan dengan penuh semangat untuk pengumpulan sumber daya.
Pemuat khusus Anda harus mengimplementasikan antarmuka RelationsLoaderInterface dan menyediakan metode load() .

resolTransformerVia(): Mengganti penyelesai transformator default

$smokescreen->loadTransformersVia(TransformerResolverInterface $loader);

 <?php
$ smokescreen -> loadTransformersVia ( new MyTransformerResolver );

Resolver digunakan ketika transformator tidak didefinisikan secara eksplisit pada suatu sumber daya.
Penyelesai default dalam paket ini mencoba menemukan kelas transformator yang cocok dalam jalur yang ditentukan di jalur smokescreen.transformer_namespace , dan membuat instance melalui wadah aplikasi.
Anda hanya perlu mengatur ini jika Anda berencana menggunakan penyelesai yang berbeda dari penyelesai default.
Penyelesai khusus Anda harus mengimplementasikan antarmuka TransformersLoaderInterface dan menyediakan metode resolve(ResourceInterface) .

respon(): Mengakses objek respons yang dihasilkan

$response = $smokescreen->response(int $statusCode = 200, array $headers = [], int $options = 0);

 <?php
$ smokescreen -> response ()
    -> header ( ' X-Custom-Header ' , ' boo ' )
    -> setStatusCode ( 405 );

Metode ini mengembalikan objek IlluminateHttpJsonResponse sehingga tidak dapat dirantai.
Semua metode JsonResponse yang didukung dapat diterapkan.
Anda masih dapat mengembalikan response() langsung dari pengontrol Anda karena ini adalah objek JsonResponse .
Sebagai alternatif, Anda dapat menggunakan withResponse($callback) untuk menerapkan perubahan, dan tetap mendukung kemampuan rantai.
Catatan: panggilan pertama ke response() menyimpan hasil dalam cache sehingga seluruh kumpulan data tidak dibuat ulang setiap saat, ini berarti meneruskan parameter apa pun pada panggilan berikutnya akan diabaikan. Anda dapat menggunakan clearResponse() atau memanipulasi objek JsonResponse secara langsung.

freshResponse(): Menghasilkan objek Respon baru

$response = $smokescreen->freshResponse(int $statusCode = 200, array $headers = [], int $options = 0);

Tidak seperti response() metode ini mengembalikan objek JsonResponse baru yang tidak di-cache (dengan memanggil clearResponse() terlebih dahulu).
Metode ini mengembalikan objek IlluminateHttpJsonResponse sehingga tidak dapat dirantai. Lihat withResponse() untuk metode yang dapat dirantai.
Semua metode JsonResponse yang didukung dapat diterapkan.

withResponse(): Menerapkan perubahan pada objek respons yang dihasilkan

$smokescreen->withResponse(callable $apply);

 <?php
$ smokescreen -> withResponse ( function ( JsonResponse $ response ) {
    $ response -> header ( ' X-Crypto-Alert ' , ' all your coins are worthless! ' );
});

Berikan panggilan balik yang menerima objek JsonResponse dan memanipulasi responsnya
Metode ini dapat dirangkai tidak seperti response()

clearResponse(): Hapus semua respons yang di-cache

$smokescreen->clearResponse();

 <?php
$ smokescreen -> response ();       // Data is generated, response object is built and cached
$ smokescreen -> response ( 500 );    // NOPE - Cached, wont be changed!
$ smokescreen -> clearResponse ();
$ smokescreen -> response ( 500 );    // Response is re-generated

Setel ulang objek respons yang di-cache

transformator

Contoh Transformator

 <?php
class PostTransformer extends AbstractTransformer
{
    protected $ includes = [
        ' user ' => ' default|relation:user|method:includeTheDamnUser ' ,
        ' comments ' => ' relation ' ,
    ];

    public function transform ( Post $ post ): array
    {
        return [
            ' id ' => $ post -> id ,
            ' user ' => $ this -> when ( $ post -> user_id , [
                ' id ' => $ post -> user_id ,
            ]),
            ' title ' => $ post -> title ,
            ' summary ' => $ post -> summary ,
            ' body ' => $ post -> body ,
            ' created_at ' => utc_datetime ( $ post -> created_at ),
            ' updated_at ' => utc_datetime ( $ post -> updated_at ),
        ];
    }

    public function includeTheDamnUser ( Post $ post )
    {
        return $ this -> item ( $ post -> user ); // Infer Transformer
    }

    public function includeComments ( Post $ post )
    {
        return $ this -> collection ( $ post -> comments , new CommentTransformer );
    }
}

Anda mendeklarasikan penyertaan yang tersedia melalui array $includes
Masing-masing include menerima 0 atau lebih arahan berikut:
- default : Penyertaan ini selalu diaktifkan terlepas dari penyertaan yang diminta
- relation : Menunjukkan bahwa suatu relasi harus dimuat dengan cepat. Jika nama relasinya berbeda, tentukan sebagai relation:othername
- method : Secara default kunci penyertaan dipetakan ke include{IncludeKey} Anda dapat memberikan metode yang akan digunakan
Metode transform() Anda harus mengembalikan array.
Tentukan metode penyertaan Anda dalam format include{IncludeKey}(Model) - metode tersebut harus mengembalikan collection() atau item()
when() adalah metode pembantu sederhana yang menerima kondisi dan mengembalikan nilai yang diberikan jika benar, atau nol (secara default) jika salah. Dalam contoh di atas, node "user" akan menjadi null jika tidak ada user_id yang disetel pada objek $post .