class MigrateMessageCapture in Drupal 9

Allows capturing messages rather than displaying them directly.

Hierarchy

• class \Drupal\migrate_drupal_ui\Batch\MigrateMessageCapture implements MigrateMessageInterface

File

core/modules/migrate_drupal_ui/src/Batch/MigrateMessageCapture.php, line 10

Namespace

Drupal\migrate_drupal_ui\Batch

class MigrateMessageCapture implements MigrateMessageInterface {

  /**
   * Array of recorded messages.
   *
   * @var array
   */
  protected $messages = [];

  /**
   * {@inheritdoc}
   */
  public function display($message, $type = 'status') {
    $this->messages[] = $message;
  }

  /**
   * Clears out any captured messages.
   */
  public function clear() {
    $this->messages = [];
  }

  /**
   * Returns any captured messages.
   *
   * @return array
   *   The captured messages.
   */
  public function getMessages() {
    return $this->messages;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MigrateMessageCapture::$messages	protected	property	Array of recorded messages.
MigrateMessageCapture::clear	public	function	Clears out any captured messages.
MigrateMessageCapture::display	public	function	Displays a migrate message. Overrides MigrateMessageInterface::display
MigrateMessageCapture::getMessages	public	function	Returns any captured messages.