Organize exceptions (#8)

Author: onairmarc

src/Exceptions/ArgumentNullException.php

@@ -2,14 +2,13 @@
 
 namespace EncoreDigitalGroup\StdLib\Exceptions;
 
-use EncoreDigitalGroup\StdLib\Objects\ExitCode;
+use EncoreDigitalGroup\StdLib\Exceptions\NullExceptions\ArgumentNullException as BaseArgumentNullException;
 
-class ArgumentNullException extends BaseException
+/** @deprecated use EncoreDigitalGroup\StdLib\Exceptions\NullExceptions\ArgumentNullException instead */
+class ArgumentNullException extends BaseArgumentNullException
 {
     public function __construct(string $argumentName = 'Argument')
     {
-        $msg = "{$argumentName} is null on {$this->line}, in {$this->file}";
-
-        parent::__construct($msg, ExitCode::RESOURCE_UNAVAILABLE, $this->getPrevious());
+        parent::__construct($argumentName);
     }
 }

src/Exceptions/DirectoryNotFoundException.php

@@ -2,18 +2,13 @@
 
 namespace EncoreDigitalGroup\StdLib\Exceptions;
 
-use EncoreDigitalGroup\StdLib\Objects\ExitCode;
+use EncoreDigitalGroup\StdLib\Exceptions\FilesystemExceptions\DirectoryNotFoundException as BaseDirectoryNotFoundException;
 
-class DirectoryNotFoundException extends BaseException
+/** @deprecated use EncoreDigitalGroup\StdLib\Exceptions\FilesystemExceptions\DirectoryNotFoundException instead */
+class DirectoryNotFoundException extends BaseDirectoryNotFoundException
 {
     public function __construct(?string $path = null)
     {
-        if (is_null($path)) {
-            $msg = str_concat_space('Unable to locate directory on line', $this->line, 'in', $this->file);
-        } else {
-            $msg = str_concat_space('Unable to locate directory', $path, 'on line', $this->line, 'in', $this->file);
-        }
-
-        parent::__construct($msg, ExitCode::RESOURCE_UNAVAILABLE, $this->getPrevious());
+        parent::__construct($path);
     }
 }

src/Exceptions/EmptyExceptions/ArrayEmptyException.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace EncoreDigitalGroup\StdLib\Exceptions\EmptyExceptions;
+
+use EncoreDigitalGroup\StdLib\Exceptions\BaseException;
+use EncoreDigitalGroup\StdLib\Objects\ExitCode;
+
+class ArrayEmptyException extends BaseException
+{
+    public function __construct(string $arrayName = 'Array')
+    {
+        $msg = "{$arrayName} cannot be an empty array.";
+
+        parent::__construct($msg, ExitCode::GENERAL_ERROR, $this->getPrevious());
+    }
+}

src/Exceptions/FileNotFoundException.php

@@ -2,18 +2,13 @@
 
 namespace EncoreDigitalGroup\StdLib\Exceptions;
 
-use EncoreDigitalGroup\StdLib\Objects\ExitCode;
+use EncoreDigitalGroup\StdLib\Exceptions\FilesystemExceptions\FileNotFoundException as BaseFileNotFoundException;
 
-class FileNotFoundException extends BaseException
+/** @deprecated use EncoreDigitalGroup\StdLib\Exceptions\FilesystemExceptions\FileNotFoundException instead. */
+class FileNotFoundException extends BaseFileNotFoundException
 {
     public function __construct(?string $path = null)
     {
-        if (is_null($path)) {
-            $msg = str_concat_space('Unable to locate file on line', $this->line, 'in', $this->file);
-        } else {
-            $msg = str_concat_space('Unable to locate file', $path, 'on line', $this->line, 'in', $this->file);
-        }
-
-        parent::__construct($msg, ExitCode::RESOURCE_UNAVAILABLE, $this->getPrevious());
+        parent::__construct($path);
     }
 }

src/Exceptions/FilesystemExceptions/DirectoryNotFoundException.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace EncoreDigitalGroup\StdLib\Exceptions\FilesystemExceptions;
+
+use EncoreDigitalGroup\StdLib\Exceptions\BaseException;
+use EncoreDigitalGroup\StdLib\Objects\ExitCode;
+
+class DirectoryNotFoundException extends BaseException
+{
+    public function __construct(?string $path = null)
+    {
+        if (is_null($path)) {
+            $msg = str_concat_space('Unable to locate directory on line', $this->line, 'in', $this->file);
+        } else {
+            $msg = str_concat_space('Unable to locate directory', $path, 'on line', $this->line, 'in', $this->file);
+        }
+
+        parent::__construct($msg, ExitCode::RESOURCE_UNAVAILABLE, $this->getPrevious());
+    }
+}

src/Exceptions/FilesystemExceptions/FileNotFoundException.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace EncoreDigitalGroup\StdLib\Exceptions\FilesystemExceptions;
+
+use EncoreDigitalGroup\StdLib\Exceptions\BaseException;
+use EncoreDigitalGroup\StdLib\Objects\ExitCode;
+
+class FileNotFoundException extends BaseException
+{
+    public function __construct(?string $path = null)
+    {
+        if (is_null($path)) {
+            $msg = str_concat_space('Unable to locate file on line', $this->line, 'in', $this->file);
+        } else {
+            $msg = str_concat_space('Unable to locate file', $path, 'on line', $this->line, 'in', $this->file);
+        }
+
+        parent::__construct($msg, ExitCode::RESOURCE_UNAVAILABLE, $this->getPrevious());
+    }
+}

src/Exceptions/NullExceptions/ArgumentNullException.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace EncoreDigitalGroup\StdLib\Exceptions\NullExceptions;
+
+use EncoreDigitalGroup\StdLib\Exceptions\BaseException;
+use EncoreDigitalGroup\StdLib\Objects\ExitCode;
+
+class ArgumentNullException extends BaseException
+{
+    public function __construct(string $argumentName = 'Argument')
+    {
+        $msg = "{$argumentName} is null on {$this->line}, in {$this->file}";
+
+        parent::__construct($msg, ExitCode::RESOURCE_UNAVAILABLE, $this->getPrevious());
+    }
+}

src/Exceptions/NullExceptions/ClassPropertyNullException.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace EncoreDigitalGroup\StdLib\Exceptions\NullExceptions;
+
+use EncoreDigitalGroup\StdLib\Exceptions\BaseException;
+use EncoreDigitalGroup\StdLib\Objects\ExitCode;
+
+class ClassPropertyNullException extends BaseException
+{
+    public function __construct(string $propertyName = 'Property')
+    {
+        $msg = "{$propertyName} cannot be null.";
+
+        parent::__construct($msg, ExitCode::GENERAL_ERROR, $this->getPrevious());
+    }
+}

src/Exceptions/NullExceptions/NullException.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace EncoreDigitalGroup\StdLib\Exceptions\NullExceptions;
+
+use EncoreDigitalGroup\StdLib\Exceptions\BaseException;
+use EncoreDigitalGroup\StdLib\Objects\ExitCode;
+
+class NullException extends BaseException
+{
+    public function __construct(string $arg)
+    {
+        $msg = "{$arg} cannot be null.";
+
+        parent::__construct($msg, ExitCode::DATA_ERROR, $this->getPrevious());
+    }
+}

src/Exceptions/NullExceptions/VariableNullException.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace EncoreDigitalGroup\StdLib\Exceptions\NullExceptions;
+
+use EncoreDigitalGroup\StdLib\Exceptions\BaseException;
+use EncoreDigitalGroup\StdLib\Objects\ExitCode;
+
+class VariableNullException extends BaseException
+{
+    public function __construct(string $variableName = 'Variable')
+    {
+        $msg = "{$variableName} cannot be null.";
+
+        parent::__construct($msg, ExitCode::GENERAL_ERROR, $this->getPrevious());
+    }
+}