smokescreen laravel php تحميل - smokescreen laravel php تنزيل كود المصدر

smokescreen laravel php

فئات أخرى

4.0.0

تنزيل

شاشة دخان لارافيل

ملخص

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 ، يمكنك ببساطة إرجاع الستار الدخاني من أي طريقة تحكم.

متطلبات

بي إتش بي >= 7.0
لارافيل >= 5.5

تثبيت

هذه الحزمة مستضافة حاليًا على مستودع الحزم الخاص بـ RexSoftware. تأكد أولاً من أنك قمت بتكوين 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 ' ,
];

واجهة برمجة التطبيقات

تحويل (): تعيين المورد ليتم تحويله

$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 تلقائيًا نوع المورد الذي يتم تحويله.
سيتم أيضًا استنتاج فئة المحولات التي سيتم استخدامها إذا لم يتم توفيرها.

item(): قم بتعيين مورد عنصر واحد ليتم تحويله

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

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

يشبه transform() ولكنه يقبل عنصرًا فقط.

المجموعة (): قم بتعيين مورد المجموعة ليتم تحويله

$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 = $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() هي طريقة مساعدة بسيطة تقبل شرطًا وتعيد إما القيمة المحددة عندما تكون صحيحة، أو فارغة (افتراضيًا) عندما تكون خاطئة. في المثال أعلاه، ستكون عقدة "user" null إذا لم يتم تعيين user_id على كائن $post .