From 826b6f2c1dd8a94239ad3808dad0bab7c3ee270b Mon Sep 17 00:00:00 2001
From: Martin Brecht-Precht <mb@markenwerk.net>
Date: Tue, 26 Apr 2016 10:08:49 +0200
Subject: [PATCH] Added some more exception classes. Reorganized the namespace
 structure. Updated readme.

---
 README.md                                      | 18 +++++++++++-------
 ...ception.php => AuthenticationException.php} |  4 ++--
 src/ApiException/{ => Base}/ApiException.php   |  4 +++-
 src/ApiException/Base/BaseException.php        | 15 ---------------
 src/ApiException/InvalidResponseException.php  | 13 +++++++++++++
 ...mitException.php => NoResultsException.php} |  4 ++--
 ...Exception.php => RequestQuotaException.php} |  4 ++--
 .../{BaseException.php => IoException.php}     |  2 +-
 src/IoException/FileCopyException.php          | 13 +++++++++++++
 src/IoException/FileDeleteException.php        | 13 +++++++++++++
 src/IoException/FileMoveException.php          | 13 +++++++++++++
 src/IoException/FileReadException.php          | 13 +++++++++++++
 src/IoException/FileWriteException.php         |  2 +-
 src/NetworkException/Base/NetworkException.php | 15 +++++++++++++++
 src/NetworkException/Base/TimeoutException.php | 13 +++++++++++++
 src/NetworkException/ConnectionException.php   | 13 +++++++++++++
 .../ConnectionTimeoutException.php             | 13 +++++++++++++
 src/NetworkException/CurlException.php         | 13 +++++++++++++
 src/NetworkException/ReadTimeoutException.php  | 13 +++++++++++++
 src/NetworkException/WriteTimeoutException.php | 13 +++++++++++++
 20 files changed, 180 insertions(+), 31 deletions(-)
 rename src/ApiException/{ApiNoResultsException.php => AuthenticationException.php} (54%)
 rename src/ApiException/{ => Base}/ApiException.php (64%)
 delete mode 100644 src/ApiException/Base/BaseException.php
 create mode 100644 src/ApiException/InvalidResponseException.php
 rename src/ApiException/{ApiLimitException.php => NoResultsException.php} (57%)
 rename src/ApiException/{NetworkException.php => RequestQuotaException.php} (55%)
 rename src/IoException/Base/{BaseException.php => IoException.php} (74%)
 create mode 100644 src/IoException/FileCopyException.php
 create mode 100644 src/IoException/FileDeleteException.php
 create mode 100644 src/IoException/FileMoveException.php
 create mode 100644 src/IoException/FileReadException.php
 create mode 100644 src/NetworkException/Base/NetworkException.php
 create mode 100644 src/NetworkException/Base/TimeoutException.php
 create mode 100644 src/NetworkException/ConnectionException.php
 create mode 100644 src/NetworkException/ConnectionTimeoutException.php
 create mode 100644 src/NetworkException/CurlException.php
 create mode 100644 src/NetworkException/ReadTimeoutException.php
 create mode 100644 src/NetworkException/WriteTimeoutException.php

diff --git a/README.md b/README.md
index ef01de1..e88f57f 100644
--- a/README.md
+++ b/README.md
@@ -34,13 +34,15 @@ require_once('path/to/vendor/autoload.php');
 ```{php}
 try{
 	// Perform something maybe throwing an exception
-} catch (CommonException\ApiException\NetworkException $exception) {
-	// API is not reachable or curl failed
-} catch (CommonException\ApiException\ApiException $exception) {
+} catch (CommonException\NetworkException\ConnectionException $exception) {
+	// API is not reachable
+} catch (CommonException\NetworkException\CurlException $exception) {
+	// Curl failed
+} catch (CommonException\ApiException\InvalidResponseException $exception) {
 	// API returns an unexpected result
-} catch (CommonException\ApiException\ApiLimitException $exception) {
+} catch (CommonException\ApiException\RequestQuotaException $exception) {
 	// API requests over the allowed limit
-} catch (CommonException\ApiException\ApiNoResultsException $exception) {
+} catch (CommonException\ApiException\NoResultsException $exception) {
 	// API request had no result
 } catch (CommonException\IoException\FileWriteException $exception) {
 	// Log file was not writable
@@ -53,9 +55,11 @@ try{
 ```{php}
 try{
 	// Perform something maybe throwing an exception
-} catch (CommonException\ApiException\Base\BaseException $exception) {
+} catch (CommonException\NetworkException\Base\NetworkException $exception) {
+	// Any network exception was thrown
+} catch (CommonException\ApiException\Base\ApiException $exception) {
 	// Any API exception was thrown
-} catch (CommonException\IoException\Base\BaseException $exception) {
+} catch (CommonException\IoException\Base\IoException $exception) {
 	// Any IO exception was thrown
 }
 
diff --git a/src/ApiException/ApiNoResultsException.php b/src/ApiException/AuthenticationException.php
similarity index 54%
rename from src/ApiException/ApiNoResultsException.php
rename to src/ApiException/AuthenticationException.php
index 1db233f..ab86b2a 100644
--- a/src/ApiException/ApiNoResultsException.php
+++ b/src/ApiException/AuthenticationException.php
@@ -3,11 +3,11 @@
 namespace CommonException\ApiException;
 
 /**
- * Class ApiNoResultsException
+ * Class AuthenticationException
  *
  * @package CommonException\ApiException
  */
-class ApiNoResultsException extends Base\BaseException
+class AuthenticationException extends Base\ApiException
 {
 
 }
diff --git a/src/ApiException/ApiException.php b/src/ApiException/Base/ApiException.php
similarity index 64%
rename from src/ApiException/ApiException.php
rename to src/ApiException/Base/ApiException.php
index 9d8e827..a24f73e 100644
--- a/src/ApiException/ApiException.php
+++ b/src/ApiException/Base/ApiException.php
@@ -1,6 +1,8 @@
 <?php
 
-namespace CommonException\ApiException;
+namespace CommonException\ApiException\Base;
+
+use CommonException\Base;
 
 /**
  * Class ApiException
diff --git a/src/ApiException/Base/BaseException.php b/src/ApiException/Base/BaseException.php
deleted file mode 100644
index bdc73df..0000000
--- a/src/ApiException/Base/BaseException.php
+++ /dev/null
@@ -1,15 +0,0 @@
-<?php
-
-namespace CommonException\ApiException\Base;
-
-use CommonException\Base;
-
-/**
- * Class BaseException
- *
- * @package CommonException\ApiException\Base
- */
-abstract class BaseException extends Base\BaseException
-{
-
-}
diff --git a/src/ApiException/InvalidResponseException.php b/src/ApiException/InvalidResponseException.php
new file mode 100644
index 0000000..233dc9f
--- /dev/null
+++ b/src/ApiException/InvalidResponseException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace CommonException\ApiException;
+
+/**
+ * Class InvalidResponseException
+ *
+ * @package CommonException\ApiException
+ */
+class InvalidResponseException extends Base\ApiException
+{
+
+}
diff --git a/src/ApiException/ApiLimitException.php b/src/ApiException/NoResultsException.php
similarity index 57%
rename from src/ApiException/ApiLimitException.php
rename to src/ApiException/NoResultsException.php
index ee216e7..553a3c1 100644
--- a/src/ApiException/ApiLimitException.php
+++ b/src/ApiException/NoResultsException.php
@@ -3,11 +3,11 @@
 namespace CommonException\ApiException;
 
 /**
- * Class ApiLimitException
+ * Class NoResultsException
  *
  * @package CommonException\ApiException
  */
-class ApiLimitException extends Base\BaseException
+class NoResultsException extends Base\ApiException
 {
 
 }
diff --git a/src/ApiException/NetworkException.php b/src/ApiException/RequestQuotaException.php
similarity index 55%
rename from src/ApiException/NetworkException.php
rename to src/ApiException/RequestQuotaException.php
index 7dc6f9d..e4105d3 100644
--- a/src/ApiException/NetworkException.php
+++ b/src/ApiException/RequestQuotaException.php
@@ -3,11 +3,11 @@
 namespace CommonException\ApiException;
 
 /**
- * Class NetworkException
+ * Class RequestQuotaException
  *
  * @package CommonException\ApiException
  */
-class NetworkException extends Base\BaseException
+class RequestQuotaException extends Base\ApiException
 {
 
 }
diff --git a/src/IoException/Base/BaseException.php b/src/IoException/Base/IoException.php
similarity index 74%
rename from src/IoException/Base/BaseException.php
rename to src/IoException/Base/IoException.php
index e99bfff..8823dba 100644
--- a/src/IoException/Base/BaseException.php
+++ b/src/IoException/Base/IoException.php
@@ -9,7 +9,7 @@
  *
  * @package CommonException\IoException\Base
  */
-abstract class BaseException extends Base\BaseException
+class IoException extends Base\BaseException
 {
 
 }
diff --git a/src/IoException/FileCopyException.php b/src/IoException/FileCopyException.php
new file mode 100644
index 0000000..876e218
--- /dev/null
+++ b/src/IoException/FileCopyException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace CommonException\IoException;
+
+/**
+ * Class FileCopyException
+ *
+ * @package CommonException\IoException
+ */
+class FileCopyException extends Base\IoException
+{
+
+}
diff --git a/src/IoException/FileDeleteException.php b/src/IoException/FileDeleteException.php
new file mode 100644
index 0000000..c084aa4
--- /dev/null
+++ b/src/IoException/FileDeleteException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace CommonException\IoException;
+
+/**
+ * Class FileDeleteException
+ *
+ * @package CommonException\IoException
+ */
+class FileDeleteException extends Base\IoException
+{
+
+}
diff --git a/src/IoException/FileMoveException.php b/src/IoException/FileMoveException.php
new file mode 100644
index 0000000..18b7c73
--- /dev/null
+++ b/src/IoException/FileMoveException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace CommonException\IoException;
+
+/**
+ * Class FileMoveException
+ *
+ * @package CommonException\IoException
+ */
+class FileMoveException extends Base\IoException
+{
+
+}
diff --git a/src/IoException/FileReadException.php b/src/IoException/FileReadException.php
new file mode 100644
index 0000000..76df2d8
--- /dev/null
+++ b/src/IoException/FileReadException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace CommonException\IoException;
+
+/**
+ * Class FileReadException
+ *
+ * @package CommonException\IoException
+ */
+class FileReadException extends Base\IoException
+{
+
+}
diff --git a/src/IoException/FileWriteException.php b/src/IoException/FileWriteException.php
index 1bcf931..e761f0c 100644
--- a/src/IoException/FileWriteException.php
+++ b/src/IoException/FileWriteException.php
@@ -7,7 +7,7 @@
  *
  * @package CommonException\IoException
  */
-class FileWriteException extends Base\BaseException
+class FileWriteException extends Base\IoException
 {
 
 }
diff --git a/src/NetworkException/Base/NetworkException.php b/src/NetworkException/Base/NetworkException.php
new file mode 100644
index 0000000..7eb7ab2
--- /dev/null
+++ b/src/NetworkException/Base/NetworkException.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace CommonException\NetworkException\Base;
+
+use CommonException\Base;
+
+/**
+ * Class NetworkException
+ *
+ * @package CommonException\NetworkException\Base
+ */
+class NetworkException extends Base\BaseException
+{
+
+}
diff --git a/src/NetworkException/Base/TimeoutException.php b/src/NetworkException/Base/TimeoutException.php
new file mode 100644
index 0000000..bc472aa
--- /dev/null
+++ b/src/NetworkException/Base/TimeoutException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace CommonException\NetworkException\Base;
+
+/**
+ * Class TimeoutException
+ *
+ * @package CommonException\NetworkException\Base
+ */
+class TimeoutException extends NetworkException
+{
+
+}
diff --git a/src/NetworkException/ConnectionException.php b/src/NetworkException/ConnectionException.php
new file mode 100644
index 0000000..2b8a427
--- /dev/null
+++ b/src/NetworkException/ConnectionException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace CommonException\NetworkException;
+
+/**
+ * Class ConnectionException
+ *
+ * @package CommonException\NetworkException
+ */
+class ConnectionException extends Base\NetworkException
+{
+
+}
diff --git a/src/NetworkException/ConnectionTimeoutException.php b/src/NetworkException/ConnectionTimeoutException.php
new file mode 100644
index 0000000..367beda
--- /dev/null
+++ b/src/NetworkException/ConnectionTimeoutException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace CommonException\NetworkException;
+
+/**
+ * Class ConnectionTimeoutException
+ *
+ * @package CommonException\NetworkException
+ */
+class ConnectionTimeoutException extends Base\TimeoutException
+{
+
+}
diff --git a/src/NetworkException/CurlException.php b/src/NetworkException/CurlException.php
new file mode 100644
index 0000000..6d6519c
--- /dev/null
+++ b/src/NetworkException/CurlException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace CommonException\NetworkException;
+
+/**
+ * Class CurlException
+ *
+ * @package CommonException\NetworkException
+ */
+class CurlException extends Base\NetworkException
+{
+
+}
diff --git a/src/NetworkException/ReadTimeoutException.php b/src/NetworkException/ReadTimeoutException.php
new file mode 100644
index 0000000..8e783aa
--- /dev/null
+++ b/src/NetworkException/ReadTimeoutException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace CommonException\NetworkException;
+
+/**
+ * Class ReadTimeoutException
+ *
+ * @package CommonException\NetworkException
+ */
+class ReadTimeoutException extends Base\TimeoutException
+{
+
+}
diff --git a/src/NetworkException/WriteTimeoutException.php b/src/NetworkException/WriteTimeoutException.php
new file mode 100644
index 0000000..4274533
--- /dev/null
+++ b/src/NetworkException/WriteTimeoutException.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace CommonException\NetworkException;
+
+/**
+ * Class WriteTimeoutException
+ *
+ * @package CommonException\NetworkException
+ */
+class WriteTimeoutException extends Base\TimeoutException
+{
+
+}