MigrateException.php

Same filename in other branches
  1. 9 core/modules/migrate/src/MigrateException.php
  2. 10 core/modules/migrate/src/MigrateException.php
  3. 11.x core/modules/migrate/src/MigrateException.php

Namespace

Drupal\migrate

File

core/modules/migrate/src/MigrateException.php

View source
<?php

namespace Drupal\migrate;

use Drupal\migrate\Plugin\MigrateIdMapInterface;
use Drupal\migrate\Plugin\MigrationInterface;

/**
 * Defines the migrate exception class.
 */
class MigrateException extends \Exception {
    
    /**
     * The level of the error being reported.
     *
     * The value is a Migration::MESSAGE_* constant.
     *
     * @var int
     */
    protected $level;
    
    /**
     * The status to record in the map table for the current item.
     *
     * The value is a MigrateMap::STATUS_* constant.
     *
     * @var int
     */
    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 = NULL, $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;
    }

}

Classes

Title Deprecated Summary
MigrateException Defines the migrate exception class.

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