class AlertCommand in Zircon Profile 8

AJAX command for a javascript alert box.

Hierarchy

• class \Drupal\Core\Ajax\AlertCommand implements CommandInterface

Related topics

Ajax API

Overview for Drupal's Ajax API.

6 files declare their use of AlertCommand

AjaxCommandsTest.php in core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php

Contains \Drupal\Tests\Core\Ajax\AjaxCommandsTest.

AjaxRenderer.php in core/lib/Drupal/Core/Render/MainContent/AjaxRenderer.php

Contains \Drupal\Core\Render\MainContent\AjaxRenderer.

AjaxTestController.php in core/modules/system/tests/modules/ajax_test/src/Controller/AjaxTestController.php

Contains \Drupal\ajax_test\Controller\AjaxTestController.

CommandsTest.php in core/modules/system/src/Tests/Ajax/CommandsTest.php

Contains \Drupal\system\Tests\Ajax\CommandsTest.

FormAjaxResponseBuilderTest.php in core/tests/Drupal/Tests/Core/Form/FormAjaxResponseBuilderTest.php

Contains \Drupal\Tests\Core\Form\FormAjaxResponseBuilderTest.

... See full list

File

core/lib/Drupal/Core/Ajax/AlertCommand.php, line 15

Contains \Drupal\Core\Ajax\AlertCommand.

Namespace

Drupal\Core\Ajax

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,
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AlertCommand::$text	protected	property	The text to be displayed in the alert box.
AlertCommand::render	public	function	Implements Drupal\Core\Ajax\CommandInterface:render(). Overrides CommandInterface::render
AlertCommand::__construct	public	function	Constructs an AlertCommand object.