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 。