php nchan client

php-nchan-client

جدول المحتويات

• ملخص
• التثبيت والمتطلبات
• الاستخدام
  • نشر رسالة
  • الحصول على معلومات القناة
  • حذف قناة
  • معلومات حالة Nchan
  • تفويض الطلبات
• التوافق مع PSR-18

ملخص

هذا عميل PHP لـ https://nchan.io.

التثبيت والمتطلبات

 composer require marein/php-nchan-client

إذا كنت تريد استخدام محول PSR-18، فقم بتثبيت مكتبة تنفذ عميل PSR-18 http (انظر هنا) ومكتبة تنفذ مصانع http PSR-17 (انظر هنا).

إذا كنت تريد استخدام عميل http المدمج (افتراضيًا إذا لم تقم بتعيين أي شيء)، فقم بتمكين تكوين phpallow_url_fopen.

الاستخدام

تستخدم أمثلة التعليمات البرمجية التالية عميل http المضمن.

نشر رسالة

إظهار الرمز

 <?php

namespace {

    use Marein  Nchan  Api  Model  PlainTextMessage ;
    use Marein  Nchan  Nchan ;

    include ' /path/to/autoload.php ' ;

    $ nchan = new Nchan ( ' http://my-nchan-domain ' );
    $ channel = $ nchan -> channel ( ' /path-to-publisher-endpoint ' );
    $ channelInformation = $ channel -> publish (
        new PlainTextMessage (
            ' my-message-name ' ,
            ' my message content '
        )
    );

    // Nchan returns some channel information after publishing a message.
    var_dump ( $ channelInformation );
}

الحصول على معلومات القناة

إظهار الرمز

 <?php

namespace {

    use Marein  Nchan  Nchan ;

    include ' /path/to/autoload.php ' ;

    $ nchan = new Nchan ( ' http://my-nchan-domain ' );
    $ channel = $ nchan -> channel ( ' /path-to-publisher-endpoint ' );
    $ channelInformation = $ channel -> information ();

    var_dump ( $ channelInformation );
}

حذف قناة

إظهار الرمز

 <?php

namespace {

    use Marein  Nchan  Nchan ;

    include ' /path/to/autoload.php ' ;

    $ nchan = new Nchan ( ' http://my-nchan-domain ' );
    $ channel = $ nchan -> channel ( ' /path-to-publisher-endpoint ' );
    $ channel -> delete ();
}

معلومات حالة Nchan

يمكن الاستعلام عن نقاط النهاية ذات التوجيه nchan_stub_status على النحو التالي.

إظهار الرمز

 <?php

namespace {

    use Marein  Nchan  Nchan ;

    include ' /path/to/autoload.php ' ;

    $ nchan = new Nchan ( ' http://my-nchan-domain ' );
    $ status = $ nchan -> status ( ' /path-to-status-location ' );
    $ statusInformation = $ status -> information ();

    var_dump ( $ statusInformation );
}

تفويض الطلبات

يجب أن يتم ترخيص نقاط النهاية ذات التوجيه nchan_authorize_request . يأخذ مُنشئ عميل http المدمج تطبيقًا لنوع بيانات الاعتماد. تأتي هذه المكتبة مع تطبيقين مدمجين، BasicAuthenticationCredentials وBearerAuthenticationCredentials.

إظهار الرمز

 <?php

namespace {

    use Marein  Nchan  HttpAdapter  BasicAuthenticationCredentials ;
    use Marein  Nchan  HttpAdapter  BearerAuthenticationCredentials ;
    use Marein  Nchan  HttpAdapter  HttpStreamWrapperClient ;
    use Marein  Nchan  Nchan ;

    include ' /path/to/autoload.php ' ;

    // Client with basic authentication
    $ adapter = new HttpStreamWrapperClient (
        new BasicAuthenticationCredentials ( ' nchan ' , ' password ' )
    );

    // Client with bearer authentication
    $ adapter = new HttpStreamWrapperClient (
        new BearerAuthenticationCredentials ( ' my-token ' )
    );

    $ nchan = new Nchan ( ' http://my-nchan-domain ' , $ adapter );
}

إذا كنت تستخدم عميل http آخر من خلال محول PSR-18، فسيكون لدى عميل http المعني نقاط امتداد خاصة به لتعديل الطلب قبل إرساله.

التوافق مع PSR-18

تأتي هذه المكتبة مع محول متوافق مع PSR-18. هناك أسباب وجيهة لعدم استخدام العميل المدمج. يعتمد ذلك على غلاف دفق http و file_get_contents . يؤدي هذا إلى إغلاق اتصال TCP بعد كل طلب. يمكن للعملاء الآخرين، انظر أدناه، إبقاء الاتصال مفتوحًا.

يستخدم المثال التالي guzzlehttp/guzzle وguzzlehttp/psr7.

إظهار الرمز

 <?php

namespace {

    use GuzzleHttp  Client ;
    use GuzzleHttp  Psr7  HttpFactory ;
    use Marein  Nchan  HttpAdapter  Psr18ClientAdapter ;
    use Marein  Nchan  Nchan ;

    include ' /path/to/autoload.php ' ;

    $ nchan = new Nchan (
        ' http://my-nchan-domain ' ,
        new Psr18ClientAdapter (
            new Client (),
            new HttpFactory (),
            new HttpFactory ()
        )
    );
}

يستخدم مثال التعليمات البرمجية التالي Symfony/http-client وnyholm/psr7.

إظهار الرمز

 <?php

namespace {

    use Marein  Nchan  HttpAdapter  Psr18ClientAdapter ;
    use Marein  Nchan  Nchan ;
    use Nyholm  Psr7  Factory  Psr17Factory ;
    use Symfony  Component  HttpClient  HttpClient ;
    use Symfony  Component  HttpClient  Psr18Client ;

    include ' /path/to/autoload.php ' ;

    // Symfony itself needs an adapter to be PSR-18 compliant.
    $ httpClient = new Psr18Client (
        HttpClient:: create (),
        new Psr17Factory (),
        new Psr17Factory ()
    );

    $ nchan = new Nchan (
        ' http://my-nchan-domain ' ,
        new Psr18ClientAdapter (
            $ httpClient ,
            $ httpClient ,
            $ httpClient
        )
    );
}