class InstallerException

Same name in other branches
  1. 9 core/lib/Drupal/Core/Installer/Exception/InstallerException.php \Drupal\Core\Installer\Exception\InstallerException
  2. 8.9.x core/lib/Drupal/Core/Installer/Exception/InstallerException.php \Drupal\Core\Installer\Exception\InstallerException
  3. 10 core/lib/Drupal/Core/Installer/Exception/InstallerException.php \Drupal\Core\Installer\Exception\InstallerException

Base class for exceptions thrown by installer.

Hierarchy

Expanded class hierarchy of InstallerException

1 file declares its use of InstallerException
install.core.inc in core/includes/install.core.inc
API functions for installing Drupal.

File

core/lib/Drupal/Core/Installer/Exception/InstallerException.php, line 10

Namespace

Drupal\Core\Installer\Exception
View source 
class InstallerException extends \RuntimeException {
    use StringTranslationTrait;
    
    /**
     * The page title to output.
     *
     * @var string
     */
    protected $title;
    
    /**
     * Constructs a new installer exception.
     *
     * @param string $message
     *   The exception message.
     * @param string $title
     *   (optional) The page title. Defaults to 'Error'.
     * @param int $code
     *   (optional) The exception code. Defaults to 0.
     * @param \Exception $previous
     *   (optional) A previous exception.
     */
    public function __construct($message, $title = 'Error', $code = 0, ?\Exception $previous = NULL) {
        parent::__construct($message, $code, $previous);
        $this->title = $title;
    }
    
    /**
     * Returns the exception page title.
     *
     * @return string
     */
    public function getTitle() {
        return $this->title;
    }

}

Members

Title Modifiers Object type Summary Overrides
InstallerException::$title protected property The page title to output.
InstallerException::getTitle public function Returns the exception page title.
InstallerException::__construct public function Constructs a new installer exception. 2
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.