InstallerException.php

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

Namespace

Drupal\Core\Installer\Exception

File

core/lib/Drupal/Core/Installer/Exception/InstallerException.php

View source
<?php

namespace Drupal\Core\Installer\Exception;

use Drupal\Core\StringTranslation\StringTranslationTrait;

/**
 * Base class for exceptions thrown by installer.
 */
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 \Throwable $previous
   *   (optional) A previous exception.
   */
  public function __construct($message, $title = 'Error', $code = 0, ?\Throwable $previous = NULL) {
    parent::__construct($message, $code, $previous);
    $this->title = $title;
  }
  
  /**
   * Returns the exception page title.
   *
   * @return string
   *   The page title.
   */
  public function getTitle() {
    return $this->title;
  }

}

Classes

Title Deprecated Summary
InstallerException Base class for exceptions thrown by installer.

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