class TableTest in Drupal 8
Same name and namespace in other branches
- 9 core/tests/Drupal/KernelTests/Core/Render/Element/TableTest.php \Drupal\KernelTests\Core\Render\Element\TableTest
- 10 core/tests/Drupal/KernelTests/Core/Render/Element/TableTest.php \Drupal\KernelTests\Core\Render\Element\TableTest
Tests built-in table theme functions.
@group Theme
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\KernelTests\Core\Render\Element\TableTest
Expanded class hierarchy of TableTest
File
- core/
tests/ Drupal/ KernelTests/ Core/ Render/ Element/ TableTest.php, line 12
Namespace
Drupal\KernelTests\Core\Render\ElementView source
class TableTest extends KernelTestBase {
/**
* Modules to enable.
*
* @var array
*/
public static $modules = [
'system',
'form_test',
];
/**
* Tableheader.js provides 'sticky' table headers, and is included by default.
*/
public function testThemeTableStickyHeaders() {
$header = [
'one',
'two',
'three',
];
$rows = [
[
1,
2,
3,
],
[
4,
5,
6,
],
[
7,
8,
9,
],
];
$table = [
'#type' => 'table',
'#header' => $header,
'#rows' => $rows,
'#sticky' => TRUE,
];
$this
->render($table);
// Make sure tableheader.js was attached.
$tableheader = $this
->xpath("//script[contains(@src, 'tableheader.js')]");
$this
->assertCount(1, $tableheader);
$this
->assertRaw('sticky-enabled');
}
/**
* If $sticky is FALSE, no tableheader.js should be included.
*/
public function testThemeTableNoStickyHeaders() {
$header = [
'one',
'two',
'three',
];
$rows = [
[
1,
2,
3,
],
[
4,
5,
6,
],
[
7,
8,
9,
],
];
$attributes = [];
$caption = NULL;
$colgroups = [];
$table = [
'#type' => 'table',
'#header' => $header,
'#rows' => $rows,
'#attributes' => $attributes,
'#caption' => $caption,
'#colgroups' => $colgroups,
'#sticky' => FALSE,
];
$this
->render($table);
// Make sure tableheader.js was not attached.
$tableheader = $this
->xpath("//script[contains(@src, 'tableheader.js')]");
$this
->assertCount(0, $tableheader);
$this
->assertNoRaw('sticky-enabled');
}
/**
* Tests that the table header is printed correctly even if there are no rows,
* and that the empty text is displayed correctly.
*/
public function testThemeTableWithEmptyMessage() {
$header = [
'Header 1',
[
'data' => 'Header 2',
'colspan' => 2,
],
];
$table = [
'#type' => 'table',
'#header' => $header,
'#rows' => [],
'#empty' => 'Empty row.',
];
// Enable the Classy theme.
\Drupal::service('theme_installer')
->install([
'classy',
]);
$this
->config('system.theme')
->set('default', 'classy')
->save();
$this
->render($table);
$this
->removeWhiteSpace();
$this
->assertRaw('<thead><tr><th>Header 1</th><th colspan="2">Header 2</th></tr>', 'Table header found.');
$this
->assertRaw('<tr class="odd"><td colspan="3" class="empty message">Empty row.</td>', 'Colspan on #empty row found.');
}
/**
* Tests that the 'no_striping' option works correctly.
*/
public function testThemeTableWithNoStriping() {
$rows = [
[
'data' => [
1,
],
'no_striping' => TRUE,
],
];
$table = [
'#type' => 'table',
'#rows' => $rows,
];
$this
->render($table);
$this
->assertNoRaw('class="odd"', 'Odd/even classes were not added because $no_striping = TRUE.');
$this
->assertNoRaw('no_striping', 'No invalid no_striping HTML attribute was printed.');
}
/**
* Test that the 'footer' option works correctly.
*/
public function testThemeTableFooter() {
$footer = [
[
'data' => [
1,
],
],
[
'Foo',
],
];
$table = [
'#type' => 'table',
'#rows' => [],
'#footer' => $footer,
];
$this
->render($table);
$this
->removeWhiteSpace();
$this
->assertRaw('<tfoot><tr><td>1</td></tr><tr><td>Foo</td></tr></tfoot>', 'Table footer found.');
}
/**
* Tests that the 'header' option in cells works correctly.
*/
public function testThemeTableHeaderCellOption() {
$rows = [
[
[
'data' => 1,
'header' => TRUE,
],
[
'data' => 1,
'header' => FALSE,
],
[
'data' => 1,
],
],
];
$table = [
'#type' => 'table',
'#rows' => $rows,
];
$this
->render($table);
$this
->removeWhiteSpace();
$this
->assertRaw('<th>1</th><td>1</td><td>1</td>', 'The th and td tags was printed correctly.');
}
/**
* Tests that the 'responsive-table' class is applied correctly.
*/
public function testThemeTableResponsive() {
$header = [
'one',
'two',
'three',
];
$rows = [
[
1,
2,
3,
],
[
4,
5,
6,
],
[
7,
8,
9,
],
];
$table = [
'#type' => 'table',
'#header' => $header,
'#rows' => $rows,
'#responsive' => TRUE,
];
$this
->render($table);
$this
->assertRaw('responsive-enabled', 'The responsive-enabled class was printed correctly.');
}
/**
* Tests that the 'responsive-table' class is not applied without headers.
*/
public function testThemeTableNotResponsiveHeaders() {
$rows = [
[
1,
2,
3,
],
[
4,
5,
6,
],
[
7,
8,
9,
],
];
$table = [
'#type' => 'table',
'#rows' => $rows,
'#responsive' => TRUE,
];
$this
->render($table);
$this
->assertNoRaw('responsive-enabled', 'The responsive-enabled class is not applied without table headers.');
}
/**
* Tests that 'responsive-table' class only applied when responsive is TRUE.
*/
public function testThemeTableNotResponsiveProperty() {
$header = [
'one',
'two',
'three',
];
$rows = [
[
1,
2,
3,
],
[
4,
5,
6,
],
[
7,
8,
9,
],
];
$table = [
'#type' => 'table',
'#header' => $header,
'#rows' => $rows,
'#responsive' => FALSE,
];
$this
->render($table);
$this
->assertNoRaw('responsive-enabled', 'The responsive-enabled class is not applied without the "responsive" property set to TRUE.');
}
/**
* Tests 'priority-medium' and 'priority-low' classes.
*/
public function testThemeTableResponsivePriority() {
$header = [
// Test associative header indices.
'associative_key' => [
'data' => 1,
'class' => [
RESPONSIVE_PRIORITY_MEDIUM,
],
],
// Test non-associative header indices.
[
'data' => 2,
'class' => [
RESPONSIVE_PRIORITY_LOW,
],
],
// Test no responsive priorities.
[
'data' => 3,
],
];
$rows = [
[
4,
5,
6,
],
];
$table = [
'#type' => 'table',
'#header' => $header,
'#rows' => $rows,
'#responsive' => TRUE,
];
$this
->render($table);
$this
->assertRaw('<th class="priority-medium">1</th>', 'Header 1: the priority-medium class was applied correctly.');
$this
->assertRaw('<th class="priority-low">2</th>', 'Header 2: the priority-low class was applied correctly.');
$this
->assertRaw('<th>3</th>', 'Header 3: no priority classes were applied.');
$this
->assertRaw('<td class="priority-medium">4</td>', 'Cell 1: the priority-medium class was applied correctly.');
$this
->assertRaw('<td class="priority-low">5</td>', 'Cell 2: the priority-low class was applied correctly.');
$this
->assertRaw('<td>6</td>', 'Cell 3: no priority classes were applied.');
}
/**
* Tests header elements with a mix of string and render array values.
*/
public function testThemeTableHeaderRenderArray() {
$header = [
[
'data' => [
'#markup' => 'one',
],
],
'two',
[
'data' => [
'#type' => 'html_tag',
'#tag' => 'b',
'#value' => 'three',
],
],
];
$rows = [
[
1,
2,
3,
],
[
4,
5,
6,
],
[
7,
8,
9,
],
];
$table = [
'#type' => 'table',
'#header' => $header,
'#rows' => $rows,
'#responsive' => FALSE,
];
$this
->render($table);
$this
->removeWhiteSpace();
$this
->assertRaw('<thead><tr><th>one</th><th>two</th><th><b>three</b></th></tr>', 'Table header found.');
}
/**
* Tests row elements with a mix of string and render array values.
*/
public function testThemeTableRowRenderArray() {
$header = [
'one',
'two',
'three',
];
$rows = [
[
'1-one',
[
'data' => '1-two',
],
'1-three',
],
[
[
'data' => [
'#markup' => '2-one',
],
],
'2-two',
[
'data' => [
'#type' => 'html_tag',
'#tag' => 'b',
'#value' => '2-three',
],
],
],
];
$table = [
'#type' => 'table',
'#header' => $header,
'#rows' => $rows,
'#responsive' => FALSE,
];
$this
->render($table);
$this
->removeWhiteSpace();
$this
->assertRaw('<tbody><tr><td>1-one</td><td>1-two</td><td>1-three</td></tr>', 'Table row 1 found.');
$this
->assertRaw('<tr><td>2-one</td><td>2-two</td><td><b>2-three</b></td></tr></tbody>', 'Table row 2 found.');
}
/**
* Tests that the select/checkbox label is being generated and escaped.
*/
public function testThemeTableTitle() {
$form = \Drupal::formBuilder()
->getForm('\\Drupal\\form_test\\Form\\FormTestTableForm');
$this
->render($form);
$this
->assertEscaped('Update <em>kitten</em>');
$this
->assertRaw('Update my favorite fruit is <strong>bananas</strong>');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertHelperTrait:: |
protected static | function | Casts MarkupInterface objects into strings. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
protected | property | Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 1 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | Returns whether the current test method is running in a separate process. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
26 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
protected | function | 347 | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 6 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | BC: Automatically resolve former KernelTestBase class properties. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpunitCompatibilityTrait:: |
public | function | Returns a mock object for the specified class using the available method. | |
PhpunitCompatibilityTrait:: |
public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TableTest:: |
public static | property |
Modules to enable. Overrides KernelTestBase:: |
|
TableTest:: |
public | function | Test that the 'footer' option works correctly. | |
TableTest:: |
public | function | Tests that the 'header' option in cells works correctly. | |
TableTest:: |
public | function | Tests header elements with a mix of string and render array values. | |
TableTest:: |
public | function | If $sticky is FALSE, no tableheader.js should be included. | |
TableTest:: |
public | function | Tests that the 'responsive-table' class is not applied without headers. | |
TableTest:: |
public | function | Tests that 'responsive-table' class only applied when responsive is TRUE. | |
TableTest:: |
public | function | Tests that the 'responsive-table' class is applied correctly. | |
TableTest:: |
public | function | Tests 'priority-medium' and 'priority-low' classes. | |
TableTest:: |
public | function | Tests row elements with a mix of string and render array values. | |
TableTest:: |
public | function | Tableheader.js provides 'sticky' table headers, and is included by default. | |
TableTest:: |
public | function | Tests that the select/checkbox label is being generated and escaped. | |
TableTest:: |
public | function | Tests that the table header is printed correctly even if there are no rows, and that the empty text is displayed correctly. | |
TableTest:: |
public | function | Tests that the 'no_striping' option works correctly. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. |