PHPOffice#634 : Set specific exceptions

src/PhpPresentation/AbstractShape.php

@@ -20,6 +20,7 @@
 
 namespace PhpOffice\PhpPresentation;
 
+use PhpOffice\PhpPresentation\Exception\ShapeContainerAlreadyAssignedException;
 use PhpOffice\PhpPresentation\Shape\Hyperlink;
 use PhpOffice\PhpPresentation\Shape\Placeholder;
 use PhpOffice\PhpPresentation\Style\Border;
@@ -146,7 +147,7 @@ public function getContainer(): ?ShapeContainerInterface
      * @param ShapeContainerInterface $pValue
      * @param bool $pOverrideOld If a Slide has already been assigned, overwrite it and remove image from old Slide?
      *
-     * @throws \Exception
+     * @throws ShapeContainerAlreadyAssignedException
      *
      * @return $this
      */
@@ -175,7 +176,7 @@ public function setContainer(ShapeContainerInterface $pValue = null, $pOverrideO
                 // Set new \PhpOffice\PhpPresentation\Slide
                 $this->setContainer($pValue);
             } else {
-                throw new \Exception(sprintf('A %s has already been assigned. Shapes can only exist on one %s.', ShapeContainerInterface::class, ShapeContainerInterface::class));
+                throw new ShapeContainerAlreadyAssignedException(self::class);
             }
         }
 
@@ -328,8 +329,6 @@ public function getShadow(): ?Shadow
     }
 
     /**
-     * @throws \Exception
-     *
      * @return $this
      */
     public function setShadow(Shadow $pValue = null)
@@ -350,9 +349,7 @@ public function hasHyperlink()
     }
 
     /**
-     * Get Hyperlink.
-     *
-     * @throws \Exception
+     * Get Hyperlink
      */
     public function getHyperlink(): Hyperlink
     {
@@ -364,9 +361,7 @@ public function getHyperlink(): Hyperlink
     }
 
     /**
-     * Set Hyperlink.
-     *
-     * @throws \Exception
+     * Set Hyperlink
      */
     public function setHyperlink(Hyperlink $pHyperlink = null): self
     {

src/PhpPresentation/Exception/DirectoryNotFoundException.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * This file is part of PHPPresentation - A pure PHP library for reading and writing
+ * presentations documents.
+ *
+ * PHPPresentation is free software distributed under the terms of the GNU Lesser
+ * General Public License version 3 as published by the Free Software Foundation.
+ *
+ * For the full copyright and license information, please read the LICENSE
+ * file that was distributed with this source code. For the full list of
+ * contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
+ *
+ * @see        https://github.com/PHPOffice/PHPPresentation
+ *
+ * @copyright   2009-2015 PHPPresentation contributors
+ * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
+ */
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpPresentation\Exception;
+
+class DirectoryNotFoundException extends PhpPresentationException
+{
+    public function __construct(string $path)
+    {
+        parent::__construct(sprintf(
+            'The directory %s doesn\'t exist',
+            $path
+        ));
+    }
+}

src/PhpPresentation/Exception/FeatureNotImplementedException.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * This file is part of PHPPresentation - A pure PHP library for reading and writing
+ * presentations documents.
+ *
+ * PHPPresentation is free software distributed under the terms of the GNU Lesser
+ * General Public License version 3 as published by the Free Software Foundation.
+ *
+ * For the full copyright and license information, please read the LICENSE
+ * file that was distributed with this source code. For the full list of
+ * contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
+ *
+ * @see        https://github.com/PHPOffice/PHPPresentation
+ *
+ * @copyright   2009-2015 PHPPresentation contributors
+ * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
+ */
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpPresentation\Exception;
+
+class FeatureNotImplementedException extends PhpPresentationException
+{
+    public function __construct()
+    {
+        parent::__construct('The feature is not implemented. Please create an issue.');
+    }
+}

src/PhpPresentation/Exception/FileCopyException.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * This file is part of PHPPresentation - A pure PHP library for reading and writing
+ * presentations documents.
+ *
+ * PHPPresentation is free software distributed under the terms of the GNU Lesser
+ * General Public License version 3 as published by the Free Software Foundation.
+ *
+ * For the full copyright and license information, please read the LICENSE
+ * file that was distributed with this source code. For the full list of
+ * contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
+ *
+ * @see        https://github.com/PHPOffice/PHPPresentation
+ *
+ * @copyright   2009-2015 PHPPresentation contributors
+ * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
+ */
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpPresentation\Exception;
+
+class FileCopyException extends PhpPresentationException
+{
+    public function __construct(string $source, string $destination)
+    {
+        parent::__construct(sprintf(
+            'The file %s can\'t be copied to %s',
+            $source,
+            $destination
+        ));
+    }
+}

src/PhpPresentation/Exception/FileNotFoundException.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * This file is part of PHPPresentation - A pure PHP library for reading and writing
+ * presentations documents.
+ *
+ * PHPPresentation is free software distributed under the terms of the GNU Lesser
+ * General Public License version 3 as published by the Free Software Foundation.
+ *
+ * For the full copyright and license information, please read the LICENSE
+ * file that was distributed with this source code. For the full list of
+ * contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
+ *
+ * @see        https://github.com/PHPOffice/PHPPresentation
+ *
+ * @copyright   2009-2015 PHPPresentation contributors
+ * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
+ */
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpPresentation\Exception;
+
+class FileNotFoundException extends PhpPresentationException
+{
+    public function __construct(string $path)
+    {
+        parent::__construct(sprintf(
+            'The file "%s" doesn\'t exist',
+            $path
+        ));
+    }
+}

src/PhpPresentation/Exception/FileRemoveException.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * This file is part of PHPPresentation - A pure PHP library for reading and writing
+ * presentations documents.
+ *
+ * PHPPresentation is free software distributed under the terms of the GNU Lesser
+ * General Public License version 3 as published by the Free Software Foundation.
+ *
+ * For the full copyright and license information, please read the LICENSE
+ * file that was distributed with this source code. For the full list of
+ * contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
+ *
+ * @see        https://github.com/PHPOffice/PHPPresentation
+ *
+ * @copyright   2009-2015 PHPPresentation contributors
+ * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
+ */
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpPresentation\Exception;
+
+class FileRemoveException extends PhpPresentationException
+{
+    public function __construct(string $path)
+    {
+        parent::__construct(sprintf(
+            'The file %s can\'t be removed',
+            $path
+        ));
+    }
+}

src/PhpPresentation/Exception/InvalidClassException.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * This file is part of PHPPresentation - A pure PHP library for reading and writing
+ * presentations documents.
+ *
+ * PHPPresentation is free software distributed under the terms of the GNU Lesser
+ * General Public License version 3 as published by the Free Software Foundation.
+ *
+ * For the full copyright and license information, please read the LICENSE
+ * file that was distributed with this source code. For the full list of
+ * contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
+ *
+ * @see        https://github.com/PHPOffice/PHPPresentation
+ *
+ * @copyright   2009-2015 PHPPresentation contributors
+ * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
+ */
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpPresentation\Exception;
+
+class InvalidClassException extends PhpPresentationException
+{
+    public function __construct(string $class, string $error)
+    {
+        parent::__construct(sprintf(
+            'The class %s is invalid (%s)',
+            $class,
+            $error
+        ));
+    }
+}

src/PhpPresentation/Exception/InvalidFileFormatException.php

@@ -0,0 +1,42 @@
+<?php
+/**
+ * This file is part of PHPPresentation - A pure PHP library for reading and writing
+ * presentations documents.
+ *
+ * PHPPresentation is free software distributed under the terms of the GNU Lesser
+ * General Public License version 3 as published by the Free Software Foundation.
+ *
+ * For the full copyright and license information, please read the LICENSE
+ * file that was distributed with this source code. For the full list of
+ * contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
+ *
+ * @see        https://github.com/PHPOffice/PHPPresentation
+ *
+ * @copyright   2009-2015 PHPPresentation contributors
+ * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
+ */
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpPresentation\Exception;
+
+class InvalidFileFormatException extends PhpPresentationException
+{
+    public function __construct(string $path, string $class, string $error = '')
+    {
+        if ($class) {
+            $class = 'class ' . $class;
+        }
+        if ($error) {
+            $error = '(' . $error . ')';
+        }
+
+        parent::__construct(sprintf(
+            'The file %s is not in the format supported by %s%s%s',
+            $path,
+            $class,
+            !empty($error) ? ' ' : '',
+            $error
+        ));
+    }
+}

src/PhpPresentation/Exception/InvalidParameterException.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * This file is part of PHPPresentation - A pure PHP library for reading and writing
+ * presentations documents.
+ *
+ * PHPPresentation is free software distributed under the terms of the GNU Lesser
+ * General Public License version 3 as published by the Free Software Foundation.
+ *
+ * For the full copyright and license information, please read the LICENSE
+ * file that was distributed with this source code. For the full list of
+ * contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
+ *
+ * @see        https://github.com/PHPOffice/PHPPresentation
+ *
+ * @copyright   2009-2015 PHPPresentation contributors
+ * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
+ */
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpPresentation\Exception;
+
+class InvalidParameterException extends PhpPresentationException
+{
+    public function __construct(string $parameter, string $value)
+    {
+        parent::__construct(sprintf(
+            'The parameter %s can\'t have the value "%s"',
+            $parameter,
+            $value
+        ));
+    }
+}

src/PhpPresentation/Exception/OutOfBoundsException.php

@@ -0,0 +1,34 @@
+<?php
+/**
+ * This file is part of PHPPresentation - A pure PHP library for reading and writing
+ * presentations documents.
+ *
+ * PHPPresentation is free software distributed under the terms of the GNU Lesser
+ * General Public License version 3 as published by the Free Software Foundation.
+ *
+ * For the full copyright and license information, please read the LICENSE
+ * file that was distributed with this source code. For the full list of
+ * contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
+ *
+ * @see        https://github.com/PHPOffice/PHPPresentation
+ *
+ * @copyright   2009-2015 PHPPresentation contributors
+ * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
+ */
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpPresentation\Exception;
+
+class OutOfBoundsException extends PhpPresentationException
+{
+    public function __construct(int $minBounds, ?int $maxBounds, int $expectedBounds)
+    {
+        parent::__construct(sprintf(
+            'The expected value (%d) is out of bounds (%d, %s)',
+            $expectedBounds,
+            $minBounds,
+            $maxBounds ?? 'Infinite'
+        ));
+    }
+}

src/PhpPresentation/Exception/PhpPresentationException.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * This file is part of PHPPresentation - A pure PHP library for reading and writing
+ * presentations documents.
+ *
+ * PHPPresentation is free software distributed under the terms of the GNU Lesser
+ * General Public License version 3 as published by the Free Software Foundation.
+ *
+ * For the full copyright and license information, please read the LICENSE
+ * file that was distributed with this source code. For the full list of
+ * contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
+ *
+ * @see        https://github.com/PHPOffice/PHPPresentation
+ *
+ * @copyright   2009-2015 PHPPresentation contributors
+ * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
+ */
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpPresentation\Exception;
+
+use Exception;
+
+class PhpPresentationException extends Exception
+{
+}