Updated the contribution guide and refactored the sources to follow the guidelines.

Martin Brecht-Precht · Martin Brecht-Precht · commit aa2109e9ff33 · 2016-04-27T20:36:33.000+02:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -48,11 +48,22 @@ Always **make a new branch** for your work, no matter how small. This makes it e
 - **New features** should branch off of **the `master` branch.**
   - Note that depending on how long it takes for the dev team to merge your patch, the copy of `master` you worked off of may get out of date! If you find yourself ‘bumping’ a pull request that’s been sidelined for a while, **make sure you rebase or merge to latest `master`** to ensure a speedier resolution.
 
-### Code formatting
+### Coding standards
 
 **Follow the style you see used in the primary repository!** Consistency with the rest of the project always trumps other considerations. It doesn’t matter if you have your own style or if the rest of the code breaks with the greater community - just follow along.
 
-PHP projects usually follow the [PHP Standards Recommendations guidelines](http://www.php-fig.org/psr/) (though many have minor deviations depending on the lead maintainers’ preferences.)
+Our PHP projects usually follow the [PSR-1](http://www.php-fig.org/psr/psr-1/), [PSR-2](http://www.php-fig.org/psr/psr-2/) and [PSR-4](http://www.php-fig.org/psr/psr-4/) guidelines with minor deviations depending on the lead maintainers’ preferences.
+
+#### Naming things
+
+- Prefix abstract classes with `Abstract`
+- Suffix interfaces with `Interface`
+- Suffix traits with `Trait`
+- Suffix exceptions with `Exception`
+
+#### PHPDocs
+
+For type-hinting in PHPDocs and casting, use `bool` (instead of boolean or Boolean), `int` (instead of integer) and `float` (instead of double or real).
 
 ### Documentation isn’t optional
 
diff --git a/src/BasicHttpClient.php b/src/BasicHttpClient.php
@@ -2,12 +2,13 @@
 
 namespace BasicHttpClient;
 
-use BasicHttpClient\Request\Base\RequestInterface;
+use BasicHttpClient\Request\RequestInterface;
 use BasicHttpClient\Request\Message\Body\Body;
 use BasicHttpClient\Request\Message\Message;
 use BasicHttpClient\Request\Request;
 use BasicHttpClient\Request\Transport\HttpsTransport;
 use BasicHttpClient\Request\Transport\HttpTransport;
+use BasicHttpClient\Response\ResponseInterface;
 use BasicHttpClient\Util\UrlUtil;
 
 /**
@@ -51,7 +52,7 @@ public function getRequest()
 	}
 
 	/**
-	 * @return Response\Base\ResponseInterface
+	 * @return ResponseInterface
 	 */
 	public function get()
 	{
@@ -62,7 +63,7 @@ public function get()
 	}
 
 	/**
-	 * @return Response\Base\ResponseInterface
+	 * @return ResponseInterface
 	 */
 	public function head()
 	{
@@ -74,7 +75,7 @@ public function head()
 
 	/**
 	 * @param array $postData
-	 * @return Response\Base\ResponseInterface
+	 * @return ResponseInterface
 	 */
 	public function post(array $postData)
 	{
@@ -91,7 +92,7 @@ public function post(array $postData)
 
 	/**
 	 * @param array $putData
-	 * @return Response\Base\ResponseInterface
+	 * @return ResponseInterface
 	 */
 	public function put(array $putData)
 	{
@@ -108,7 +109,7 @@ public function put(array $putData)
 
 	/**
 	 * @param array $patchData
-	 * @return Response\Base\ResponseInterface
+	 * @return ResponseInterface
 	 */
 	public function patch(array $patchData)
 	{
@@ -124,7 +125,7 @@ public function patch(array $patchData)
 	}
 
 	/**
-	 * @return Response\Base\ResponseInterface
+	 * @return ResponseInterface
 	 */
 	public function delete()
 	{
diff --git a/src/Request/Authentication/AuthenticationInterface.php b/src/Request/Authentication/AuthenticationInterface.php
@@ -1,13 +1,13 @@
 <?php
 
-namespace BasicHttpClient\Request\Authentication\Base;
+namespace BasicHttpClient\Request\Authentication;
 
 use BasicHttpClient\Request\Base\CurlConfiguratorInterface;
 
 /**
  * Interface AuthenticationInterface
  *
- * @package BasicHttpClient\Request\Authentication\Base
+ * @package BasicHttpClient\Request\Authentication
  */
 interface AuthenticationInterface extends CurlConfiguratorInterface
 {
diff --git a/src/Request/Message/Body/Body.php b/src/Request/Message/Body/Body.php
@@ -7,7 +7,7 @@
  *
  * @package BasicHttpClient\Request\Message\Body
  */
-class Body implements Base\BodyInterface
+class Body implements BodyInterface
 {
 
 	/**
diff --git a/src/Request/Message/Body/BodyInterface.php b/src/Request/Message/Body/BodyInterface.php
@@ -1,13 +1,13 @@
 <?php
 
-namespace BasicHttpClient\Request\Message\Body\Base;
+namespace BasicHttpClient\Request\Message\Body;
 
 use BasicHttpClient\Request\Base\CurlConfiguratorInterface;
 
 /**
  * Interface BodyInterface
  *
- * @package BasicHttpClient\Request\Message\Body\Base
+ * @package BasicHttpClient\Request\Message\Body
  */
 interface BodyInterface extends CurlConfiguratorInterface
 {
diff --git a/src/Request/Message/Cookie/Cookie.php b/src/Request/Message/Cookie/Cookie.php
@@ -2,8 +2,6 @@
 
 namespace BasicHttpClient\Request\Message\Cookie;
 
-use BasicHttpClient\Request\Message\Cookie\Base\CookieInterface;
-
 /**
  * Class Cookie
  *
diff --git a/src/Request/Message/Cookie/CookieInterface.php b/src/Request/Message/Cookie/CookieInterface.php
@@ -1,9 +1,9 @@
 <?php
 
-namespace BasicHttpClient\Request\Message\Cookie\Base;
+namespace BasicHttpClient\Request\Message\Cookie;
 
 /**
- * Class Cookie
+ * Interface CookieInterface
  *
  * @package BasicHttpClient\Request\Message\Cookie
  */
diff --git a/src/Request/Message/Header/Header.php b/src/Request/Message/Header/Header.php
@@ -2,7 +2,6 @@
 
 namespace BasicHttpClient\Request\Message\Header;
 
-use BasicHttpClient\Request\Message\Header\Base\HeaderInterface;
 use BasicHttpClient\Util\HeaderNameUtil;
 
 /**
diff --git a/src/Request/Message/Header/HeaderInterface.php b/src/Request/Message/Header/HeaderInterface.php
@@ -1,11 +1,11 @@
 <?php
 
-namespace BasicHttpClient\Request\Message\Header\Base;
+namespace BasicHttpClient\Request\Message\Header;
 
 /**
  * Interface HeaderInterface
  *
- * @package BasicHttpClient\Request\Message\Header\Base
+ * @package BasicHttpClient\Request\Message\Header
  */
 interface HeaderInterface
 {
diff --git a/src/Request/Message/Message.php b/src/Request/Message/Message.php
@@ -2,10 +2,9 @@
 
 namespace BasicHttpClient\Request\Message;
 
-use BasicHttpClient\Request\Message\Base\MessageInterface;
-use BasicHttpClient\Request\Message\Body\Base\BodyInterface;
-use BasicHttpClient\Request\Message\Cookie\Base\CookieInterface;
-use BasicHttpClient\Request\Message\Header\Base\HeaderInterface;
+use BasicHttpClient\Request\Message\Body\BodyInterface;
+use BasicHttpClient\Request\Message\Cookie\CookieInterface;
+use BasicHttpClient\Request\Message\Header\HeaderInterface;
 use BasicHttpClient\Util\HeaderNameUtil;
 
 /**
diff --git a/src/Request/Message/MessageInterface.php b/src/Request/Message/MessageInterface.php
@@ -1,16 +1,16 @@
 <?php
 
-namespace BasicHttpClient\Request\Message\Base;
+namespace BasicHttpClient\Request\Message;
 
 use BasicHttpClient\Request\Base\CurlConfiguratorInterface;
-use BasicHttpClient\Request\Message\Body\Base\BodyInterface;
-use BasicHttpClient\Request\Message\Cookie\Base\CookieInterface;
-use BasicHttpClient\Request\Message\Header\Base\HeaderInterface;
+use BasicHttpClient\Request\Message\Body\BodyInterface;
+use BasicHttpClient\Request\Message\Cookie\CookieInterface;
+use BasicHttpClient\Request\Message\Header\HeaderInterface;
 
 /**
  * Interface MessageInterface
  *
- * @package BasicHttpClient\Request\Message\Base
+ * @package BasicHttpClient\Request\Message
  */
 interface MessageInterface extends CurlConfiguratorInterface
 {
diff --git a/src/Request/Request.php b/src/Request/Request.php
@@ -2,14 +2,13 @@
 
 namespace BasicHttpClient\Request;
 
-use BasicHttpClient\Request\Authentication\Base\AuthenticationInterface;
-use BasicHttpClient\Request\Base\RequestInterface;
-use BasicHttpClient\Request\Message\Base\MessageInterface;
+use BasicHttpClient\Request\Authentication\AuthenticationInterface;
+use BasicHttpClient\Request\Message\MessageInterface;
 use BasicHttpClient\Request\Message\Header\Header;
-use BasicHttpClient\Request\Transport\Base\TransportInterface;
+use BasicHttpClient\Request\Transport\TransportInterface;
 use BasicHttpClient\Request\Transport\HttpsTransport;
 use BasicHttpClient\Request\Transport\HttpTransport;
-use BasicHttpClient\Response\Base\ResponseInterface;
+use BasicHttpClient\Response\ResponseInterface;
 use BasicHttpClient\Response\Response;
 use BasicHttpClient\Util\UrlUtil;
 use CommonException\NetworkException\Base\NetworkException;
diff --git a/src/Request/RequestInterface.php b/src/Request/RequestInterface.php
@@ -1,15 +1,16 @@
 <?php
 
-namespace BasicHttpClient\Request\Base;
+namespace BasicHttpClient\Request;
 
-use BasicHttpClient\Request\Authentication\Base\AuthenticationInterface;
-use BasicHttpClient\Request\Message\Base\MessageInterface;
+use BasicHttpClient\Request\Authentication\AuthenticationInterface;
+use BasicHttpClient\Request\Base\CurlConfiguratorInterface;
+use BasicHttpClient\Request\Message\MessageInterface;
 use BasicHttpClient\Request\Message\Header\Header;
-use BasicHttpClient\Request\Transport\Base\TransportInterface;
-use BasicHttpClient\Response\Base\ResponseInterface;
+use BasicHttpClient\Request\Transport\TransportInterface;
+use BasicHttpClient\Response\ResponseInterface;
 
 /**
- * Class Request
+ * Interface RequestInterface
  *
  * @package BasicHttpClient\Request
  */
diff --git a/src/Request/Transport/HttpTransport.php b/src/Request/Transport/HttpTransport.php
@@ -7,7 +7,7 @@
  *
  * @package BasicHttpClient\Request\Transport
  */
-class HttpTransport implements Base\TransportInterface
+class HttpTransport implements TransportInterface
 {
 
 	const HTTP_VERSION_1_0 = CURL_HTTP_VERSION_1_0;
diff --git a/src/Request/Transport/TransportInterface.php b/src/Request/Transport/TransportInterface.php
@@ -1,13 +1,13 @@
 <?php
 
-namespace BasicHttpClient\Request\Transport\Base;
+namespace BasicHttpClient\Request\Transport;
 
 use BasicHttpClient\Request\Base\CurlConfiguratorInterface;
 
 /**
  * Interface TransportInterface
  *
- * @package BasicHttpClient\Request\Transport\Base
+ * @package BasicHttpClient\Request\Transport
  */
 interface TransportInterface extends CurlConfiguratorInterface
 {
diff --git a/src/Response/Response.php b/src/Response/Response.php
@@ -2,8 +2,7 @@
 
 namespace BasicHttpClient\Response;
 
-use BasicHttpClient\Request\Base\RequestInterface;
-use BasicHttpClient\Response\Base\ResponseInterface;
+use BasicHttpClient\Request\RequestInterface;
 use BasicHttpClient\Response\Header\Header;
 use BasicHttpClient\Response\Statistics\Statistics;
 
diff --git a/src/Response/ResponseInterface.php b/src/Response/ResponseInterface.php
@@ -1,8 +1,8 @@
 <?php
 
-namespace BasicHttpClient\Response\Base;
+namespace BasicHttpClient\Response;
 
-use BasicHttpClient\Request\Base\RequestInterface;
+use BasicHttpClient\Request\RequestInterface;
 use BasicHttpClient\Response\Header\Header;
 use BasicHttpClient\Response\Statistics\Statistics;
 
diff --git a/test.php b/test.php
@@ -80,3 +80,5 @@ function generateRandomString($length = 10)
 }
 
 $response = $client->post($postData);
+
+print_r($response);

Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,13 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-namespace BasicHttpClient\Request\Authentication\Base;`
	`3`	`+namespace BasicHttpClient\Request\Authentication;`
`4`	`4`
`5`	`5`	`use BasicHttpClient\Request\Base\CurlConfiguratorInterface;`
`6`	`6`
`7`	`7`	`/**`
`8`	`8`	`* Interface AuthenticationInterface`
`9`	`9`	`*`
`10`		`- * @package BasicHttpClient\Request\Authentication\Base`
	`10`	`+ * @package BasicHttpClient\Request\Authentication`
`11`	`11`	`*/`
`12`	`12`	`interface AuthenticationInterface extends CurlConfiguratorInterface`
`13`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`*`
`8`	`8`	`* @package BasicHttpClient\Request\Message\Body`
`9`	`9`	`*/`
`10`		`-class Body implements Base\BodyInterface`
	`10`	`+class Body implements BodyInterface`
`11`	`11`	`{`
`12`	`12`
`13`	`13`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,13 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-namespace BasicHttpClient\Request\Message\Body\Base;`
	`3`	`+namespace BasicHttpClient\Request\Message\Body;`
`4`	`4`
`5`	`5`	`use BasicHttpClient\Request\Base\CurlConfiguratorInterface;`
`6`	`6`
`7`	`7`	`/**`
`8`	`8`	`* Interface BodyInterface`
`9`	`9`	`*`
`10`		`- * @package BasicHttpClient\Request\Message\Body\Base`
	`10`	`+ * @package BasicHttpClient\Request\Message\Body`
`11`	`11`	`*/`
`12`	`12`	`interface BodyInterface extends CurlConfiguratorInterface`
`13`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,6 @@`
`2`	`2`
`3`	`3`	`namespace BasicHttpClient\Request\Message\Cookie;`
`4`	`4`
`5`		`-use BasicHttpClient\Request\Message\Cookie\Base\CookieInterface;`
`6`		`-`
`7`	`5`	`/**`
`8`	`6`	`* Class Cookie`
`9`	`7`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,11 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-namespace BasicHttpClient\Request\Message\Header\Base;`
	`3`	`+namespace BasicHttpClient\Request\Message\Header;`
`4`	`4`
`5`	`5`	`/**`
`6`	`6`	`* Interface HeaderInterface`
`7`	`7`	`*`
`8`		`- * @package BasicHttpClient\Request\Message\Header\Base`
	`8`	`+ * @package BasicHttpClient\Request\Message\Header`
`9`	`9`	`*/`
`10`	`10`	`interface HeaderInterface`
`11`	`11`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`*`
`8`	`8`	`* @package BasicHttpClient\Request\Transport`
`9`	`9`	`*/`
`10`		`-class HttpTransport implements Base\TransportInterface`
	`10`	`+class HttpTransport implements TransportInterface`
`11`	`11`	`{`
`12`	`12`
`13`	`13`	`const HTTP_VERSION_1_0 = CURL_HTTP_VERSION_1_0;`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,13 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-namespace BasicHttpClient\Request\Transport\Base;`
	`3`	`+namespace BasicHttpClient\Request\Transport;`
`4`	`4`
`5`	`5`	`use BasicHttpClient\Request\Base\CurlConfiguratorInterface;`
`6`	`6`
`7`	`7`	`/**`
`8`	`8`	`* Interface TransportInterface`
`9`	`9`	`*`
`10`		`- * @package BasicHttpClient\Request\Transport\Base`
	`10`	`+ * @package BasicHttpClient\Request\Transport`
`11`	`11`	`*/`
`12`	`12`	`interface TransportInterface extends CurlConfiguratorInterface`
`13`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -80,3 +80,5 @@ function generateRandomString($length = 10)`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`$response = $client->post($postData);`
	`83`	`+`
	`84`	`+print_r($response);`