smokescreen laravel php下載 - smokescreen laravel php原始碼下載

smokescreen laravel php

其他類別

4.0.0

下載

Laravel 煙幕彈

概述

Laravel Smokescreen 是一個用於轉換 Laravel 模型和其他實體的套件。

轉換 API 回應
轉換作業和事件負載
最小的樣板和引導程序
支援嵌入資料的複雜關係
支持關係的急切加載
允許轉換不同類型的資源
可以處理序列化為可自訂的格式

該套件將 rexlabs/smokescreen (Vanilla PHP) 套件與 Laravel 框架緊密整合，以便在使用 Laravel 應用程式時提供便利和最少的樣板檔案。

用法

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

laravel-smokescreen被引導到 Laravel 的應用程式容器中，因此您也可以鍵入提示將其註入到控制器的建構函式或方法中。
建議在控制器方法中使用外觀（如上所述），在服務類別中使用類型提示（如果需要）
您也可以透過app('smokescreen')直接從容器中使用它，如上所示。
由於我們實作了Responsable接口，因此您可以簡單地從任何控制器方法返回煙幕。

要求

PHP >= 7.0
Laravel >= 5.5

安裝

該軟體包目前託管在 RexSoftware 的私人 packagist 儲存庫中。首先確保您已配置您的composer.json以使用此儲存庫。

安裝包

composer require rexlabs/laravel-smokescreen

該包將被自動發現，無需額外配置。

配置

若要將設定檔發佈到您的app/config資料夾，請執行以下命令：

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

這將創建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 ' ,
];

應用程式介面

transform()：設定要變換的資源

$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 );

煙幕將自動決定正在轉換的資源類型。
如果未提供，它也會推斷要使用的 Transformer 類別。

item()：設定要轉換的單一專案資源

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

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

與transform()類似，但只接受一個項目。

collection()：設定要轉換的集合資源

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

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

與transform()類似，但只接受集合。

transformWith()：設定先前設定的資源上要使用的轉換器

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

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

這是將轉換器直接傳遞給資源方法的替代方法。

serializeWith()：覆寫要使用的序列化器

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

只有當您計劃使用與預設序號不同的序號時，才需要設定此項。
我們提供DefaultSerializer作為預設值，它傳回嵌套在"data"節點下的集合，以及沒有任何巢狀的項目資源。
您的自訂序列化程式應實作SerializerInterface介面。

loadRelationsVia()：覆蓋預設的 Laravel 關係載入器

$smokescreen->loadRelationsVia(RelationsLoaderInterface $loader);

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

只有當您打算使用預設載入器以外的載入器時才需要設定此項，
我們提供了預設的RelationsLoader ，它可以預先載入集合資源的關係。
您的自訂載入器應該實作RelationsLoaderInterface介面並提供load()方法。

resolveTransformerVia()：覆寫預設的轉換器解析器

$smokescreen->loadTransformersVia(TransformerResolverInterface $loader);

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

當未在資源上明確定義轉換器時，將使用解析器。
此套件中的預設解析器嘗試在smokescreen.transformer_namespace路徑中定義的路徑中尋找匹配的轉換器類，並透過應用程式容器實例化它。
只有當您打算使用與預設解析器不同的解析器時，才需要設定此項目。
您的自訂解析器應實作TransformersLoaderInterface介面並提供resolve(ResourceInterface)方法。

response()：存取產生的回應對象

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

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

此方法傳回一個IlluminateHttpJsonResponse對象，因此它不可連結。
可以應用所有支援的JsonResponse方法。
您仍然可以直接從控制器返回response()因為它是一個JsonResponse物件。
您也可以使用withResponse($callback)來應用更改，並且仍然支援可連結性。
注意：第一次呼叫response()會快取結果，這樣就不會每次都重新產生整個資料集，這表示後續呼叫中傳遞的任何參數都會被忽略。您可以使用clearResponse()或直接操作JsonResponse物件。

freshResponse()：產生一個新的 Response 對象

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

與response()不同，此方法傳回一個新的非快取JsonResponse物件（透過先呼叫clearResponse() ）。
此方法傳回一個IlluminateHttpJsonResponse對象，因此它不可連結。有關可連結方法，請參閱withResponse() 。
可以應用所有支援的JsonResponse方法。

withResponse()：將變更套用至產生的回應對象

$smokescreen->withResponse(callable $apply);

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

提供接受JsonResponse物件並操作回應的回調
與response()不同，此方法是可連結的

clearResponse()：清除所有快取的回應

$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

重置任何快取的響應對象

變形金剛

變壓器範例

 <?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 );
    }
}

您透過$includes數組聲明可用的包含
每個包含接受 0 個或更多以下指令：
- default ：無論請求的包含如何，此包含始終啟用
- relation ：表示關係應該被急切地負荷。如果關係名稱不同，請將其指定為relation:othername
- method ：預設情況下，包含鍵對應到include{IncludeKey}您可以提供要使用的方法
你的transform()方法應該回傳一個陣列。
以include{IncludeKey}(Model)格式定義包含方法 - 它們應該傳回collection()或item()
when()是一個簡單的輔助方法，它接受一個條件，並在 true 時傳回給定值，或 false 時傳回 null（預設）。在上面的範例中，如果$post物件上沒有設定user_id則"user"節點將為null 。