class MigrateSkipRowException
Same name in other branches
- 9 core/modules/migrate/src/MigrateSkipRowException.php \Drupal\migrate\MigrateSkipRowException
- 8.9.x core/modules/migrate/src/MigrateSkipRowException.php \Drupal\migrate\MigrateSkipRowException
- 11.x core/modules/migrate/src/MigrateSkipRowException.php \Drupal\migrate\MigrateSkipRowException
This exception is thrown when a row should be skipped.
This exception should be used in Migrate process plugins. Throwing it in a source plugin may cause unexpected results in the count of rows processed. And throwing it in a destination plugin causes an error.
Hierarchy
- class \Drupal\migrate\MigrateSkipRowException extends \Drupal\migrate\Exception
Expanded class hierarchy of MigrateSkipRowException
21 files declare their use of MigrateSkipRowException
- BlockVisibility.php in core/
modules/ block/ src/ Plugin/ migrate/ process/ BlockVisibility.php - BlockVisibilityTest.php in core/
modules/ block/ tests/ src/ Unit/ Plugin/ migrate/ process/ BlockVisibilityTest.php - MenuLinkParent.php in core/
modules/ migrate/ src/ Plugin/ migrate/ process/ MenuLinkParent.php - MenuLinkParentTest.php in core/
modules/ migrate/ tests/ src/ Unit/ process/ MenuLinkParentTest.php - MigrateSourceTest.php in core/
modules/ migrate/ tests/ src/ Unit/ MigrateSourceTest.php
File
-
core/
modules/ migrate/ src/ MigrateSkipRowException.php, line 12
Namespace
Drupal\migrateView source
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 = '', $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
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.