class MigrateSkipRowException in Zircon Profile 8

This exception is thrown when a row should be skipped.

Hierarchy

• class \Drupal\migrate\MigrateSkipRowException extends \Drupal\migrate\Exception

9 files declare their use of MigrateSkipRowException

BlockVisibility.php in core/modules/block/src/Plugin/migrate/process/BlockVisibility.php

Contains \Drupal\block\Plugin\migrate\process\BlockVisibility.

CckFile.php in core/modules/file/src/Plugin/migrate/process/d6/CckFile.php

Contains \Drupal\file\Plugin\migrate\process\d6\CckFile.

MigrateSourceTest.php in core/modules/migrate/tests/src/Unit/MigrateSourceTest.php

Contains \Drupal\Tests\migrate\Unit\MigrateSourceTest.

migrate_prepare_row_test.module in core/modules/migrate/tests/modules/migrate_prepare_row_test/migrate_prepare_row_test.module

Test module for testing the migration source plugin prepareRow() exception handling.

Migration.php in core/modules/migrate/src/Entity/Migration.php

Contains \Drupal\migrate\Entity\Migration.

... See full list

File

core/modules/migrate/src/MigrateSkipRowException.php, line 13

Contains \Drupal\migrate\MigrateSkipRowException.

Namespace

Drupal\migrate

class MigrateSkipRowException extends \Exception {

  /**
   * Whether to record the skip in the map table, or skip silently.
   *
   * @var bool
   *   TRUE to record as STATUS_IGNORED in the map, FALSE to skip silently.
   */
  protected $saveToMap;

  /**
   * Constructs a MigrateSkipRowException object.
   *
   * @param string $message
   *   The message for the exception.
   * @param bool $save_to_map
   *   TRUE to record as STATUS_IGNORED in the map, FALSE to skip silently.
   */
  public function __construct($message = NULL, $save_to_map = TRUE) {
    parent::__construct($message);
    $this->saveToMap = $save_to_map;
  }

  /**
   * Whether the thrower wants to record this skip in the map table.
   *
   * @return bool
   *   TRUE to record as STATUS_IGNORED in the map, FALSE to skip silently.
   */
  public function getSaveToMap() {
    return $this->saveToMap;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MigrateSkipRowException::$saveToMap	protected	property	Whether to record the skip in the map table, or skip silently.
MigrateSkipRowException::getSaveToMap	public	function	Whether the thrower wants to record this skip in the map table.
MigrateSkipRowException::__construct	public	function	Constructs a MigrateSkipRowException object.