Consolidated exceptions with horstoeko/orderx

horstoeko · Oct 13, 2024 · ef86636 · ef86636
1 parent 9229906
commit ef86636
Show file tree

Hide file tree

Showing 12 changed files with 99 additions and 220 deletions.
diff --git a/src/exception/ZugferdBaseException.php b/src/exception/ZugferdBaseException.php
@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * This file is a part of horstoeko/zugferd.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+ namespace horstoeko\zugferd\exception;
+
+/**
+ * Class representing an exception for missing a file
+ *
+ * @category Zugferd
+ * @package  Zugferd
+ * @author   D. Erling <[email protected]>
+ * @license  https://opensource.org/licenses/MIT MIT
+ * @link     https://github.com/horstoeko/zugferd
+ */
+class ZugferdBaseException extends \Exception
+{
+}
diff --git a/src/exception/ZugferdExceptionCodes.php b/src/exception/ZugferdExceptionCodes.php
@@ -0,0 +1,32 @@
+<?php
+
+/**
+ * This file is a part of horstoeko/zugferd.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace horstoeko\zugferd\exception;
+
+/**
+ * Class representing the internal coes for Order-X-Exceptions
+ *
+ * @category Zugferd
+ * @package  Zugferd
+ * @author   D. Erling <[email protected]>
+ * @license  https://opensource.org/licenses/MIT MIT
+ * @link     https://github.com/horstoeko/zugferd
+ */
+class ZugferdExceptionCodes
+{
+    public const CANNOTFINDPROFILESTRING = -1101;
+    public const UNKNOWNPROFILE = -1102;
+    public const MIMETYPENOTSUPPORTED = -1103;
+    public const UNKNOWNDATEFORMAT = -1104;
+    public const NOVALIDATTACHMENTFOUNDINPDF = -1105;
+    public const UNKNOWNPROFILEPARAMETER = -1106;
+    public const UNKNOWNSYNTAX = -1107;
+    public const FILENOTFOUND = -2000;
+    public const FILENOTREADABLE = -2001;
+}
diff --git a/src/exception/ZugferdFileNotFoundException.php b/src/exception/ZugferdFileNotFoundException.php
@@ -9,7 +9,7 @@
 
 namespace horstoeko\zugferd\exception;
 
-use Exception;
+use Throwable;
 
 /**
  * Class representing an exception for missing a file
@@ -20,42 +20,16 @@
  * @license  https://opensource.org/licenses/MIT MIT
  * @link     https://github.com/horstoeko/zugferd
  */
-class ZugferdFileNotFoundException extends Exception
+class ZugferdFileNotFoundException extends ZugferdBaseException
 {
-    /**
-     * The context of the type element
-     *
-     * @var string
-     */
-    private $filePath = "";
-
     /**
      * Constructor
      *
-     * @param string $filePath
-     */
-    public function __construct(string $filePath)
-    {
-        $this->filePath = $filePath;
-
-        parent::__construct($this->buildMessage());
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function __toString()
-    {
-        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
-    }
-
-    /**
-     * Build the message
-     *
-     * @return string
+     * @param string         $filename
+     * @param Throwable|null $previous
      */
-    private function buildMessage(): string
+    public function __construct(string $filename, ?Throwable $previous = null)
     {
-        return sprintf("The filer %s is missing", $this->filePath);
+        parent::__construct(sprintf("The file %s was not found", $filename), ZugferdExceptionCodes::FILENOTFOUND, $previous);
     }
 }
diff --git a/src/exception/ZugferdFileNotReadableException.php b/src/exception/ZugferdFileNotReadableException.php
@@ -9,7 +9,7 @@
 
 namespace horstoeko\zugferd\exception;
 
-use Exception;
+use Throwable;
 
 /**
  * Class representing an exception for non-readable a file
@@ -20,42 +20,16 @@
  * @license  https://opensource.org/licenses/MIT MIT
  * @link     https://github.com/horstoeko/zugferd
  */
-class ZugferdFileNotReadableException extends Exception
+class ZugferdFileNotReadableException extends ZugferdBaseException
 {
-    /**
-     * The context of the type element
-     *
-     * @var string
-     */
-    private $filePath = "";
-
     /**
      * Constructor
      *
-     * @param string $filePath
-     */
-    public function __construct(string $filePath)
-    {
-        $this->filePath = $filePath;
-
-        parent::__construct($this->buildMessage());
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function __toString()
-    {
-        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
-    }
-
-    /**
-     * Build the message
-     *
-     * @return string
+     * @param string         $filename
+     * @param Throwable|null $previous
      */
-    private function buildMessage(): string
+    public function __construct(string $filename, ?Throwable $previous = null)
     {
-        return sprintf("The filer %s is not readable", $this->filePath);
+        parent::__construct(sprintf("The file %s is not readable", $filename), ZugferdExceptionCodes::FILENOTFOUND, $previous);
     }
 }
diff --git a/src/exception/ZugferdUnknownDateFormatException.php b/src/exception/ZugferdUnknownDateFormatException.php
@@ -9,6 +9,8 @@
 
 namespace horstoeko\zugferd\exception;
 
+use Throwable;
+
 /**
  * Class representing an exception for unknown date formates
  *
@@ -18,42 +20,10 @@
  * @license  https://opensource.org/licenses/MIT MIT
  * @link     https://github.com/horstoeko/zugferd
  */
-class ZugferdUnknownDateFormatException extends \Exception
+class ZugferdUnknownDateFormatException extends ZugferdBaseException
 {
-    /**
-     * The context of the type element
-     *
-     * @var string
-     */
-    private $dateFormat = "";
-
-    /**
-     * Constructor
-     *
-     * @param string $dateFormat
-     */
-    public function __construct(string $dateFormat)
-    {
-        $this->dateFormat = $dateFormat;
-
-        parent::__construct($this->buildMessage());
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function __toString()
-    {
-        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
-    }
-
-    /**
-     * Build the message
-     *
-     * @return string
-     */
-    private function buildMessage(): string
+    public function __construct(string $dateFormatCode, ?Throwable $previous = null)
     {
-        return sprintf("The date format identifier %s is unknown or not supported", $this->dateFormat);
+        parent::__construct(sprintf("Invalid date format %s", $dateFormatCode), ZugferdExceptionCodes::UNKNOWNDATEFORMAT, $previous);
     }
 }
diff --git a/src/exception/ZugferdUnknownProfileException.php b/src/exception/ZugferdUnknownProfileException.php
@@ -9,7 +9,7 @@
 
 namespace horstoeko\zugferd\exception;
 
-use Exception;
+use Throwable;
 
 /**
  * Class representing an exception for unknown profile
@@ -20,42 +20,16 @@
  * @license  https://opensource.org/licenses/MIT MIT
  * @link     https://github.com/horstoeko/zugferd
  */
-class ZugferdUnknownProfileException extends Exception
+class ZugferdUnknownProfileException extends ZugferdBaseException
 {
-    /**
-     * The context of the type element
-     *
-     * @var string
-     */
-    private $contextElement = "";
-
     /**
      * Constructor
      *
-     * @param string $contextElement
-     */
-    public function __construct(string $contextElement)
-    {
-        $this->contextElement = $contextElement;
-
-        parent::__construct($this->buildMessage());
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function __toString()
-    {
-        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
-    }
-
-    /**
-     * Build the message
-     *
-     * @return string
+     * @param string         $profileString
+     * @param Throwable|null $previous
      */
-    private function buildMessage(): string
+    public function __construct(string $profileString, ?Throwable $previous = null)
     {
-        return sprintf("A context parameter was found, but the content of \"%s\" is not a valid profile", $this->contextElement);
+        parent::__construct(sprintf("Cannot determain the profile by %s", $profileString), ZugferdExceptionCodes::UNKNOWNPROFILE, $previous);
     }
 }
diff --git a/src/exception/ZugferdUnknownProfileIdException.php b/src/exception/ZugferdUnknownProfileIdException.php
@@ -9,7 +9,7 @@
 
 namespace horstoeko\zugferd\exception;
 
-use Exception;
+use Throwable;
 
 /**
  * Class representing an exception for unknown profile id
@@ -20,42 +20,16 @@
  * @license  https://opensource.org/licenses/MIT MIT
  * @link     https://github.com/horstoeko/zugferd
  */
-class ZugferdUnknownProfileIdException extends Exception
+class ZugferdUnknownProfileIdException extends ZugferdBaseException
 {
-    /**
-     * The context of the type element
-     *
-     * @var integer
-     */
-    private $profileId = 0;
-
     /**
      * Constructor
      *
-     * @param integer $profileId
-     */
-    public function __construct(int $profileId)
-    {
-        $this->profileId = $profileId;
-
-        parent::__construct($this->buildMessage());
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function __toString()
-    {
-        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
-    }
-
-    /**
-     * Build the message
-     *
-     * @return string
+     * @param int            $profileId
+     * @param Throwable|null $previous
      */
-    private function buildMessage(): string
+    public function __construct(int $profileId, ?Throwable $previous = null)
     {
-        return sprintf("The profile id %s is uknown", $this->profileId);
+        parent::__construct(sprintf("The profile id %s is uknown", $profileId), ZugferdExceptionCodes::UNKNOWNPROFILE, $previous);
     }
 }
diff --git a/src/exception/ZugferdUnknownProfileParameterException.php b/src/exception/ZugferdUnknownProfileParameterException.php
@@ -9,7 +9,7 @@
 
 namespace horstoeko\zugferd\exception;
 
-use Exception;
+use Throwable;
 
 /**
  * Class representing an exception for unknown profile parameter
@@ -20,42 +20,16 @@
  * @license  https://opensource.org/licenses/MIT MIT
  * @link     https://github.com/horstoeko/zugferd
  */
-class ZugferdUnknownProfileParameterException extends Exception
+class ZugferdUnknownProfileParameterException extends ZugferdBaseException
 {
-    /**
-     * The context of the type element
-     *
-     * @var string
-     */
-    private $profileParameter = "";
-
     /**
      * Constructor
      *
-     * @param string $profileParameter
-     */
-    public function __construct(string $profileParameter)
-    {
-        $this->profileParameter = $profileParameter;
-
-        parent::__construct($this->buildMessage());
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function __toString()
-    {
-        return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
-    }
-
-    /**
-     * Build the message
-     *
-     * @return string
+     * @param string         $profileParameter
+     * @param Throwable|null $previous
      */
-    private function buildMessage(): string
+    public function __construct(string $profileParameter, ?Throwable $previous = null)
     {
-        return sprintf("The profile parameter %s is uknown", $this->profileParameter);
+        parent::__construct(sprintf("The profile parameter %s is uknown", $profileParameter), ZugferdExceptionCodes::UNKNOWNPROFILEPARAMETER, $previous);
     }
 }