framework/main/exceptions/file_directory/class_PathWriteProtectedException.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Filesystem;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Filesystem\PathWriteProtectedException;
   7 use Org\Mxchange\CoreFramework\Generic\FrameworkException;
   8
   9 // Import SPL stuff
  10 use \SplFileInfo;
  11
  12 /**
  13  * An exception thrown when a path cannot be written to.
  14  *
  15  * @author              Roland Haeder <webmaster@shipsimu.org>
  16  * @version             0.0.0
  17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.shipsimu.org
  20  *
  21  * This program is free software: you can redistribute it and/or modify
  22  * it under the terms of the GNU General Public License as published by
  23  * the Free Software Foundation, either version 3 of the License, or
  24  * (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  33  */
  34 class PathWriteProtectedException extends FrameworkException {
  35         /**
  36          * The constructor
  37          *
  38          * @param       $infoInstance   An instance of a SplFileInfo class
  39          * @param       $code   Code number for the exception
  40          * @return      void
  41          */
  42         public function __construct (SplFileInfo $infoInstance, $code) {
  43                 // Add a message around the missing class
  44                 $message = sprintf('Path "%s" cannot be written to. Please check permissions.', $infoInstance->getPath());
  45
  46                 // Call parent constructor
  47                 parent::__construct($message, $code);
  48         }
  49
  50 }