Test on Bar Chart implementation. More...

Inheritance diagram for ChartBarTest:

Collaboration diagram for ChartBarTest:

Public Member Functions
	getDataFactory ()

	getUIFactory ()

	testImplementsFactoryInterface ()

	testGetInstances ()

	testEmptyDataset ()

	testWithTitle ()

	testWithTitleInvisible ()

	testWithTooltipsInvisible ()

	testWithLegendInvisible ()

	testWithLegendPosition ()

	testWithInvalidLegendPosition ()

	testWithDataset ()

	testWithBarConfigs ()

	testIndexAxis ()

	testRenderHorizontal ()

	testRenderVertical ()

Public Member Functions inherited from ILIAS_UI_TestBase
	setUp ()

	tearDown ()

	getUIFactory ()

	getTemplateFactory ()

	getResourceRegistry ()

	getLanguage ()

	getJavaScriptBinding ()

	getRefinery ()

	getImagePathResolver ()

	getDataFactory ()

	getHelpTextRetriever ()

	getUploadLimitResolver ()

	getDefaultRenderer (JavaScriptBinding $js_binding=null, array $with_stub_renderings=[])

	getDecoratedRenderer (Renderer $default)

	normalizeHTML (string $html)

	assertHTMLEquals (string $expected_html_as_string, string $html_as_string)

Protected Member Functions
	getFactory ()

	getSimpleDataset ()

	getExtendedDataset ()

Protected Member Functions inherited from ILIAS_UI_TestBase
	brutallyTrimHTML (string $html)
	A more radical version of normalizeHTML. More...

	brutallyTrimSignals (string $html)
	A naive replacement of all il_signal-ids with dots to ease comparisons of rendered output. More...

Detailed Description

Test on Bar Chart implementation.

Definition at line 30 of file ChartBarTest.php.

Member Function Documentation

◆ getDataFactory()

ChartBarTest::getDataFactory ( )

Definition at line 37 of file ChartBarTest.php.

Referenced by getExtendedDataset(), getSimpleDataset(), testEmptyDataset(), testIndexAxis(), and testWithBarConfigs().

                                     : ILIAS\Data\Factory
     {
         return new ILIAS\Data\Factory();
     }

Here is the caller graph for this function:

◆ getExtendedDataset()

ChartBarTest::getExtendedDataset ( )

protected

Definition at line 64 of file ChartBarTest.php.

References getDataFactory().

Referenced by testRenderVertical(), and testWithDataset().

                                            : \ILIAS\Data\Chart\Dataset
     {
         $df = $this->getDataFactory();
 
         $c_dimension = $df->dimension()->cardinal();
         $t_dimension = $df->dimension()->range($c_dimension);
 
         $dataset = $df->dataset(["Dataset 1" => $c_dimension, "Dataset 2" => $t_dimension]);
         $dataset = $dataset->withPoint("Item 1", ["Dataset 1" => -1.25, "Dataset 2" => [-2, -1]]);
         $dataset = $dataset->withPoint("Item 2", ["Dataset 1" => null, "Dataset 2" => [0, 0.5]]);
 
         return $dataset;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFactory()

ChartBarTest::getFactory ( )

protected

Definition at line 32 of file ChartBarTest.php.

Referenced by testEmptyDataset(), testGetInstances(), testImplementsFactoryInterface(), testIndexAxis(), testRenderHorizontal(), testRenderVertical(), testWithBarConfigs(), testWithDataset(), testWithInvalidLegendPosition(), testWithLegendInvisible(), testWithLegendPosition(), testWithTitle(), testWithTitleInvisible(), and testWithTooltipsInvisible().

                                    : C\Chart\Bar\Factory
     {
         return new I\Component\Chart\Bar\Factory();
     }

Here is the caller graph for this function:

◆ getSimpleDataset()

ChartBarTest::getSimpleDataset ( )

protected

Definition at line 52 of file ChartBarTest.php.

References getDataFactory().

Referenced by testGetInstances(), testIndexAxis(), testRenderHorizontal(), testWithBarConfigs(), testWithDataset(), testWithInvalidLegendPosition(), testWithLegendInvisible(), testWithLegendPosition(), testWithTitle(), testWithTitleInvisible(), and testWithTooltipsInvisible().

                                          : \ILIAS\Data\Chart\Dataset
     {
         $df = $this->getDataFactory();
 
         $c_dimension = $df->dimension()->cardinal();
 
         $dataset = $df->dataset(["Dataset" => $c_dimension]);
         $dataset = $dataset->withPoint("Item", ["Dataset" => 0]);
 
         return $dataset;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUIFactory()

ChartBarTest::getUIFactory ( )

Definition at line 42 of file ChartBarTest.php.

References ILIAS\Repository\listing().

                                   : NoUIFactory
     {
         return new class () extends NoUIFactory {
             public function listing(): I\Component\Listing\Factory
             {
                 return new I\Component\Listing\Factory();
             }
         };
     }

Here is the call graph for this function:

◆ testEmptyDataset()

ChartBarTest::testEmptyDataset ( )

Definition at line 107 of file ChartBarTest.php.

References Vendor\Package\$f, getDataFactory(), and getFactory().

                                       : void
     {
         $f = $this->getFactory();
         $df = $this->getDataFactory();
 
         $c_dimension = $df->dimension()->cardinal();
 
         $dataset = $df->dataset(["Dataset" => $c_dimension]);
 
         $this->expectException(LogicException::class);
         $this->expectExceptionMessage("Dataset must not be empty.");
         $horizontal = $f->horizontal(
             "Horizontal Bar",
             $dataset
         );
     }

Here is the call graph for this function:

◆ testGetInstances()

ChartBarTest::testGetInstances ( )

Definition at line 85 of file ChartBarTest.php.

References Vendor\Package\$f, getFactory(), and getSimpleDataset().

                                       : void
     {
         $f = $this->getFactory();
 
         $dataset = $this->getSimpleDataset();
 
         $horizontal = $f->horizontal(
             "Horizontal Bar",
             $dataset
         );
 
         $this->assertInstanceOf("ILIAS\\UI\\Component\\Chart\\Bar\\Bar", $horizontal);
         $this->assertInstanceOf("ILIAS\\UI\\Component\\Chart\\Bar\\Horizontal", $horizontal);
 
         $vertical = $f->vertical(
             "Vertical Bar",
             $dataset
         );
         $this->assertInstanceOf("ILIAS\\UI\\Component\\Chart\\Bar\\Bar", $vertical);
         $this->assertInstanceOf("ILIAS\\UI\\Component\\Chart\\Bar\\Vertical", $vertical);
     }

Here is the call graph for this function:

◆ testImplementsFactoryInterface()

ChartBarTest::testImplementsFactoryInterface ( )

Definition at line 78 of file ChartBarTest.php.

References Vendor\Package\$f, and getFactory().

                                                     : void
     {
         $f = $this->getFactory();
 
         $this->assertInstanceOf("ILIAS\\UI\\Component\\Chart\\Bar\\Factory", $f);
     }

Here is the call graph for this function:

◆ testIndexAxis()

ChartBarTest::testIndexAxis ( )

Definition at line 281 of file ChartBarTest.php.

References Vendor\Package\$f, getDataFactory(), getFactory(), and getSimpleDataset().

                                    : void
     {
         $f = $this->getFactory();
         $df = $this->getDataFactory();
 
         $dataset = $this->getSimpleDataset();
 
         $horizontal = $f->horizontal(
             "Horizontal Bar",
             $dataset
         );
 
         $this->assertEquals("y", $horizontal->getIndexAxis());
 
         $vertical = $f->vertical(
             "Vertical Bar",
             $dataset
         );
 
         $this->assertEquals("x", $vertical->getIndexAxis());
     }

Here is the call graph for this function:

◆ testRenderHorizontal()

ChartBarTest::testRenderHorizontal ( )

Definition at line 303 of file ChartBarTest.php.

References Vendor\Package\$f, $r, ILIAS_UI_TestBase\assertHTMLEquals(), ILIAS_UI_TestBase\getDefaultRenderer(), getFactory(), and getSimpleDataset().

                                           : void
     {
         $r = $this->getDefaultRenderer();
         $f = $this->getFactory();
 
         $dataset = $this->getSimpleDataset();
 
         $horizontal = $f->horizontal(
             "bar123",
             $dataset
         );
 
         $html = $r->render($horizontal);
 
         $expected_html = <<<EOT
 <div class="il-chart-bar-horizontal">
     <canvas id="id_1" height="150px" aria-label="bar123" role="img"></canvas>
 </div>
 <div class="sr-only">
     <dl>
         <dt>Dataset</dt>
         <dd>
             <ul>
                 <li>Item: 0</li>
             </ul>
         </dd>
     </dl>
 </div>
 EOT;
 
         $this->assertHTMLEquals("<div>" . $expected_html . "</div>", "<div>" . $html . "</div>");
     }

Here is the call graph for this function:

◆ testRenderVertical()

ChartBarTest::testRenderVertical ( )

Definition at line 336 of file ChartBarTest.php.

References Vendor\Package\$f, $r, ILIAS_UI_TestBase\assertHTMLEquals(), ILIAS_UI_TestBase\getDefaultRenderer(), getExtendedDataset(), and getFactory().

                                         : void
     {
         $r = $this->getDefaultRenderer();
         $f = $this->getFactory();
 
         $dataset = $this->getExtendedDataset();
 
         $vertical = $f->vertical(
             "bar123",
             $dataset
         );
 
         $html = $r->render($vertical);
 
         $expected_html = <<<EOT
 <div class="il-chart-bar-vertical">
     <canvas id="id_1" height="165px" aria-label="bar123" role="img"></canvas>
 </div>
 <div class="sr-only">
     <dl>
         <dt>Dataset 1</dt>
         <dd>
             <ul>
                 <li>Item 1: -1.25</li>
                 <li>Item 2: -</li>
             </ul>
         </dd>
         <dt>Dataset 2</dt>
         <dd>
             <ul>
                 <li>Item 1: -2 - -1</li>
                 <li>Item 2: 0 - 0.5</li>
             </ul>
         </dd>
     </dl>
 </div>
 EOT;
 
         $this->assertHTMLEquals("<div>" . $expected_html . "</div>", "<div>" . $html . "</div>");
     }

Here is the call graph for this function:

◆ testWithBarConfigs()

ChartBarTest::testWithBarConfigs ( )

Definition at line 257 of file ChartBarTest.php.

References Vendor\Package\$f, getDataFactory(), getFactory(), and getSimpleDataset().

                                         : void
     {
         $f = $this->getFactory();
         $df = $this->getDataFactory();
 
         $dataset = $this->getSimpleDataset();
 
         $bc = new C\Chart\Bar\BarConfig();
         $bc = $bc->withColor($df->color("#d38000"));
 
         $bars = [
             "Dataset" => $bc,
         ];
 
         $horizontal = $f->horizontal(
             "Horizontal Bar",
             $dataset
         );
         $horizontal1 = $horizontal->withBarConfigs($bars);
 
         $this->assertEquals([], $horizontal->getBarConfigs());
         $this->assertEquals($bars, $horizontal1->getBarConfigs());
     }

Here is the call graph for this function:

◆ testWithDataset()

ChartBarTest::testWithDataset ( )

Definition at line 240 of file ChartBarTest.php.

References Vendor\Package\$f, getExtendedDataset(), getFactory(), and getSimpleDataset().

                                      : void
     {
         $f = $this->getFactory();
 
         $s_dataset = $this->getSimpleDataset();
         $e_dataset = $this->getExtendedDataset();
 
         $horizontal = $f->horizontal(
             "Horizontal Bar",
             $s_dataset
         );
         $horizontal1 = $horizontal->withDataset($e_dataset);
 
         $this->assertEquals($s_dataset, $horizontal->getDataset());
         $this->assertEquals($e_dataset, $horizontal1->getDataset());
     }

Here is the call graph for this function:

◆ testWithInvalidLegendPosition()

ChartBarTest::testWithInvalidLegendPosition ( )

Definition at line 223 of file ChartBarTest.php.

References Vendor\Package\$f, getFactory(), and getSimpleDataset().

                                                    : void
     {
         $f = $this->getFactory();
 
         $dataset = $this->getSimpleDataset();
 
         $horizontal = $f->horizontal(
             "Horizontal Bar",
             $dataset
         );
 
         $this->expectException(InvalidArgumentException::class);
         $this->expectExceptionMessage("Position must be 'bottom', 'top', 'left' or 'right'.");
 
         $horizontal = $horizontal->withLegendPosition("middle");
     }

Here is the call graph for this function:

◆ testWithLegendInvisible()

ChartBarTest::testWithLegendInvisible ( )

Definition at line 191 of file ChartBarTest.php.

References Vendor\Package\$f, getFactory(), and getSimpleDataset().

                                              : void
     {
         $f = $this->getFactory();
 
         $dataset = $this->getSimpleDataset();
 
         $horizontal = $f->horizontal(
             "Horizontal Bar",
             $dataset
         );
         $horizontal1 = $horizontal->withLegendVisible(false);
 
         $this->assertEquals(true, $horizontal->isLegendVisible());
         $this->assertEquals(false, $horizontal1->isLegendVisible());
     }

Here is the call graph for this function:

◆ testWithLegendPosition()

ChartBarTest::testWithLegendPosition ( )

Definition at line 207 of file ChartBarTest.php.

References Vendor\Package\$f, getFactory(), and getSimpleDataset().

                                             : void
     {
         $f = $this->getFactory();
 
         $dataset = $this->getSimpleDataset();
 
         $horizontal = $f->horizontal(
             "Horizontal Bar",
             $dataset
         );
         $horizontal1 = $horizontal->withLegendPosition("left");
 
         $this->assertEquals("top", $horizontal->getLegendPosition());
         $this->assertEquals("left", $horizontal1->getLegendPosition());
     }

Here is the call graph for this function:

◆ testWithTitle()

ChartBarTest::testWithTitle ( )

Definition at line 143 of file ChartBarTest.php.

References Vendor\Package\$f, getFactory(), and getSimpleDataset().

                                    : void
     {
         $f = $this->getFactory();
 
         $dataset = $this->getSimpleDataset();
 
         $horizontal = $f->horizontal(
             "Horizontal Bar",
             $dataset
         );
         $horizontal1 = $horizontal->withTitle("Alternative title for Horizontal Bar");
 
         $this->assertEquals("Horizontal Bar", $horizontal->getTitle());
         $this->assertEquals("Alternative title for Horizontal Bar", $horizontal1->getTitle());
     }

Here is the call graph for this function:

◆ testWithTitleInvisible()

ChartBarTest::testWithTitleInvisible ( )

Definition at line 159 of file ChartBarTest.php.

References Vendor\Package\$f, getFactory(), and getSimpleDataset().

                                             : void
     {
         $f = $this->getFactory();
 
         $dataset = $this->getSimpleDataset();
 
         $horizontal = $f->horizontal(
             "Horizontal Bar",
             $dataset
         );
         $horizontal1 = $horizontal->withTitleVisible(false);
 
         $this->assertEquals(true, $horizontal->isTitleVisible());
         $this->assertEquals(false, $horizontal1->isTitleVisible());
     }

Here is the call graph for this function:

◆ testWithTooltipsInvisible()

ChartBarTest::testWithTooltipsInvisible ( )

Definition at line 175 of file ChartBarTest.php.

References Vendor\Package\$f, getFactory(), and getSimpleDataset().

                                                : void
     {
         $f = $this->getFactory();
 
         $dataset = $this->getSimpleDataset();
 
         $horizontal = $f->horizontal(
             "Horizontal Bar",
             $dataset
         );
         $horizontal1 = $horizontal->withTooltipsVisible(false);
 
         $this->assertEquals(true, $horizontal->isTooltipsVisible());
         $this->assertEquals(false, $horizontal1->isTooltipsVisible());
     }

Here is the call graph for this function:

The documentation for this class was generated from the following file:

tests/UI/Component/Chart/Bar/ChartBarTest.php

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ getDataFactory()

◆ getExtendedDataset()

◆ getFactory()

◆ getSimpleDataset()

◆ getUIFactory()

◆ testEmptyDataset()

◆ testGetInstances()

◆ testImplementsFactoryInterface()

◆ testIndexAxis()

◆ testRenderHorizontal()

◆ testRenderVertical()

◆ testWithBarConfigs()

◆ testWithDataset()

◆ testWithInvalidLegendPosition()

◆ testWithLegendInvisible()

◆ testWithLegendPosition()

◆ testWithTitle()

◆ testWithTitleInvisible()

◆ testWithTooltipsInvisible()