ILIAS\UI\URLBuilderTest Class Reference

Inheritance diagram for ILIAS\UI\URLBuilderTest:

Collaboration diagram for ILIAS\UI\URLBuilderTest:

Public Member Functions
	testGetUrl ()
	testAcquireParam ()
	testAcquireParamWithLongNamespace ()
	testAcquireParamWithValue ()
	testAcquireParamWithSameName ()
	testWriteParam ()
	testDeleteParam ()
	testUrlTooLong ()
	testRemoveAndAddFragment ()
	testWithUri ()
	testRenderTokens ()
	testRenderObject ()

Protected Member Functions
	setUp ()

Private Attributes
readonly ILIAS Data URI	$URI_COMPLETE

Detailed Description

Definition at line 25 of file URLBuilderTest.php.

Member Function Documentation

setUp()

ILIAS\UI\URLBuilderTest::setUp ( )

protected

Definition at line 29 of file URLBuilderTest.php.

                              : void
    {
        $this->URI_COMPLETE = new \ILIAS\Data\URI('https://www.ilias.de/foo/bar?var1=42&var2=foo#12345');
    }

testAcquireParam()

ILIAS\UI\URLBuilderTest::testAcquireParam

(

)

Definition at line 41 of file URLBuilderTest.php.

References $url, and ILIAS\UI\URLBuilder\SEPARATOR.

                                      : void
    {
        $url = new URLBuilder($this->URI_COMPLETE);
        $result = $url->acquireParameter(['test'], 'title');
        $this->assertInstanceOf(URLBuilder::class, $result[0]);
        $this->assertEquals(
            'https://www.ilias.de/foo/bar?var1=42&var2=foo&test' . URLBuilder::SEPARATOR . 'title=#12345',
            (string) $result[0]->buildURI()
        );
        $this->assertInstanceOf(URLBuilderToken::class, $result[1]);
        $this->assertEquals('test' . URLBuilder::SEPARATOR . 'title', $result[1]->getName());
        $this->assertNotEmpty($result[1]->getToken());
    }

testAcquireParamWithLongNamespace()

ILIAS\UI\URLBuilderTest::testAcquireParamWithLongNamespace

(

)

Definition at line 55 of file URLBuilderTest.php.

References $url, and ILIAS\UI\URLBuilder\SEPARATOR.

                                                       : void
    {
        $url = new URLBuilder($this->URI_COMPLETE);
        $result = $url->acquireParameter(['test', 'object', 'metadata'], 'title');
        $this->assertInstanceOf(URLBuilder::class, $result[0]);
        $this->assertEquals(
            'https://www.ilias.de/foo/bar?var1=42&var2=foo&test' . URLBuilder::SEPARATOR .
            'object' . URLBuilder::SEPARATOR .
            'metadata' . URLBuilder::SEPARATOR .
            'title=#12345',
            (string) $result[0]->buildURI()
        );
        $this->assertInstanceOf(URLBuilderToken::class, $result[1]);
        $this->assertEquals(
            'test' . URLBuilder::SEPARATOR .
            'object' . URLBuilder::SEPARATOR .
            'metadata' . URLBuilder::SEPARATOR .
            'title',
            $result[1]->getName()
        );
        $this->assertNotEmpty($result[1]->getToken());
    }

testAcquireParamWithSameName()

ILIAS\UI\URLBuilderTest::testAcquireParamWithSameName

(

)

Definition at line 93 of file URLBuilderTest.php.

References $url, and ILIAS\UI\URLBuilder\SEPARATOR.

                                                  : void
    {
        $url = new URLBuilder($this->URI_COMPLETE);
        $sep = URLBuilder::SEPARATOR;
        $result = $url->acquireParameter(['test'], 'title', 'foo');
        $this->assertEquals(
            'https://www.ilias.de/foo/bar?var1=42&var2=foo&test' . $sep . 'title=foo#12345',
            (string) $result[0]->buildURI()
        );
        $this->assertEquals('test' . $sep . 'title', $result[1]->getName());

        $result2 = $result[0]->acquireParameter(['notatest'], 'title', 'bar');
        $this->assertEquals(
            'https://www.ilias.de/foo/bar?var1=42&var2=foo&test' . $sep . 'title=foo&notatest' . $sep . 'title=bar#12345',
            (string) $result2[0]->buildURI()
        );
        $this->assertEquals('notatest' . $sep . 'title', $result2[1]->getName());
        $this->assertNotEquals($result[1]->getToken(), $result2[1]->getToken());
    }

testAcquireParamWithValue()

ILIAS\UI\URLBuilderTest::testAcquireParamWithValue

(

)

Definition at line 78 of file URLBuilderTest.php.

References $url, and ILIAS\UI\URLBuilder\SEPARATOR.

                                               : void
    {
        $url = new URLBuilder($this->URI_COMPLETE);
        $sep = URLBuilder::SEPARATOR;
        $result = $url->acquireParameter(['test'], 'title', 'bar');
        $this->assertInstanceOf(URLBuilder::class, $result[0]);
        $this->assertEquals(
            'https://www.ilias.de/foo/bar?var1=42&var2=foo&test' . $sep . 'title=bar#12345',
            (string) $result[0]->buildURI()
        );
        $this->assertInstanceOf(URLBuilderToken::class, $result[1]);
        $this->assertEquals('test' . $sep . 'title', $result[1]->getName());
        $this->assertNotEmpty($result[1]->getToken());
    }

testDeleteParam()

ILIAS\UI\URLBuilderTest::testDeleteParam

(

)

Definition at line 141 of file URLBuilderTest.php.

References $url, and ILIAS\UI\URLBuilder\SEPARATOR.

                                     : void
    {
        $url = new URLBuilder($this->URI_COMPLETE);
        $sep = URLBuilder::SEPARATOR;
        $result = $url->acquireParameter(['test'], 'title', 'bar');
        $this->assertEquals(
            'https://www.ilias.de/foo/bar?var1=42&var2=foo&test' . $sep . 'title=bar#12345',
            (string) $result[0]->buildURI()
        );

        $url = $result[0]->deleteParameter($result[1]);
        $this->assertEquals('https://www.ilias.de/foo/bar?var1=42&var2=foo#12345', (string) $url->buildURI());
    }

testGetUrl()

ILIAS\UI\URLBuilderTest::testGetUrl

(

)

Definition at line 34 of file URLBuilderTest.php.

References $url.

                                : void
    {
        $url = new URLBuilder($this->URI_COMPLETE);
        $this->assertInstanceOf(\ILIAS\Data\URI::class, $url->buildURI());
        $this->assertEquals('https://www.ilias.de/foo/bar?var1=42&var2=foo#12345', (string) $url->buildURI());
    }

testRemoveAndAddFragment()

ILIAS\UI\URLBuilderTest::testRemoveAndAddFragment

(

)

Definition at line 163 of file URLBuilderTest.php.

References $url, and null.

                                              : void
    {
        $url = new URLBuilder($this->URI_COMPLETE);
        $url = $url->withFragment(''); // set fragment to empty
        $this->assertInstanceOf(URLBuilder::class, $url);
        $this->assertEquals('https://www.ilias.de/foo/bar?var1=42&var2=foo', (string) $url->buildURI());
        $url = $url->withFragment(null); // unset fragment, use fragment from base URL if present
        $this->assertInstanceOf(URLBuilder::class, $url);
        $this->assertEquals('https://www.ilias.de/foo/bar?var1=42&var2=foo#12345', (string) $url->buildURI());
        $url = $url->withFragment('54321'); // set fragment to value
        $this->assertInstanceOf(URLBuilder::class, $url);
        $this->assertEquals('https://www.ilias.de/foo/bar?var1=42&var2=foo#54321', (string) $url->buildURI());
    }

testRenderObject()

ILIAS\UI\URLBuilderTest::testRenderObject

(

)

Definition at line 214 of file URLBuilderTest.php.

References $url, and ILIAS\UI\URLBuilder\SEPARATOR.

                                      : void
    {
        $url = new URLBuilder($this->URI_COMPLETE);

        // One parameter
        $result1 = $url->acquireParameter(['test', 'object'], 'title', 'bar');
        $url = $result1[0];
        $expected_token = 'new Map([["' . $result1[1]->getName() . '",'
            . 'new il.UI.core.URLBuilderToken(["test","object"], "title", "' . $result1[1]->getToken() . '")]])';
        $expected_object = 'new il.UI.core.URLBuilder(new URL("https://www.ilias.de/foo/bar?var1=42&var2=foo&'
            . 'test' . URLBuilder::SEPARATOR . 'object' . URLBuilder::SEPARATOR . 'title=bar#12345"), ' . $expected_token . ')';
        $this->assertEquals($expected_object, $url->renderObject([$result1[1]]));

        // Two parameters, but just rendered with one
        $result2 = $url->acquireParameter(['test'], 'description', 'foo');
        $url = $result2[0];
        $expected_object = 'new il.UI.core.URLBuilder(new URL("https://www.ilias.de/foo/bar?var1=42&var2=foo&'
            . 'test' . URLBuilder::SEPARATOR . 'object' . URLBuilder::SEPARATOR . 'title=bar&'
            . 'test' . URLBuilder::SEPARATOR . 'description=foo#12345"), ' . $expected_token . ')';
        $this->assertEquals($expected_object, $url->renderObject([$result1[1]]));

        // Two parameters with full render
        $expected_token = 'new Map([["' . $result1[1]->getName() . '",'
            . 'new il.UI.core.URLBuilderToken(["test","object"], "title", "' . $result1[1]->getToken() . '")],'
            . '["' . $result2[1]->getName() . '",'
            . 'new il.UI.core.URLBuilderToken(["test"], "description", "' . $result2[1]->getToken() . '")]])';
        $expected_object = 'new il.UI.core.URLBuilder(new URL("https://www.ilias.de/foo/bar?var1=42&var2=foo&'
            . 'test' . URLBuilder::SEPARATOR . 'object' . URLBuilder::SEPARATOR . 'title=bar&'
            . 'test' . URLBuilder::SEPARATOR . 'description=foo#12345"), ' . $expected_token . ')';
        $this->assertEquals($expected_object, $url->renderObject([$result1[1], $result2[1]]));
    }

testRenderTokens()

ILIAS\UI\URLBuilderTest::testRenderTokens

(

)

Definition at line 190 of file URLBuilderTest.php.

References $url.

                                      : void
    {
        $url = new URLBuilder($this->URI_COMPLETE);

        // One parameter
        $result1 = $url->acquireParameter(['test', 'object'], 'title', 'bar');
        $url = $result1[0];
        $expected_token = 'new Map([["' . $result1[1]->getName() . '",'
            . 'new il.UI.core.URLBuilderToken(["test","object"], "title", "' . $result1[1]->getToken() . '")]])';
        $this->assertEquals($expected_token, $url->renderTokens([$result1[1]]));

        // Two parameters, but just rendered with one
        $result2 = $url->acquireParameter(['test'], 'description', 'foo');
        $url = $result2[0];
        $this->assertEquals($expected_token, $url->renderTokens([$result1[1]]));

        // Two parameters with full render
        $expected_token = 'new Map([["' . $result1[1]->getName() . '",'
            . 'new il.UI.core.URLBuilderToken(["test","object"], "title", "' . $result1[1]->getToken() . '")],'
            . '["' . $result2[1]->getName() . '",'
            . 'new il.UI.core.URLBuilderToken(["test"], "description", "' . $result2[1]->getToken() . '")]])';
        $this->assertEquals($expected_token, $url->renderTokens([$result1[1], $result2[1]]));
    }

testUrlTooLong()

ILIAS\UI\URLBuilderTest::testUrlTooLong

(

)

Definition at line 155 of file URLBuilderTest.php.

References $url, and ILIAS\UI\URLBuilder\URL_MAX_LENGTH.

                                    : void
    {
        $url = new URLBuilder($this->URI_COMPLETE);
        $result = $url->acquireParameter(['test'], 'title', random_bytes(URLBuilder::URL_MAX_LENGTH));
        $this->expectException(\LengthException::class);
        $output = $result[0]->buildURI();
    }

testWithUri()

ILIAS\UI\URLBuilderTest::testWithUri

(

)

Definition at line 177 of file URLBuilderTest.php.

References $url, and ILIAS\UI\URLBuilder\SEPARATOR.

                                 : void
    {
        $url = new URLBuilder($this->URI_COMPLETE);
        $result = $url->acquireParameter(['test'], 'title', 'bar');
        $url = $result[0]->withURI(
            new \ILIAS\Data\URI('http://test.ilias.de/bar/foo?test' . URLBuilder::SEPARATOR . 'title=foo&var1=46#12345')
        );
        $this->assertEquals(
            'http://test.ilias.de/bar/foo?test' . URLBuilder::SEPARATOR . 'title=bar&var1=46#12345',
            (string) $url->buildURI()
        );
    }

testWriteParam()

ILIAS\UI\URLBuilderTest::testWriteParam

(

)

Definition at line 113 of file URLBuilderTest.php.

References $url, and ILIAS\UI\URLBuilder\SEPARATOR.

                                    : void
    {
        $url = new URLBuilder($this->URI_COMPLETE);
        $sep = URLBuilder::SEPARATOR;
        $result = $url->acquireParameter(['test'], 'title', 'bar');
        $this->assertEquals(
            'https://www.ilias.de/foo/bar?var1=42&var2=foo&test' . $sep . 'title=bar#12345',
            (string) $result[0]->buildURI()
        );

        $url = $result[0]->withParameter($result[1], 'foobar');
        $this->assertInstanceOf(URLBuilder::class, $url);
        $this->assertEquals(
            'https://www.ilias.de/foo/bar?var1=42&var2=foo&test' . $sep . 'title=foobar#12345',
            (string) $url->buildURI()
        );

        $url = $result[0]->withParameter($result[1], ['foo', 'bar']);
        $this->assertInstanceOf(URLBuilder::class, $url);
        $this->assertEquals(
            'https://www.ilias.de/foo/bar?var1=42&var2=foo'
                . '&test' . $sep . urlencode('title[]') . '=foo'
                . '&test' . $sep . urlencode('title[]') . '=bar'
                . '#12345',
            (string) $url->buildURI()
        );
    }

Field Documentation

$URI_COMPLETE

readonly ILIAS Data URI ILIAS\UI\URLBuilderTest::$URI_COMPLETE

private

Definition at line 27 of file URLBuilderTest.php.

---

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

• components/ILIAS/UI/tests/URLBuilderTest.php