Skip to content

Better table of clients/adapters #201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 9, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 81 additions & 7 deletions clients.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,32 @@ interface and forwarding the calls to an HTTP client not implementing the interf
All clients and adapters comply with `Liskov substitution principle`_ which means that you can easily change one
for another without any side effects.

Clients:

.. toctree::
:hidden:

clients/curl-client
clients/socket-client
clients/mock-client

Client adapters:

.. toctree::

clients/buzz-adapter
clients/cakephp-adapter
clients/guzzle5-adapter
clients/guzzle6-adapter
clients/react-adapter
clients/zend-adapter

.. csv-table::
:header: "Name", "Type", "Links", "Stats"
:widths: 32, 15, 15, 38

"``php-http/curl-client``", "Client", ":doc:`Docs </clients/curl-client>`, `Repo <https://github.com/php-http/curl-client>`__", "|curl_version| |curl_downloads| "
"``php-http/socket-client``", "Client", ":doc:`Docs </clients/socket-client>`, `Repo <https://github.com/php-http/socket-client>`__", "|socket_version| |socket_downloads| "
"``php-http/mock-client``", "Client", ":doc:`Docs </clients/mock-client>`, `Repo <https://github.com/php-http/mock-client>`__", "|mock_version| |mock_downloads| "
"``php-http/buzz-adapter``", "Adapter", ":doc:`Docs </clients/buzz-adapter>`, `Repo <https://github.com/php-http/buzz-adapter>`__", "|buzz_version| |buzz_downloads| "
"``php-http/cakephp-adapter``", "Adapter", ":doc:`Docs </clients/cakephp-adapter>`, `Repo <https://github.com/php-http/cakephp-adapter>`__", "|cakephp_version| |cakephp_downloads| "
"``php-http/guzzle5-adapter``", "Adapter", ":doc:`Docs </clients/guzzle5-adapter>`, `Repo <https://github.com/php-http/guzzle5-adapter>`__", "|guzzle5_version| |guzzle5_downloads| "
"``php-http/guzzle6-adapter``", "Adapter", ":doc:`Docs </clients/guzzle6-adapter>`, `Repo <https://github.com/php-http/guzzle6-adapter>`__", "|guzzle6_version| |guzzle6_downloads| "
"``php-http/react-adapter``", "Adapter", ":doc:`Docs </clients/react-adapter>`, `Repo <https://github.com/php-http/react-adapter>`__", "|react_version| |react_downloads| "
"``php-http/zend-adapter``", "Adapter", ":doc:`Docs </clients/zend-adapter>`, `Repo <https://github.com/php-http/zend-adapter>`__", "|zend_version| |zend_downloads| "

Composer Virtual Packages
-------------------------
Expand All @@ -41,3 +51,67 @@ HTTPlug use the ``provide`` section to tell composer that they do provide the cl
.. _`php-http/async-client-implementation`: https://packagist.org/providers/php-http/async-client-implementation
.. _`Adapter pattern`: https://en.wikipedia.org/wiki/Adapter_pattern
.. _`Liskov substitution principle`: https://en.wikipedia.org/wiki/Liskov_substitution_principle


.. |curl_downloads| image:: https://img.shields.io/packagist/dt/php-http/curl-client.svg?style=flat-square
:target: https://packagist.org/packages/php-http/curl-client
:alt: Total Downloads
.. |curl_version| image:: https://img.shields.io/github/release/php-http/curl-client.svg?style=flat-square
:target: https://github.com/php-http/curl-client/releases
:alt: Latest Version

.. |socket_downloads| image:: https://img.shields.io/packagist/dt/php-http/socket-client.svg?style=flat-square
:target: https://packagist.org/packages/php-http/socket-client
:alt: Total Downloads
.. |socket_version| image:: https://img.shields.io/github/release/php-http/socket-client.svg?style=flat-square
:target: https://github.com/php-http/socket-client/releases
:alt: Latest Version

.. |mock_downloads| image:: https://img.shields.io/packagist/dt/php-http/mock-client.svg?style=flat-square
:target: https://packagist.org/packages/php-http/mock-client
:alt: Total Downloads
.. |mock_version| image:: https://img.shields.io/github/release/php-http/mock-client.svg?style=flat-square
:target: https://github.com/php-http/mock-client/releases
:alt: Latest Version

.. |buzz_downloads| image:: https://img.shields.io/packagist/dt/php-http/buzz-adapter.svg?style=flat-square
:target: https://packagist.org/packages/php-http/buzz-adapter
:alt: Total Downloads
.. |buzz_version| image:: https://img.shields.io/github/release/php-http/buzz-adapter.svg?style=flat-square
:target: https://github.com/php-http/buzz-adapter/releases
:alt: Latest Version

.. |cakephp_downloads| image:: https://img.shields.io/packagist/dt/php-http/cakephp-adapter.svg?style=flat-square
:target: https://packagist.org/packages/php-http/cakephp-adapter
:alt: Total Downloads
.. |cakephp_version| image:: https://img.shields.io/github/release/php-http/cakephp-adapter.svg?style=flat-square
:target: https://github.com/php-http/cakephp-adapter/releases
:alt: Latest Version

.. |guzzle5_downloads| image:: https://img.shields.io/packagist/dt/php-http/guzzle5-adapter.svg?style=flat-square
:target: https://packagist.org/packages/php-http/guzzle5-adapter
:alt: Total Downloads
.. |guzzle5_version| image:: https://img.shields.io/github/release/php-http/guzzle5-adapter.svg?style=flat-square
:target: https://github.com/php-http/guzzle5-adapter/releases
:alt: Latest Version

.. |guzzle6_downloads| image:: https://img.shields.io/packagist/dt/php-http/guzzle6-adapter.svg?style=flat-square
:target: https://packagist.org/packages/php-http/guzzle6-adapter
:alt: Total Downloads
.. |guzzle6_version| image:: https://img.shields.io/github/release/php-http/guzzle6-adapter.svg?style=flat-square
:target: https://github.com/php-http/guzzle6-adapter/releases
:alt: Latest Version

.. |react_downloads| image:: https://img.shields.io/packagist/dt/php-http/react-adapter.svg?style=flat-square
:target: https://packagist.org/packages/php-http/react-adapter
:alt: Total Downloads
.. |react_version| image:: https://img.shields.io/github/release/php-http/react-adapter.svg?style=flat-square
:target: https://github.com/php-http/react-adapter/releases
:alt: Latest Version

.. |zend_downloads| image:: https://img.shields.io/packagist/dt/php-http/zend-adapter.svg?style=flat-square
:target: https://packagist.org/packages/php-http/zend-adapter
:alt: Total Downloads
.. |zend_version| image:: https://img.shields.io/github/release/php-http/zend-adapter.svg?style=flat-square
:target: https://github.com/php-http/zend-adapter/releases
:alt: Latest Version
23 changes: 23 additions & 0 deletions clients/cakephp-adapter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
CakePHP Adapter
===============

An HTTPlug adapter for the CakePHP HTTP client.

Installation
------------

To install the CakePHP adapter, which will also install CakePHP itself (if it was
not yet included in your project), run:

.. code-block:: bash

$ composer require php-http/cakephp-adapter

.. include:: includes/install-message-factory.inc

.. include:: includes/install-discovery.inc

Usage
-----

To be written...
23 changes: 23 additions & 0 deletions clients/zend-adapter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Zend Adapter
============

An HTTPlug adapter for the Zend HTTP client.

Installation
------------

To install the Zend adapter, which will also install Zend itself (if it was
not yet included in your project), run:

.. code-block:: bash

$ composer require php-http/zend-adapter

.. include:: includes/install-message-factory.inc

.. include:: includes/install-discovery.inc

Usage
-----

To be written...