BadPluginDefinitionException.php

Same filename and directory in other branches
  1. 9 core/modules/migrate/src/Plugin/Exception/BadPluginDefinitionException.php
  2. 8.9.x core/modules/migrate/src/Plugin/Exception/BadPluginDefinitionException.php
  3. 10 core/modules/migrate/src/Plugin/Exception/BadPluginDefinitionException.php

Namespace

Drupal\migrate\Plugin\Exception

File

core/modules/migrate/src/Plugin/Exception/BadPluginDefinitionException.php

View source
<?php

namespace Drupal\migrate\Plugin\Exception;

use Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException;

/**
 * Defines a class for bad plugin definition exceptions.
 */
class BadPluginDefinitionException extends InvalidPluginDefinitionException {
    
    /**
     * Constructs a BadPluginDefinitionException.
     *
     * @param string $plugin_id
     *   The plugin ID of the mapper.
     * @param string $property
     *   The name of the property that is missing from the plugin.
     * @param int $code
     *   (optional) The exception code. Defaults to 0.
     * @param \Exception|null $previous
     *   The previous throwable used for exception chaining.
     *
     * @see \Exception
     */
    public function __construct($plugin_id, $property, $code = 0, ?\Exception $previous = NULL) {
        $message = sprintf('The %s plugin must define the %s property.', $plugin_id, $property);
        parent::__construct($plugin_id, $message, $code, $previous);
    }

}

Classes

Title Deprecated Summary
BadPluginDefinitionException Defines a class for bad plugin definition exceptions.

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