annotate core/lib/Drupal/Component/Plugin/Exception/InvalidPluginDefinitionException.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Component\Plugin\Exception;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Defines a class for invalid plugin definition exceptions.
Chris@0 7 */
Chris@0 8 class InvalidPluginDefinitionException extends PluginException {
Chris@0 9
Chris@0 10 /**
Chris@0 11 * The plugin ID of the mapper.
Chris@0 12 *
Chris@0 13 * @var string
Chris@0 14 */
Chris@0 15 protected $pluginId;
Chris@0 16
Chris@0 17 /**
Chris@0 18 * Constructs a InvalidPluginDefinitionException.
Chris@0 19 *
Chris@0 20 * For the remaining parameters see \Exception.
Chris@0 21 *
Chris@0 22 * @param string $plugin_id
Chris@0 23 * The plugin ID of the mapper.
Chris@0 24 *
Chris@0 25 * @see \Exception
Chris@0 26 */
Chris@0 27 public function __construct($plugin_id, $message = '', $code = 0, \Exception $previous = NULL) {
Chris@0 28 $this->pluginId = $plugin_id;
Chris@0 29 parent::__construct($message, $code, $previous);
Chris@0 30 }
Chris@0 31
Chris@0 32 /**
Chris@0 33 * Gets the plugin ID of the mapper that raised the exception.
Chris@0 34 *
Chris@0 35 * @return string
Chris@0 36 * The plugin ID.
Chris@0 37 */
Chris@0 38 public function getPluginId() {
Chris@0 39 return $this->pluginId;
Chris@0 40 }
Chris@0 41
Chris@0 42 }