Skip to content

Commit 8e45916

Browse files
author
Martin Brecht-Precht
committed
Updated dependencies.
Updated readme. Added company root namespace.
1 parent c4a3cf7 commit 8e45916

34 files changed

+173
-171
lines changed

README.md

+26-26
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ require_once('path/to/vendor/autoload.php');
4444
#### Preparing the HTTP client
4545

4646
```{php}
47-
use BasicHttpClient;
48-
use BasicHttpClient\Request\Authentication;
49-
use BasicHttpClient\Request\Message;
47+
use Markenwerk\BasicHttpClient;
48+
use Markenwerk\BasicHttpClient\Request\Authentication;
49+
use Markenwerk\BasicHttpClient\Request\Message;
5050
5151
// Instantiating a basic HTTP client with the endpoints URL
5252
// If the endpoint uses the `HTTPS` schema a `HttpsTransport` instance will be used automatically.
@@ -134,7 +134,7 @@ The following example shows the usage with a more detailed configuration.
134134
#### Configuring a HTTP Transport instance
135135

136136
```{php}
137-
use BasicHttpClient\Request\Transport\HttpTransport;
137+
use Markenwerk\BasicHttpClient\Request\Transport\HttpTransport;
138138
139139
// Configuring a Transport instance
140140
$transport = new HttpTransport();
@@ -150,7 +150,7 @@ $transport
150150
#### Configuring a HTTPS Transport instance
151151

152152
```{php}
153-
use BasicHttpClient\Request\Transport\HttpsTransport;
153+
use Markenwerk\BasicHttpClient\Request\Transport\HttpsTransport;
154154
155155
// Configuring a Transport instance
156156
$transport = new HttpsTransport();
@@ -167,10 +167,10 @@ $transport
167167
#### Configuring a Message instance with Body
168168

169169
```{php}
170-
use BasicHttpClient\Request\Message\Body\Body;
171-
use BasicHttpClient\Request\Message\Cookie\Cookie;
172-
use BasicHttpClient\Request\Message\Header\Header;
173-
use BasicHttpClient\Request\Message\Message;
170+
use Markenwerk\BasicHttpClient\Request\Message\Body\Body;
171+
use Markenwerk\BasicHttpClient\Request\Message\Cookie\Cookie;
172+
use Markenwerk\BasicHttpClient\Request\Message\Header\Header;
173+
use Markenwerk\BasicHttpClient\Request\Message\Message;
174174
175175
// Configuring a message Body instance
176176
$messageBody = new Body();
@@ -221,9 +221,9 @@ $message->addAdditionalHeader(new Header('Custom-Header', array('AnotherCustomHe
221221
For more information about the usage of the URL object please take a look at the [PHP URL Util](https://github.com/markenwerk/php-url-util) project.
222222

223223
```{php}
224-
use BasicHttpClient\Request\Authentication\BasicAuthentication;
225-
use BasicHttpClient\Request\Request;
226-
use Url\Url;
224+
use Markenwerk\BasicHttpClient\Request\Authentication\BasicAuthentication;
225+
use Markenwerk\BasicHttpClient\Request\Request;
226+
use Markenwerk\UrlUtil\Url;
227227
228228
// Setting up the endpoints URL
229229
$url = new Url('https://john:[email protected]:443/path/to/resource?arg1=123#fragment');
@@ -273,8 +273,8 @@ You can add one or more Authentication instances to every Request instance. At t
273273
Required credentials are a *username* and a *password* that get provided to the class constructor as arguments.
274274

275275
```{php}
276-
use BasicHttpClient\Request\Authentication\BasicAuthentication;
277-
use BasicHttpClient\Request\Request;
276+
use Markenwerk\BasicHttpClient\Request\Authentication\BasicAuthentication;
277+
use Markenwerk\BasicHttpClient\Request\Request;
278278
279279
// Configuring the authentication
280280
$basicAuthentication = new BasicAuthentication('username', 'password');
@@ -289,8 +289,8 @@ $request->addAuthentication($basicAuthentication);
289289
Required credentials are a *Certificate Authority Certificate*, a *Client Certificate* and the password that is used to decrypt the Client Certificate that get provided to the class constructor as arguments.
290290

291291
```{php}
292-
use BasicHttpClient\Request\Authentication\ClientCertificateAuthentication;
293-
use BasicHttpClient\Request\Request;
292+
use Markenwerk\BasicHttpClient\Request\Authentication\ClientCertificateAuthentication;
293+
use Markenwerk\BasicHttpClient\Request\Request;
294294
295295
// Configuring the authentication
296296
$clientCertificateAuthentication = new ClientCertificateAuthentication(
@@ -313,7 +313,7 @@ $request->addAuthentication($clientCertificateAuthentication);
313313
If using the `BasicHttpClient` the response object is returned by the termination methods listed above. If directly using the Request instance, you can get the Response object via a getter.
314314

315315
```{php}
316-
// Getting the response BasicHttpClient\Response\Response object
316+
// Getting the response Markenwerk\BasicHttpClient\Response\Response object
317317
$response = $request->getResponse();
318318
319319
// Reading the HTTP status code as integer; will return `200`
@@ -322,7 +322,7 @@ echo print_r($response->getStatusCode(), true) . PHP_EOL;
322322
// Reading the HTTP status text as string; will return `HTTP/1.1 200 OK`
323323
echo print_r($response->getStatusText(), true) . PHP_EOL;
324324
325-
// Reading the HTTP response headers as array of BasicHttpClient\Response\Header\Header objects
325+
// Reading the HTTP response headers as array of Markenwerk\BasicHttpClient\Response\Header\Header objects
326326
echo print_r($response->getHeaders(), true) . PHP_EOL;
327327
328328
// Reading the HTTP response body as string
@@ -345,7 +345,7 @@ echo print_r($request->getEffectiveStatus(), true) . PHP_EOL;
345345
// Getting the effective raw request headers as string
346346
echo print_r($request->getEffectiveRawHeader(), true) . PHP_EOL;
347347
348-
// Getting the effective request headers as array of `BasicHttpClient\Request\Message\Header\Header` objects
348+
// Getting the effective request headers as array of `Markenwerk\BasicHttpClient\Request\Message\Header\Header` objects
349349
echo print_r($request->getEffectiveHeaders(), true) . PHP_EOL.PHP_EOL;
350350
```
351351

@@ -354,7 +354,7 @@ echo print_r($request->getEffectiveHeaders(), true) . PHP_EOL.PHP_EOL;
354354
## Getting some transactional statistics
355355

356356
```{php}
357-
// Getting the statistics BasicHttpClient\Response\Statistics\Statistics object
357+
// Getting the statistics Markenwerk\BasicHttpClient\Response\Statistics\Statistics object
358358
$statistics = $request->getResponse()->getStatistics();
359359
360360
// Reading the redirection URL if the server responds with an redirect HTTP header and
@@ -403,12 +403,12 @@ You can find more information about [PHP Common Exceptions at Github](https://gi
403403

404404
In general you should expect that any setter method could thrown an `\InvalidArgumentException`. The following exceptions could get thrown while using PHP Basic HTTP Client.
405405

406-
- `CommonException\IoException\FileNotFoundException` on configuring a `ClientCertificateAuthentication`instance
407-
- `CommonException\IoException\FileReadableException` on configuring a `ClientCertificateAuthentication`instance
408-
- `BasicHttpClient\Exception\HttpRequestAuthenticationException` on performing a request
409-
- `BasicHttpClient\Exception\HttpRequestException` on performing a request
410-
- `CommonException\NetworkException\ConnectionTimeoutException` on performing a request
411-
- `CommonException\NetworkException\CurlException` on performing a request
406+
- `Markenwerk\CommonException\IoException\FileNotFoundException` on configuring a `ClientCertificateAuthentication`instance
407+
- `Markenwerk\CommonException\IoException\FileReadableException` on configuring a `ClientCertificateAuthentication`instance
408+
- `Markenwerk\BasicHttpClient\Exception\HttpRequestAuthenticationException` on performing a request
409+
- `Markenwerk\BasicHttpClient\Exception\HttpRequestException` on performing a request
410+
- `Markenwerk\CommonException\NetworkException\ConnectionTimeoutException` on performing a request
411+
- `Markenwerk\CommonException\NetworkException\CurlException` on performing a request
412412

413413
---
414414

composer.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@
2121
],
2222
"autoload": {
2323
"psr-4": {
24-
"BasicHttpClient\\": "src/"
24+
"Markenwerk\\BasicHttpClient\\": "src/"
2525
}
2626
},
2727
"require": {
2828
"php": ">=5.3",
2929
"lib-curl": "*",
30-
"markenwerk/url-util": "~1.0",
31-
"markenwerk/common-exceptions": "~2.0"
30+
"markenwerk/url-util": "~2.0",
31+
"markenwerk/common-exceptions": "~3.0"
3232
},
3333
"require-dev": {
3434
"phpunit/phpunit": "~4.8",

detaild.php

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
namespace Project;
44

5-
use BasicHttpClient\Request\Authentication\BasicAuthentication;
6-
use BasicHttpClient\Request\Message\Body\Body;
7-
use BasicHttpClient\Request\Message\Cookie\Cookie;
8-
use BasicHttpClient\Request\Message\Header\Header;
9-
use BasicHttpClient\Request\Message\Message;
10-
use BasicHttpClient\Request\Request;
11-
use BasicHttpClient\Request\Transport\HttpsTransport;
12-
use Url\Url;
5+
use Markenwerk\BasicHttpClient\Request\Authentication\BasicAuthentication;
6+
use Markenwerk\BasicHttpClient\Request\Message\Body\Body;
7+
use Markenwerk\BasicHttpClient\Request\Message\Cookie\Cookie;
8+
use Markenwerk\BasicHttpClient\Request\Message\Header\Header;
9+
use Markenwerk\BasicHttpClient\Request\Message\Message;
10+
use Markenwerk\BasicHttpClient\Request\Request;
11+
use Markenwerk\BasicHttpClient\Request\Transport\HttpsTransport;
12+
use Markenwerk\UrlUtil\Url;
1313

1414
require_once('vendor/autoload.php');
1515

src/BasicHttpClient.php

+24-22
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
<?php
22

3-
namespace BasicHttpClient;
3+
namespace Markenwerk\BasicHttpClient;
44

5-
use BasicHttpClient\Request\RequestInterface;
6-
use BasicHttpClient\Request\Message\Body\Body;
7-
use BasicHttpClient\Request\Message\Message;
8-
use BasicHttpClient\Request\Request;
9-
use BasicHttpClient\Request\Transport\HttpsTransport;
10-
use BasicHttpClient\Request\Transport\HttpTransport;
11-
use BasicHttpClient\Response\ResponseInterface;
12-
use Url\Url;
5+
use Markenwerk\BasicHttpClient\Request\RequestInterface;
6+
use Markenwerk\BasicHttpClient\Request\Message\Body\Body;
7+
use Markenwerk\BasicHttpClient\Request\Message\Message;
8+
use Markenwerk\BasicHttpClient\Request\Request;
9+
use Markenwerk\BasicHttpClient\Request\Transport\HttpsTransport;
10+
use Markenwerk\BasicHttpClient\Request\Transport\HttpTransport;
11+
use Markenwerk\BasicHttpClient\Response\ResponseInterface;
12+
use Markenwerk\CommonException\NetworkException\Base\NetworkException;
13+
use Markenwerk\CommonException\NetworkException\ConnectionTimeoutException;
14+
use Markenwerk\UrlUtil\Url;
1315

1416
/**
1517
* Class BasicHttpClient
1618
*
17-
* @package BasicHttpClient
19+
* @package Markenwerk\BasicHttpClient
1820
*/
1921
class BasicHttpClient implements HttpClientInterface
2022
{
@@ -58,8 +60,8 @@ public function getRequest()
5860
/**
5961
* @param mixed[] $queryParameters
6062
* @return ResponseInterface
61-
* @throws \CommonException\NetworkException\Base\NetworkException
62-
* @throws \CommonException\NetworkException\ConnectionTimeoutException
63+
* @throws NetworkException
64+
* @throws ConnectionTimeoutException
6365
*/
6466
public function get(array $queryParameters = null)
6567
{
@@ -74,8 +76,8 @@ public function get(array $queryParameters = null)
7476
/**
7577
* @param mixed[] $queryParameters
7678
* @return ResponseInterface
77-
* @throws \CommonException\NetworkException\Base\NetworkException
78-
* @throws \CommonException\NetworkException\ConnectionTimeoutException
79+
* @throws NetworkException
80+
* @throws ConnectionTimeoutException
7981
*/
8082
public function head(array $queryParameters = null)
8183
{
@@ -90,8 +92,8 @@ public function head(array $queryParameters = null)
9092
/**
9193
* @param array $postData
9294
* @return ResponseInterface
93-
* @throws \CommonException\NetworkException\Base\NetworkException
94-
* @throws \CommonException\NetworkException\ConnectionTimeoutException
95+
* @throws NetworkException
96+
* @throws ConnectionTimeoutException
9597
*/
9698
public function post(array $postData = null)
9799
{
@@ -109,8 +111,8 @@ public function post(array $postData = null)
109111
/**
110112
* @param array $putData
111113
* @return ResponseInterface
112-
* @throws \CommonException\NetworkException\Base\NetworkException
113-
* @throws \CommonException\NetworkException\ConnectionTimeoutException
114+
* @throws NetworkException
115+
* @throws ConnectionTimeoutException
114116
*/
115117
public function put(array $putData = null)
116118
{
@@ -128,8 +130,8 @@ public function put(array $putData = null)
128130
/**
129131
* @param array $patchData
130132
* @return ResponseInterface
131-
* @throws \CommonException\NetworkException\Base\NetworkException
132-
* @throws \CommonException\NetworkException\ConnectionTimeoutException
133+
* @throws NetworkException
134+
* @throws ConnectionTimeoutException
133135
*/
134136
public function patch(array $patchData = null)
135137
{
@@ -147,8 +149,8 @@ public function patch(array $patchData = null)
147149
/**
148150
* @param mixed[] $queryParameters
149151
* @return ResponseInterface
150-
* @throws \CommonException\NetworkException\Base\NetworkException
151-
* @throws \CommonException\NetworkException\ConnectionTimeoutException
152+
* @throws NetworkException
153+
* @throws ConnectionTimeoutException
152154
*/
153155
public function delete(array $queryParameters = null)
154156
{

src/Exception/HttpRequestAuthenticationException.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<?php
22

3-
namespace BasicHttpClient\Exception;
3+
namespace Markenwerk\BasicHttpClient\Exception;
44

55
/**
66
* Class HttpRequestAuthenticationException
77
*
8-
* @package BasicHttpClient\Exception
8+
* @package Markenwerk\BasicHttpClient\Exception
99
*/
1010
class HttpRequestAuthenticationException extends \Exception
1111
{

src/Exception/HttpRequestException.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<?php
22

3-
namespace BasicHttpClient\Exception;
3+
namespace Markenwerk\BasicHttpClient\Exception;
44

55
/**
66
* Class HttpRequestException
77
*
8-
* @package BasicHttpClient\Exception
8+
* @package Markenwerk\BasicHttpClient\Exception
99
*/
1010
class HttpRequestException extends \Exception
1111
{

src/Exception/HttpRequestMessageException.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<?php
22

3-
namespace BasicHttpClient\Exception;
3+
namespace Markenwerk\BasicHttpClient\Exception;
44

55
/**
66
* Class HttpRequestMessageException
77
*
8-
* @package BasicHttpClient\Exception
8+
* @package Markenwerk\BasicHttpClient\Exception
99
*/
1010
class HttpRequestMessageException extends \Exception
1111
{

src/Exception/HttpResponseException.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<?php
22

3-
namespace BasicHttpClient\Exception;
3+
namespace Markenwerk\BasicHttpClient\Exception;
44

55
/**
66
* Class HttpResponseException
77
*
8-
* @package BasicHttpClient\Exception
8+
* @package Markenwerk\BasicHttpClient\Exception
99
*/
1010
class HttpResponseException extends \Exception
1111
{

src/HttpClientInterface.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<?php
22

3-
namespace BasicHttpClient;
3+
namespace Markenwerk\BasicHttpClient;
44

5-
use BasicHttpClient\Request\RequestInterface;
6-
use BasicHttpClient\Response\ResponseInterface;
5+
use Markenwerk\BasicHttpClient\Request\RequestInterface;
6+
use Markenwerk\BasicHttpClient\Response\ResponseInterface;
77

88
/**
99
* Interface HttpClientInterface
1010
*
11-
* @package BasicHttpClient
11+
* @package Markenwerk\BasicHttpClient
1212
*/
1313
interface HttpClientInterface
1414
{

src/Request/AbstractRequest.php

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
<?php
22

3-
namespace BasicHttpClient\Request;
4-
5-
use BasicHttpClient\Exception\HttpRequestException;
6-
use BasicHttpClient\Request\Authentication\AuthenticationInterface;
7-
use BasicHttpClient\Request\Message\MessageInterface;
8-
use BasicHttpClient\Request\Message\Header\Header;
9-
use BasicHttpClient\Request\Transport\TransportInterface;
10-
use BasicHttpClient\Request\Transport\HttpsTransport;
11-
use BasicHttpClient\Request\Transport\HttpTransport;
12-
use BasicHttpClient\Response\ResponseInterface;
13-
use CommonException\NetworkException\Base\NetworkException;
14-
use CommonException\NetworkException\ConnectionTimeoutException;
15-
use CommonException\NetworkException\CurlException;
16-
use Url\UrlInterface;
3+
namespace Markenwerk\BasicHttpClient\Request;
4+
5+
use Markenwerk\BasicHttpClient\Exception\HttpRequestException;
6+
use Markenwerk\BasicHttpClient\Request\Authentication\AuthenticationInterface;
7+
use Markenwerk\BasicHttpClient\Request\Message\MessageInterface;
8+
use Markenwerk\BasicHttpClient\Request\Message\Header\Header;
9+
use Markenwerk\BasicHttpClient\Request\Transport\TransportInterface;
10+
use Markenwerk\BasicHttpClient\Request\Transport\HttpsTransport;
11+
use Markenwerk\BasicHttpClient\Request\Transport\HttpTransport;
12+
use Markenwerk\BasicHttpClient\Response\ResponseInterface;
13+
use Markenwerk\CommonException\NetworkException\Base\NetworkException;
14+
use Markenwerk\CommonException\NetworkException\ConnectionTimeoutException;
15+
use Markenwerk\CommonException\NetworkException\CurlException;
16+
use Markenwerk\UrlUtil\UrlInterface;
1717

1818
/**
1919
* Class Request
2020
*
21-
* @package BasicHttpClient\Request
21+
* @package Markenwerk\BasicHttpClient\Request
2222
*/
2323
abstract class AbstractRequest implements RequestInterface
2424
{

0 commit comments

Comments
 (0)