Skip to content

Commit 1f2b570

Browse files
authored
Better table of clients/adapters (#201)
* Better table of clients/adapters * Fixed error * Added some empty pages for cakephp and zend * Fixed build errors * Clients back in sidebar * Fixed typo in package name
1 parent e129b2e commit 1f2b570

File tree

3 files changed

+127
-7
lines changed

3 files changed

+127
-7
lines changed

clients.rst

Lines changed: 81 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,32 @@ interface and forwarding the calls to an HTTP client not implementing the interf
1010
All clients and adapters comply with `Liskov substitution principle`_ which means that you can easily change one
1111
for another without any side effects.
1212

13-
Clients:
14-
1513
.. toctree::
14+
:hidden:
1615

1716
clients/curl-client
1817
clients/socket-client
1918
clients/mock-client
20-
21-
Client adapters:
22-
23-
.. toctree::
24-
2519
clients/buzz-adapter
20+
clients/cakephp-adapter
2621
clients/guzzle5-adapter
2722
clients/guzzle6-adapter
2823
clients/react-adapter
24+
clients/zend-adapter
25+
26+
.. csv-table::
27+
:header: "Name", "Type", "Links", "Stats"
28+
:widths: 32, 15, 15, 38
29+
30+
"``php-http/curl-client``", "Client", ":doc:`Docs </clients/curl-client>`, `Repo <https://github.com/php-http/curl-client>`__", "|curl_version| |curl_downloads| "
31+
"``php-http/socket-client``", "Client", ":doc:`Docs </clients/socket-client>`, `Repo <https://github.com/php-http/socket-client>`__", "|socket_version| |socket_downloads| "
32+
"``php-http/mock-client``", "Client", ":doc:`Docs </clients/mock-client>`, `Repo <https://github.com/php-http/mock-client>`__", "|mock_version| |mock_downloads| "
33+
"``php-http/buzz-adapter``", "Adapter", ":doc:`Docs </clients/buzz-adapter>`, `Repo <https://github.com/php-http/buzz-adapter>`__", "|buzz_version| |buzz_downloads| "
34+
"``php-http/cakephp-adapter``", "Adapter", ":doc:`Docs </clients/cakephp-adapter>`, `Repo <https://github.com/php-http/cakephp-adapter>`__", "|cakephp_version| |cakephp_downloads| "
35+
"``php-http/guzzle5-adapter``", "Adapter", ":doc:`Docs </clients/guzzle5-adapter>`, `Repo <https://github.com/php-http/guzzle5-adapter>`__", "|guzzle5_version| |guzzle5_downloads| "
36+
"``php-http/guzzle6-adapter``", "Adapter", ":doc:`Docs </clients/guzzle6-adapter>`, `Repo <https://github.com/php-http/guzzle6-adapter>`__", "|guzzle6_version| |guzzle6_downloads| "
37+
"``php-http/react-adapter``", "Adapter", ":doc:`Docs </clients/react-adapter>`, `Repo <https://github.com/php-http/react-adapter>`__", "|react_version| |react_downloads| "
38+
"``php-http/zend-adapter``", "Adapter", ":doc:`Docs </clients/zend-adapter>`, `Repo <https://github.com/php-http/zend-adapter>`__", "|zend_version| |zend_downloads| "
2939

3040
Composer Virtual Packages
3141
-------------------------
@@ -41,3 +51,67 @@ HTTPlug use the ``provide`` section to tell composer that they do provide the cl
4151
.. _`php-http/async-client-implementation`: https://packagist.org/providers/php-http/async-client-implementation
4252
.. _`Adapter pattern`: https://en.wikipedia.org/wiki/Adapter_pattern
4353
.. _`Liskov substitution principle`: https://en.wikipedia.org/wiki/Liskov_substitution_principle
54+
55+
56+
.. |curl_downloads| image:: https://img.shields.io/packagist/dt/php-http/curl-client.svg?style=flat-square
57+
:target: https://packagist.org/packages/php-http/curl-client
58+
:alt: Total Downloads
59+
.. |curl_version| image:: https://img.shields.io/github/release/php-http/curl-client.svg?style=flat-square
60+
:target: https://github.com/php-http/curl-client/releases
61+
:alt: Latest Version
62+
63+
.. |socket_downloads| image:: https://img.shields.io/packagist/dt/php-http/socket-client.svg?style=flat-square
64+
:target: https://packagist.org/packages/php-http/socket-client
65+
:alt: Total Downloads
66+
.. |socket_version| image:: https://img.shields.io/github/release/php-http/socket-client.svg?style=flat-square
67+
:target: https://github.com/php-http/socket-client/releases
68+
:alt: Latest Version
69+
70+
.. |mock_downloads| image:: https://img.shields.io/packagist/dt/php-http/mock-client.svg?style=flat-square
71+
:target: https://packagist.org/packages/php-http/mock-client
72+
:alt: Total Downloads
73+
.. |mock_version| image:: https://img.shields.io/github/release/php-http/mock-client.svg?style=flat-square
74+
:target: https://github.com/php-http/mock-client/releases
75+
:alt: Latest Version
76+
77+
.. |buzz_downloads| image:: https://img.shields.io/packagist/dt/php-http/buzz-adapter.svg?style=flat-square
78+
:target: https://packagist.org/packages/php-http/buzz-adapter
79+
:alt: Total Downloads
80+
.. |buzz_version| image:: https://img.shields.io/github/release/php-http/buzz-adapter.svg?style=flat-square
81+
:target: https://github.com/php-http/buzz-adapter/releases
82+
:alt: Latest Version
83+
84+
.. |cakephp_downloads| image:: https://img.shields.io/packagist/dt/php-http/cakephp-adapter.svg?style=flat-square
85+
:target: https://packagist.org/packages/php-http/cakephp-adapter
86+
:alt: Total Downloads
87+
.. |cakephp_version| image:: https://img.shields.io/github/release/php-http/cakephp-adapter.svg?style=flat-square
88+
:target: https://github.com/php-http/cakephp-adapter/releases
89+
:alt: Latest Version
90+
91+
.. |guzzle5_downloads| image:: https://img.shields.io/packagist/dt/php-http/guzzle5-adapter.svg?style=flat-square
92+
:target: https://packagist.org/packages/php-http/guzzle5-adapter
93+
:alt: Total Downloads
94+
.. |guzzle5_version| image:: https://img.shields.io/github/release/php-http/guzzle5-adapter.svg?style=flat-square
95+
:target: https://github.com/php-http/guzzle5-adapter/releases
96+
:alt: Latest Version
97+
98+
.. |guzzle6_downloads| image:: https://img.shields.io/packagist/dt/php-http/guzzle6-adapter.svg?style=flat-square
99+
:target: https://packagist.org/packages/php-http/guzzle6-adapter
100+
:alt: Total Downloads
101+
.. |guzzle6_version| image:: https://img.shields.io/github/release/php-http/guzzle6-adapter.svg?style=flat-square
102+
:target: https://github.com/php-http/guzzle6-adapter/releases
103+
:alt: Latest Version
104+
105+
.. |react_downloads| image:: https://img.shields.io/packagist/dt/php-http/react-adapter.svg?style=flat-square
106+
:target: https://packagist.org/packages/php-http/react-adapter
107+
:alt: Total Downloads
108+
.. |react_version| image:: https://img.shields.io/github/release/php-http/react-adapter.svg?style=flat-square
109+
:target: https://github.com/php-http/react-adapter/releases
110+
:alt: Latest Version
111+
112+
.. |zend_downloads| image:: https://img.shields.io/packagist/dt/php-http/zend-adapter.svg?style=flat-square
113+
:target: https://packagist.org/packages/php-http/zend-adapter
114+
:alt: Total Downloads
115+
.. |zend_version| image:: https://img.shields.io/github/release/php-http/zend-adapter.svg?style=flat-square
116+
:target: https://github.com/php-http/zend-adapter/releases
117+
:alt: Latest Version

clients/cakephp-adapter.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
CakePHP Adapter
2+
===============
3+
4+
An HTTPlug adapter for the CakePHP HTTP client.
5+
6+
Installation
7+
------------
8+
9+
To install the CakePHP adapter, which will also install CakePHP itself (if it was
10+
not yet included in your project), run:
11+
12+
.. code-block:: bash
13+
14+
$ composer require php-http/cakephp-adapter
15+
16+
.. include:: includes/install-message-factory.inc
17+
18+
.. include:: includes/install-discovery.inc
19+
20+
Usage
21+
-----
22+
23+
To be written...

clients/zend-adapter.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Zend Adapter
2+
============
3+
4+
An HTTPlug adapter for the Zend HTTP client.
5+
6+
Installation
7+
------------
8+
9+
To install the Zend adapter, which will also install Zend itself (if it was
10+
not yet included in your project), run:
11+
12+
.. code-block:: bash
13+
14+
$ composer require php-http/zend-adapter
15+
16+
.. include:: includes/install-message-factory.inc
17+
18+
.. include:: includes/install-discovery.inc
19+
20+
Usage
21+
-----
22+
23+
To be written...

0 commit comments

Comments
 (0)