InvalidPluginDefinitionException.php

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

Namespace

Drupal\Component\Plugin\Exception

File

core/lib/Drupal/Component/Plugin/Exception/InvalidPluginDefinitionException.php

View source
<?php

namespace Drupal\Component\Plugin\Exception;


/**
 * Defines a class for invalid plugin definition exceptions.
 */
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;
    }

}

Classes

Title Deprecated Summary
InvalidPluginDefinitionException Defines a class for invalid plugin definition exceptions.

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