Test on avatar implementation. More...

Inheritance diagram for AvatarTest:

Collaboration diagram for AvatarTest:

Public Member Functions
	testConstruction ()

	testAbbreviation ()

	testUsername ()

	testPicturePath ()

	testColorVariant ()

	testCrc32 ()

	testAlternativeText ()

	testRenderingLetter ()

	testRenderingPicture ()

	testRenderingPictureWithSomeAlternativeText ()

	getRandom26StringsForAllColorVariants (int $color_variants=26, int $length=2)

Public Member Functions inherited from ILIAS_UI_TestBase
	setUp ()

	tearDown ()

	getUIFactory ()

	getTemplateFactory ()

	getResourceRegistry ()

	getLanguage ()

	getJavaScriptBinding ()

	getRefinery ()

	getImagePathResolver ()

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

	getDecoratedRenderer (Renderer $default)

	normalizeHTML ($html)

	assertHTMLEquals ($expected_html_as_string, $html_as_string)

Protected Attributes
const	ICON_PATH = __DIR__ . "/../../../../../templates/default/images/"

Private Member Functions
	getAvatarFactory ()

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

Detailed Description

Test on avatar implementation.

Definition at line 12 of file AvatarTest.php.

Member Function Documentation

◆ getAvatarFactory()

AvatarTest::getAvatarFactory ( )

private

Definition at line 16 of file AvatarTest.php.

                                        : Factory
    {
        return new I\Component\Symbol\Avatar\Factory();
    }

Referenced by testAbbreviation(), testAlternativeText(), testColorVariant(), testConstruction(), testCrc32(), testPicturePath(), testRenderingLetter(), testRenderingPicture(), testRenderingPictureWithSomeAlternativeText(), and testUsername().

Here is the caller graph for this function:

◆ getRandom26StringsForAllColorVariants()

AvatarTest::getRandom26StringsForAllColorVariants	(	int	$color_variants = `26`,
		int	$length = `2`
	)

Parameters

int	$color_variants
int	$length

Returns: Generator|Closure

Definition at line 181 of file AvatarTest.php.

                                                                                                     : Generator
    {
        $sh = static function ($length = 10) {
            return substr(str_shuffle(str_repeat($x = 'abcdefghijklmnopqrstuvwxyz', (int) ceil($length / strlen($x)))), 1, $length);
        };
 
        $strings = [];
        $running = true;
        while ($running) {
            $str = $sh($length);
            $probe = crc32($str);
            $i = ($probe % $color_variants) + 1;
            if (!in_array($i, $strings, true)) {
                $strings[$i] = $str;
                yield $i => $str;
            }
            if (count($strings) === $color_variants) {
                $running = false;
            }
        }
    }

References $i.

Referenced by testCrc32().

Here is the caller graph for this function:

◆ testAbbreviation()

AvatarTest::testAbbreviation ( )

Definition at line 33 of file AvatarTest.php.

                                       : void
    {
        $f = $this->getAvatarFactory();
 
        $this->assertEquals('ro', $f->letter('ro')->getAbbreviation());
        $this->assertEquals('ro', $f->letter('root')->getAbbreviation());
        $this->assertEquals('Ro', $f->letter('Root')->getAbbreviation());
        $this->assertEquals('RO', $f->letter('ROOT')->getAbbreviation());
    }

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

Here is the call graph for this function:

◆ testAlternativeText()

AvatarTest::testAlternativeText ( )

Definition at line 120 of file AvatarTest.php.

                                          : void
    {
        $f = $this->getAvatarFactory();
        $this->assertEquals("", $f->picture('', 'ro')->getAlternativeText());
        $this->assertEquals("", $f->letter('', 'ro')->getAlternativeText());
        $this->assertEquals("alternative", $f->picture('', 'ro')
                                             ->withAlternativeText("alternative")
                                             ->getAlternativeText());
        $this->assertEquals("alternative", $f->letter('', 'ro')
                                             ->withAlternativeText("alternative")
                                             ->getAlternativeText());
    }

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

Here is the call graph for this function:

◆ testColorVariant()

AvatarTest::testColorVariant ( )

Definition at line 65 of file AvatarTest.php.

                                       : void
    {
        $f = $this->getAvatarFactory();
 
        // Test all 26 colors
        $variants = array(
            1 => 'om',
            2 => 'gk',
            3 => 'bj',
            4 => 'ea',
            5 => 'mf',
            6 => 'ob',
            7 => 'bi',
            8 => 'hu',
            9 => 'fa',
            10 => 'so',
            11 => 'il',
            12 => 'ut',
            13 => 'ur',
            14 => 'lt',
            15 => 'kg',
            16 => 'jl',
            17 => 'qb',
            18 => 'rq',
            19 => 'ot',
            20 => 'cq',
            21 => 'rm',
            22 => 'aj',
            23 => 'li',
            24 => 'er',
            25 => 'ui',
            26 => 'mi',
        );
        foreach ($variants as $color => $variant) {
            $this->assertEquals($color, $f->letter($variant)->getBackgroundColorVariant());
        }
    }

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

Here is the call graph for this function:

◆ testConstruction()

AvatarTest::testConstruction ( )

Definition at line 21 of file AvatarTest.php.

                                       : void
    {
        $f = $this->getAvatarFactory();
        $this->assertInstanceOf("ILIAS\\UI\\Component\\Symbol\\Avatar\\Factory", $f);
 
        $le = $f->letter('ru');
        $this->assertInstanceOf("ILIAS\\UI\\Component\\Symbol\\Avatar\\Letter", $le);
 
        $ci = $f->picture(self::ICON_PATH . 'no_photo_xsmall.jpg', 'ru');
        $this->assertInstanceOf("ILIAS\\UI\\Component\\Symbol\\Avatar\\Picture", $ci);
    }

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

Here is the call graph for this function:

◆ testCrc32()

AvatarTest::testCrc32 ( )

Definition at line 103 of file AvatarTest.php.

    {
        // test mechanism (crc32)
        $f = $this->getAvatarFactory();
        $number_of_colors = 26;
        $abb = 'ru';
 
        $calculated_color_variant = (crc32($abb) % $number_of_colors) + 1; // plus 1 since colors start with 1
        $this->assertEquals($calculated_color_variant, $f->letter($abb)->getBackgroundColorVariant());
 
        // test with random abbreviations (dynamically generated)
 
        foreach ($this->getRandom26StringsForAllColorVariants() as $color => $variant) {
            $this->assertEquals($color, $f->letter($variant)->getBackgroundColorVariant());
        }
    }

References Vendor\Package\$f, getAvatarFactory(), and getRandom26StringsForAllColorVariants().

Here is the call graph for this function:

◆ testPicturePath()

AvatarTest::testPicturePath ( )

Definition at line 57 of file AvatarTest.php.

                                      : void
    {
        $f = $this->getAvatarFactory();
 
        $str = '/path/to/picture.jpg';
        $this->assertEquals($str, $f->picture($str, 'ro')->getPicturePath());
    }

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

Here is the call graph for this function:

◆ testRenderingLetter()

AvatarTest::testRenderingLetter ( )

Definition at line 133 of file AvatarTest.php.

    {
        $f = $this->getAvatarFactory();
        $r = $this->getDefaultRenderer();
 
        $letter = $f->letter('ro');
        $html = $this->brutallyTrimHTML($r->render($letter));
        $expected = $this->brutallyTrimHTML('
<span class="il-avatar il-avatar-letter il-avatar-size-large il-avatar-letter-color-1" aria-label="user_avatar" role="img">     
    <span class="abbreviation">ro</span>
</span>');
        $this->assertEquals($expected, $html);
    }

References Vendor\Package\$f, ILIAS_UI_TestBase\brutallyTrimHTML(), getAvatarFactory(), and ILIAS_UI_TestBase\getDefaultRenderer().

Here is the call graph for this function:

◆ testRenderingPicture()

AvatarTest::testRenderingPicture ( )

Definition at line 147 of file AvatarTest.php.

    {
        $f = $this->getAvatarFactory();
        $r = $this->getDefaultRenderer();
 
        $str = '/path/to/picture.jpg';
        $letter = $f->picture($str, 'ro');
        $html = $this->brutallyTrimHTML($r->render($letter));
        $expected = $this->brutallyTrimHTML('
<span class="il-avatar il-avatar-picture il-avatar-size-large"> 
    <img src="/path/to/picture.jpg" alt="user_avatar"/>
</span>');
        $this->assertEquals($expected, $html);
    }

References Vendor\Package\$f, ILIAS_UI_TestBase\brutallyTrimHTML(), getAvatarFactory(), and ILIAS_UI_TestBase\getDefaultRenderer().

Here is the call graph for this function:

◆ testRenderingPictureWithSomeAlternativeText()

AvatarTest::testRenderingPictureWithSomeAlternativeText ( )

Definition at line 162 of file AvatarTest.php.

    {
        $f = $this->getAvatarFactory();
        $r = $this->getDefaultRenderer();
 
        $str = '/path/to/picture.jpg';
        $letter = $f->picture($str, 'ro')->withAlternativeText("alternative");
        $html = $this->brutallyTrimHTML($r->render($letter));
        $expected = $this->brutallyTrimHTML('
<span class="il-avatar il-avatar-picture il-avatar-size-large"> 
    <img src="/path/to/picture.jpg" alt="alternative"/>
</span>');
        $this->assertEquals($expected, $html);
    }

References Vendor\Package\$f, ILIAS_UI_TestBase\brutallyTrimHTML(), getAvatarFactory(), and ILIAS_UI_TestBase\getDefaultRenderer().

Here is the call graph for this function:

◆ testUsername()

AvatarTest::testUsername ( )

Definition at line 43 of file AvatarTest.php.

                                   : void
    {
        $f = $this->getAvatarFactory();
 
        $this->assertEquals('ro', $f->letter('ro')->getUsername());
        $this->assertEquals('ro', $f->picture('', 'ro')->getUsername());
        $this->assertEquals('root', $f->letter('root')->getUsername());
        $this->assertEquals('root', $f->picture('', 'root')->getUsername());
        $this->assertEquals('Root', $f->letter('Root')->getUsername());
        $this->assertEquals('Root', $f->picture('', 'Root')->getUsername());
        $this->assertEquals('ROOT', $f->letter('ROOT')->getUsername());
        $this->assertEquals('ROOT', $f->picture('', 'ROOT')->getUsername());
    }

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

Here is the call graph for this function:

Field Documentation

◆ ICON_PATH

const AvatarTest::ICON_PATH = __DIR__ . "/../../../../../templates/default/images/"

protected

Definition at line 14 of file AvatarTest.php.

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

tests/UI/Component/Symbol/Avatar/AvatarTest.php

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getAvatarFactory()

◆ getRandom26StringsForAllColorVariants()

◆ testAbbreviation()

◆ testAlternativeText()

◆ testColorVariant()

◆ testConstruction()

◆ testCrc32()

◆ testPicturePath()

◆ testRenderingLetter()

◆ testRenderingPicture()

◆ testRenderingPictureWithSomeAlternativeText()

◆ testUsername()

Field Documentation

◆ ICON_PATH