[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Part of the Joomla Framework Archive Package
   4   *
   5   * @copyright  Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
   6   * @license    GNU General Public License version 2 or later; see LICENSE
   7   */
   8  
   9  namespace Joomla\Archive\Exception;
  10  
  11  /**
  12   * Exception class defining an unsupported archive adapter
  13   *
  14   * @since  2.0.0
  15   */
  16  class UnsupportedArchiveException extends \InvalidArgumentException
  17  {
  18      /**
  19       * The unsupported archive adapter name
  20       *
  21       * @var    string
  22       * @since  2.0.0-beta2
  23       */
  24      protected $adapterType = '';
  25  
  26      /**
  27       * Constructor
  28       *
  29       * @param   string       $adapterType  The unsupported adapter type.
  30       * @param   string       $message      The Exception message to throw.
  31       * @param   int          $code         The Exception code.
  32       * @param   ?\Throwable  $previous     The previous throwable used for the exception chaining.
  33       *
  34       * @since  2.0.0-beta2
  35       */
  36  	public function __construct(string $adapterType, string $message = '', int $code = 0, ?\Throwable $previous = null)
  37      {
  38          $this->adapterType = $adapterType;
  39  
  40          parent::__construct($message, $code, $previous);
  41      }
  42  
  43      /**
  44       * Gets the name of the adapter type that was unsupported
  45       *
  46       * @return  string
  47       *
  48       * @since  2.0.0-beta2
  49       */
  50  	public function getUnsupportedAdapterType(): string
  51      {
  52          return $this->adapterType;
  53      }
  54  }