class ErrorTestController

Same name in other branches
  1. 9 core/modules/system/tests/modules/error_test/src/Controller/ErrorTestController.php \Drupal\error_test\Controller\ErrorTestController
  2. 8.9.x core/modules/system/tests/modules/error_test/src/Controller/ErrorTestController.php \Drupal\error_test\Controller\ErrorTestController
  3. 10 core/modules/system/tests/modules/error_test/src/Controller/ErrorTestController.php \Drupal\error_test\Controller\ErrorTestController

Controller routines for error_test routes.

Hierarchy

Expanded class hierarchy of ErrorTestController

1 file declares its use of ErrorTestController
DbLogTest.php in core/modules/dblog/tests/src/Functional/DbLogTest.php

File

core/modules/system/tests/modules/error_test/src/Controller/ErrorTestController.php, line 14

Namespace

Drupal\error_test\Controller
View source
class ErrorTestController extends ControllerBase {
    
    /**
     * The database connection.
     *
     * @var \Drupal\Core\Database\Connection
     */
    protected $database;
    
    /**
     * Constructs a \Drupal\error_test\Controller\ErrorTestController object.
     *
     * @param \Drupal\Core\Database\Connection $database
     *   The database connection.
     */
    public function __construct(Connection $database) {
        $this->database = $database;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('database'));
    }
    
    /**
     * Generate warnings to test the error handler.
     */
    public function generateWarnings($collect_errors = FALSE) {
        // Tell Drupal error reporter to collect test errors or not.
        define('SIMPLETEST_COLLECT_ERRORS', $collect_errors);
        // This will generate a notice.
        $notice = new \stdClass();
        $notice == 1 ? 1 : 0;
        // This will generate a warning.
        $obj = new \stdClass();
        $obj->p =& $obj;
        var_export($obj, TRUE);
        // This will generate a user error. Use & to check for double escaping.
        trigger_error("Drupal & awesome", E_USER_WARNING);
        return [];
    }
    
    /**
     * Generate fatal errors to test the error handler.
     */
    public function generateFatalErrors() {
        $function = function (array $test) {
        };
        // Use an incorrect parameter type, string, for testing a fatal error.
        $function("test-string");
        return [];
    }
    
    /**
     * Trigger an exception to test the exception handler.
     *
     * @param string $argument
     *   A function argument which will be included in the exception backtrace.
     *
     * @throws \Exception
     */
    public function triggerException(string $argument = "<script>alert('xss')</script>") : void {
        define('SIMPLETEST_COLLECT_ERRORS', FALSE);
        // Add function arguments to the exception backtrace.
        ini_set('zend.exception_ignore_args', FALSE);
        ini_set('zend.exception_string_param_max_len', 1024);
        throw new \Exception("Drupal & awesome");
    }
    
    /**
     * Trigger an exception to test the PDO exception handler.
     */
    public function triggerPDOException() {
        define('SIMPLETEST_COLLECT_ERRORS', FALSE);
        $this->database
            ->select('bananas_are_awesome', 'b')
            ->fields('b')
            ->execute();
    }
    
    /**
     * Trigger an exception during rendering.
     */
    public function triggerRendererException() {
        return [
            '#type' => 'page',
            '#post_render' => [
                function () {
                    throw new \Exception('This is an exception that occurs during rendering');
                },
            ],
        ];
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 2
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 1
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 1
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 2
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 1
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 1
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage service.
ErrorTestController::$database protected property The database connection.
ErrorTestController::create public static function Instantiates a new instance of the implementing class using autowiring. Overrides AutowireTrait::create
ErrorTestController::generateFatalErrors public function Generate fatal errors to test the error handler.
ErrorTestController::generateWarnings public function Generate warnings to test the error handler.
ErrorTestController::triggerException public function Trigger an exception to test the exception handler.
ErrorTestController::triggerPDOException public function Trigger an exception to test the PDO exception handler.
ErrorTestController::triggerRendererException public function Trigger an exception during rendering.
ErrorTestController::__construct public function Constructs a \Drupal\error_test\Controller\ErrorTestController object.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.