AlertCommand.php

Definition of Drupal\Core\Ajax\AlertCommand.

Namespace

Drupal\Core\Ajax

File

drupal/core/lib/Drupal/Core/Ajax/AlertCommand.php
View source
<?php

/**
 * @file
 * Definition of Drupal\Core\Ajax\AlertCommand.
 */
namespace Drupal\Core\Ajax;

use Drupal\Core\Ajax\CommandInterface;

/**
 * AJAX command for a javascript alert box.
 */
class AlertCommand implements CommandInterface {

  /**
   * The text to be displayed in the alert box.
   *
   * @var string
   */
  protected $text;

  /**
   * Constructs an AlertCommand object.
   *
   * @param string $text
   *   The text to be displayed in the alert box.
   */
  public function __construct($text) {
    $this->text = $text;
  }

  /**
   * Implements Drupal\Core\Ajax\CommandInterface:render().
   */
  public function render() {
    return array(
      'command' => 'alert',
      'text' => $this->text,
    );
  }

}

Classes

Namesort descending Description
AlertCommand AJAX command for a javascript alert box.