Same name and namespace in other branches
  1. 8.9.x core/modules/migrate/src/MigrateException.php \Drupal\migrate\MigrateException
  2. 9 core/modules/migrate/src/MigrateException.php \Drupal\migrate\MigrateException

Defines the migrate exception class.

Hierarchy

Expanded class hierarchy of MigrateException

68 files declare their use of MigrateException
ArrayBuild.php in core/modules/migrate/src/Plugin/migrate/process/ArrayBuild.php
ArrayBuildTest.php in core/modules/migrate/tests/src/Unit/process/ArrayBuildTest.php
Callback.php in core/modules/migrate/src/Plugin/migrate/process/Callback.php
CallbackTest.php in core/modules/migrate/tests/src/Unit/process/CallbackTest.php
Concat.php in core/modules/migrate/src/Plugin/migrate/process/Concat.php

... See full list

File

core/modules/migrate/src/MigrateException.php, line 11

Namespace

Drupal\migrate
View source
class MigrateException extends \Exception {

  /**
   * The level of the error being reported.
   *
   * The value is a MigrationInterface::MESSAGE_* constant.
   *
   * @var int
   *
   * @see \Drupal\migrate\Plugin\MigrationInterface
   */
  protected $level;

  /**
   * The status to record in the map table for the current item.
   *
   * The value is a MigrateIdMapInterface::STATUS_* constant.
   *
   * @var int
   *
   * @see \Drupal\migrate\Plugin\MigrateIdMapInterface
   */
  protected $status;

  /**
   * Constructs a MigrateException object.
   *
   * @param string $message
   *   The message for the exception.
   * @param int $code
   *   The Exception code.
   * @param \Exception $previous
   *   The previous exception used for the exception chaining.
   * @param int $level
   *   The level of the error, a Migration::MESSAGE_* constant.
   * @param int $status
   *   The status of the item for the map table, a MigrateMap::STATUS_*
   *   constant.
   */
  public function __construct($message = '', $code = 0, \Exception $previous = NULL, $level = MigrationInterface::MESSAGE_ERROR, $status = MigrateIdMapInterface::STATUS_FAILED) {
    $this->level = $level;
    $this->status = $status;
    parent::__construct($message);
  }

  /**
   * Gets the level.
   *
   * @return int
   *   An integer status code. @see Migration::MESSAGE_*
   */
  public function getLevel() {
    return $this->level;
  }

  /**
   * Gets the status of the current item.
   *
   * @return int
   *   An integer status code. @see MigrateMap::STATUS_*
   */
  public function getStatus() {
    return $this->status;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
MigrateException::$level protected property The level of the error being reported.
MigrateException::$status protected property The status to record in the map table for the current item.
MigrateException::getLevel public function Gets the level.
MigrateException::getStatus public function Gets the status of the current item.
MigrateException::__construct public function Constructs a MigrateException object. 1