New Text!
', ['my-setting' => 'setting']); $expected = [ 'command' => 'insert', 'method' => 'after', 'selector' => '#page-title', 'data' => 'New Text!
', 'settings' => ['my-setting' => 'setting'], ]; $this->assertEquals($expected, $command->render()); } /** * Tests alert command. * * @legacy-covers \Drupal\Core\Ajax\AlertCommand */ public function testAlertCommand(): void { $command = new AlertCommand('Set condition 1 throughout the ship!'); $expected = [ 'command' => 'alert', 'text' => 'Set condition 1 throughout the ship!', ]; $this->assertEquals($expected, $command->render()); } /** * Tests announce command. * * @legacy-covers \Drupal\Core\Ajax\AnnounceCommand */ #[DataProvider('announceCommandProvider')] public function testAnnounceCommand($message, $priority, array $expected): void { if ($priority === NULL) { $command = new AnnounceCommand($message); } else { $command = new AnnounceCommand($message, $priority); } $expected_assets = new AttachedAssets(); $expected_assets->setLibraries(['core/drupal.announce']); $this->assertEquals($expected_assets, $command->getAttachedAssets()); $this->assertSame($expected, $command->render()); } /** * Data provider for testAnnounceCommand(). */ public static function announceCommandProvider(): array { return [ 'no priority' => [ 'Things are going to change!', NULL, [ 'command' => 'announce', 'text' => 'Things are going to change!', ], ], 'polite priority' => [ 'Things are going to change!', 'polite', [ 'command' => 'announce', 'text' => 'Things are going to change!', 'priority' => AnnounceCommand::PRIORITY_POLITE, ], ], 'assertive priority' => [ 'Important!', 'assertive', [ 'command' => 'announce', 'text' => 'Important!', 'priority' => AnnounceCommand::PRIORITY_ASSERTIVE, ], ], ]; } /** * Tests append command. * * @legacy-covers \Drupal\Core\Ajax\AppendCommand */ public function testAppendCommand(): void { $command = new AppendCommand('#page-title', 'New Text!
', ['my-setting' => 'setting']); $expected = [ 'command' => 'insert', 'method' => 'append', 'selector' => '#page-title', 'data' => 'New Text!
', 'settings' => ['my-setting' => 'setting'], ]; $this->assertEquals($expected, $command->render()); } /** * Tests before command. * * @legacy-covers \Drupal\Core\Ajax\BeforeCommand */ public function testBeforeCommand(): void { $command = new BeforeCommand('#page-title', 'New Text!
', ['my-setting' => 'setting']); $expected = [ 'command' => 'insert', 'method' => 'before', 'selector' => '#page-title', 'data' => 'New Text!
', 'settings' => ['my-setting' => 'setting'], ]; $this->assertEquals($expected, $command->render()); } /** * Tests changed command. * * @legacy-covers \Drupal\Core\Ajax\ChangedCommand */ public function testChangedCommand(): void { $command = new ChangedCommand('#page-title', '#page-title-changed'); $expected = [ 'command' => 'changed', 'selector' => '#page-title', 'asterisk' => '#page-title-changed', ]; $this->assertEquals($expected, $command->render()); } /** * Tests css command. * * @legacy-covers \Drupal\Core\Ajax\CssCommand */ public function testCssCommand(): void { $command = new CssCommand('#page-title', ['text-decoration' => 'blink']); $command->setProperty('font-size', '40px')->setProperty('font-weight', 'bold'); $expected = [ 'command' => 'css', 'selector' => '#page-title', 'argument' => [ 'text-decoration' => 'blink', 'font-size' => '40px', 'font-weight' => 'bold', ], ]; $this->assertEquals($expected, $command->render()); } /** * Tests data command. * * @legacy-covers \Drupal\Core\Ajax\DataCommand */ public function testDataCommand(): void { $command = new DataCommand('#page-title', 'my-data', ['key' => 'value']); $expected = [ 'command' => 'data', 'selector' => '#page-title', 'name' => 'my-data', 'value' => ['key' => 'value'], ]; $this->assertEquals($expected, $command->render()); } /** * Tests html command. * * @legacy-covers \Drupal\Core\Ajax\HtmlCommand */ public function testHtmlCommand(): void { $command = new HtmlCommand('#page-title', 'New Text!
', ['my-setting' => 'setting']); $expected = [ 'command' => 'insert', 'method' => 'html', 'selector' => '#page-title', 'data' => 'New Text!
', 'settings' => ['my-setting' => 'setting'], ]; $this->assertEquals($expected, $command->render()); } /** * Tests insert command. * * @legacy-covers \Drupal\Core\Ajax\InsertCommand */ public function testInsertCommand(): void { $command = new InsertCommand('#page-title', 'New Text!
', ['my-setting' => 'setting']); $expected = [ 'command' => 'insert', 'method' => NULL, 'selector' => '#page-title', 'data' => 'New Text!
', 'settings' => ['my-setting' => 'setting'], ]; $this->assertEquals($expected, $command->render()); } /** * Tests invoke command. * * @legacy-covers \Drupal\Core\Ajax\InvokeCommand */ public function testInvokeCommand(): void { $command = new InvokeCommand('#page-title', 'myMethod', ['var1', 'var2']); $expected = [ 'command' => 'invoke', 'selector' => '#page-title', 'method' => 'myMethod', 'args' => ['var1', 'var2'], ]; $this->assertEquals($expected, $command->render()); } /** * Tests prepend command. * * @legacy-covers \Drupal\Core\Ajax\PrependCommand */ public function testPrependCommand(): void { $command = new PrependCommand('#page-title', 'New Text!
', ['my-setting' => 'setting']); $expected = [ 'command' => 'insert', 'method' => 'prepend', 'selector' => '#page-title', 'data' => 'New Text!
', 'settings' => ['my-setting' => 'setting'], ]; $this->assertEquals($expected, $command->render()); } /** * Tests remove command. * * @legacy-covers \Drupal\Core\Ajax\RemoveCommand */ public function testRemoveCommand(): void { $command = new RemoveCommand('#page-title'); $expected = [ 'command' => 'remove', 'selector' => '#page-title', ]; $this->assertEquals($expected, $command->render()); } /** * Tests replace command. * * @legacy-covers \Drupal\Core\Ajax\ReplaceCommand */ public function testReplaceCommand(): void { $command = new ReplaceCommand('#page-title', 'New Text!
', ['my-setting' => 'setting']); $expected = [ 'command' => 'insert', 'method' => 'replaceWith', 'selector' => '#page-title', 'data' => 'New Text!
', 'settings' => ['my-setting' => 'setting'], ]; $this->assertEquals($expected, $command->render()); } /** * Tests restripe command. * * @legacy-covers \Drupal\Core\Ajax\RestripeCommand */ public function testRestripeCommand(): void { $command = new RestripeCommand('#page-title'); $expected = [ 'command' => 'restripe', 'selector' => '#page-title', ]; $this->assertEquals($expected, $command->render()); } /** * Tests settings command. * * @legacy-covers \Drupal\Core\Ajax\SettingsCommand */ public function testSettingsCommand(): void { $command = new SettingsCommand(['key' => 'value'], TRUE); $expected = [ 'command' => 'settings', 'settings' => ['key' => 'value'], 'merge' => TRUE, ]; $this->assertEquals($expected, $command->render()); } /** * Tests open dialog command. * * @legacy-covers \Drupal\Core\Ajax\OpenDialogCommand */ public function testOpenDialogCommand(): void { $command = new OpenDialogCommand('#some-dialog', 'Title', 'Text!
', [ 'url' => FALSE, 'width' => 500, ]); $expected = [ 'command' => 'openDialog', 'selector' => '#some-dialog', 'settings' => NULL, 'data' => 'Text!
', 'dialogOptions' => [ 'url' => FALSE, 'width' => 500, 'title' => 'Title', 'modal' => FALSE, ], ]; $this->assertEquals($expected, $command->render()); $command->setDialogTitle('New title'); $expected['dialogOptions']['title'] = 'New title'; $this->assertEquals($expected, $command->render()); } /** * Tests dialogClass for OpenDialogCommand and OpenOffCanvasDialogCommand. * * This is a regression test for https://www.drupal.org/node/3474018. * * @legacy-covers \Drupal\Core\Ajax\OpenDialogCommand * @legacy-covers \Drupal\Core\Ajax\OpenOffCanvasDialogCommand */ #[IgnoreDeprecations] #[DataProvider('dialogCommandProvider')] public function testOpenDialogCommandClass(string $class, array $args, array $expected): void { $short = (new \ReflectionClass($class))->getShortName(); $this->expectUserDeprecationMessage("Passing \$dialog_options['dialogClass'] to {$short}::__construct() is deprecated in drupal:10.3.0 and will be removed in drupal:12.0.0. Use \$dialog_options['classes'] instead. See https://www.drupal.org/node/3440844"); $reflection = new \ReflectionClass($class); $command = $reflection->newInstanceArgs($args); $this->assertEquals($expected, $command->getDialogOptions()); } /** * Data provider for testOpenDialogCommandClass. */ public static function dialogCommandProvider(): array { return [ 'OpenDialogCommand with only dialogClass' => [ OpenDialogCommand::class, ['#some-dialog', 'Title', '', ['dialogClass' => 'foo bar']], ['title' => 'Title', 'classes' => ['ui-dialog' => 'foo bar']], ], 'OpenDialogCommand with dialogClass and classes' => [ OpenDialogCommand::class, ['#some-dialog', 'Title', '', ['dialogClass' => 'foo bar', 'classes' => ['ui-dialog' => 'baz qux']]], ['title' => 'Title', 'classes' => ['ui-dialog' => 'baz qux foo bar']], ], 'OpenOffCanvasDialogCommand with only dialogClass' => [ OpenOffCanvasDialogCommand::class, ['Title', '', ['dialogClass' => 'foo bar']], [ 'title' => 'Title', 'classes' => [ 'ui-dialog' => 'foo bar ui-dialog-off-canvas ui-dialog-position-side', 'ui-dialog-content' => 'drupal-off-canvas-reset', ], 'modal' => FALSE, 'autoResize' => FALSE, 'resizable' => 'w', 'draggable' => FALSE, 'drupalAutoButtons' => FALSE, 'drupalOffCanvasPosition' => 'side', 'width' => 300, ], ], 'OpenOffCanvasDialogCommand with dialogClass and classes' => [ OpenOffCanvasDialogCommand::class, ['Title', '', ['dialogClass' => 'foo bar', 'classes' => ['ui-dialog' => 'baz qux']]], [ 'title' => 'Title', 'classes' => [ 'ui-dialog' => 'baz qux foo bar ui-dialog-off-canvas ui-dialog-position-side', 'ui-dialog-content' => 'drupal-off-canvas-reset', ], 'modal' => FALSE, 'autoResize' => FALSE, 'resizable' => 'w', 'draggable' => FALSE, 'drupalAutoButtons' => FALSE, 'drupalOffCanvasPosition' => 'side', 'width' => 300, ], ], ]; } /** * Tests open modal dialog command. * * @legacy-covers \Drupal\Core\Ajax\OpenModalDialogCommand */ public function testOpenModalDialogCommand(): void { $command = $this->getMockBuilder('Drupal\Core\Ajax\OpenModalDialogCommand') ->setConstructorArgs([ 'Title', 'Text!
', [ 'url' => 'example', 'width' => 500, ], ]) ->onlyMethods(['getRenderedContent']) ->getMock(); // This method calls the render service, which isn't available. We want it // to do nothing so we mock it to return a known value. $command->expects($this->once()) ->method('getRenderedContent') ->willReturn('rendered content'); $expected = [ 'command' => 'openDialog', 'selector' => '#drupal-modal', 'settings' => NULL, 'data' => 'rendered content', 'dialogOptions' => [ 'url' => 'example', 'width' => 500, 'title' => 'Title', 'modal' => TRUE, ], ]; $this->assertEquals($expected, $command->render()); } /** * Tests close modal dialog command. * * @legacy-covers \Drupal\Core\Ajax\CloseModalDialogCommand */ public function testCloseModalDialogCommand(): void { $command = new CloseModalDialogCommand(); $expected = [ 'command' => 'closeDialog', 'selector' => '#drupal-modal', 'persist' => FALSE, ]; $this->assertEquals($expected, $command->render()); } /** * Tests close dialog command. * * @legacy-covers \Drupal\Core\Ajax\CloseDialogCommand */ public function testCloseDialogCommand(): void { $command = new CloseDialogCommand('#some-dialog', TRUE); $expected = [ 'command' => 'closeDialog', 'selector' => '#some-dialog', 'persist' => TRUE, ]; $this->assertEquals($expected, $command->render()); } /** * Tests set dialog option command. * * @legacy-covers \Drupal\Core\Ajax\SetDialogOptionCommand */ public function testSetDialogOptionCommand(): void { $command = new SetDialogOptionCommand('#some-dialog', 'width', '500'); $expected = [ 'command' => 'setDialogOption', 'selector' => '#some-dialog', 'optionName' => 'width', 'optionValue' => '500', ]; $this->assertEquals($expected, $command->render()); } /** * Tests set dialog title command. * * @legacy-covers \Drupal\Core\Ajax\SetDialogTitleCommand */ public function testSetDialogTitleCommand(): void { $command = new SetDialogTitleCommand('#some-dialog', 'Example'); $expected = [ 'command' => 'setDialogOption', 'selector' => '#some-dialog', 'optionName' => 'title', 'optionValue' => 'Example', ]; $this->assertEquals($expected, $command->render()); } /** * Tests redirect command. * * @legacy-covers \Drupal\Core\Ajax\RedirectCommand */ public function testRedirectCommand(): void { $command = new RedirectCommand('http://example.com'); $expected = [ 'command' => 'redirect', 'url' => 'http://example.com', ]; $this->assertEquals($expected, $command->render()); } /** * Tests update build id command. * * @legacy-covers \Drupal\Core\Ajax\UpdateBuildIdCommand */ public function testUpdateBuildIdCommand(): void { $old = 'ThisStringIsOld'; $new = 'ThisStringIsNew'; $command = new UpdateBuildIdCommand($old, $new); $expected = [ 'command' => 'update_build_id', 'old' => $old, 'new' => $new, ]; $this->assertEquals($expected, $command->render()); } }