class InvalidPluginDefinitionException

Same name in other branches
  1. 9 core/lib/Drupal/Component/Plugin/Exception/InvalidPluginDefinitionException.php \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
  2. 8.9.x core/lib/Drupal/Component/Plugin/Exception/InvalidPluginDefinitionException.php \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
  3. 10 core/lib/Drupal/Component/Plugin/Exception/InvalidPluginDefinitionException.php \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException

Defines a class for invalid plugin definition exceptions.

Hierarchy

Expanded class hierarchy of InvalidPluginDefinitionException

23 files declare their use of InvalidPluginDefinitionException
ActionMethod.php in core/lib/Drupal/Core/Config/Action/Attribute/ActionMethod.php
ActionMethodAttributeTest.php in core/tests/Drupal/Tests/Core/Config/Action/ActionMethodAttributeTest.php
BadPluginDefinitionException.php in core/modules/migrate/src/Plugin/Exception/BadPluginDefinitionException.php
CKEditor5Plugin.php in core/modules/ckeditor5/src/Attribute/CKEditor5Plugin.php
CKEditor5PluginDefinition.php in core/modules/ckeditor5/src/Plugin/CKEditor5PluginDefinition.php

... See full list

File

core/lib/Drupal/Component/Plugin/Exception/InvalidPluginDefinitionException.php, line 8

Namespace

Drupal\Component\Plugin\Exception
View source
class InvalidPluginDefinitionException extends PluginException {
    
    /**
     * The plugin ID of the mapper.
     *
     * @var string
     */
    protected $pluginId;
    
    /**
     * Constructs an InvalidPluginDefinitionException.
     *
     * @param string $plugin_id
     *   The plugin ID of the mapper.
     * @param string $message
     *   The exception message.
     * @param int $code
     *   The exception code.
     * @param \Exception|null $previous
     *   The previous throwable used for exception chaining.
     *
     * @see \Exception
     */
    public function __construct($plugin_id, $message = '', $code = 0, ?\Exception $previous = NULL) {
        $this->pluginId = $plugin_id;
        parent::__construct($message, $code, $previous);
    }
    
    /**
     * Gets the plugin ID of the mapper that raised the exception.
     *
     * @return string
     *   The plugin ID.
     */
    public function getPluginId() {
        return $this->pluginId;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overrides
InvalidPluginDefinitionException::$pluginId protected property The plugin ID of the mapper.
InvalidPluginDefinitionException::getPluginId public function Gets the plugin ID of the mapper that raised the exception.
InvalidPluginDefinitionException::__construct public function Constructs an InvalidPluginDefinitionException. 1

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