MarkdownTest Class Reference

Inheritance diagram for MarkdownTest:

Collaboration diagram for MarkdownTest:

Public Member Functions
	setUp ()
	getUIFactory ()
	The rendering of this input requires actual or minimal instances of: More...
	testRender ()
	testRenderWithByline ()
	testRenderWithLimits ()
	testRenderWithDisabled ()
	testRenderWithRequired ()
	testRenderWithError ()

Protected Member Functions
	getRendererWithStubs ()
	buildMinimalFieldFactory ()
	buildButtonFactory ()
	getMarkdownRendererMock ()
	getSymbolFactoryMock ()
	getViewControlFactoryMock ()
	getViewControlModeStub ()
	getGlyphStub (string $name)

Protected Attributes
const	TEST_ASYNC_URL = 'https://localhost'
const	TEST_PARAMETER_NAME = 'preview'
MarkdownRenderer	$markdown_renderer
DefNamesource	$name_source
FieldFactory	$factory
ViewControlMode	$view_control_mock
Glyph	$numberedlist_glyph_mock
Glyph	$bulledpoint_glyph_mock
Glyph	$header_glyph_mock
Glyph	$italic_glyph_mock
Glyph	$link_glyph_mock
Glyph	$bold_glyph_mock

Detailed Description

Author

Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns

Definition at line 44 of file MarkdownTest.php.

Member Function Documentation

buildButtonFactory()

MarkdownTest::buildButtonFactory ( )

protected

Definition at line 491 of file MarkdownTest.php.

Referenced by getUIFactory().

                                           : ButtonFactory
    {
        return new ButtonFactory();
    }

Here is the caller graph for this function:

buildMinimalFieldFactory()

MarkdownTest::buildMinimalFieldFactory ( )

protected

Definition at line 480 of file MarkdownTest.php.

References getLanguage().

Referenced by setUp().

                                                 : FieldFactory
    {
        return new FieldFactory(
            $this->createMock(UploadLimitResolver::class),
            new SignalGenerator(),
            $this->createMock(DataFactory::class),
            $this->createMock(Refinery::class),
            $this->getLanguage()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getGlyphStub()

MarkdownTest::getGlyphStub ( string  $name )

protected

Definition at line 542 of file MarkdownTest.php.

Referenced by setUp().

                                                 : Glyph
    {
        $glyph = $this->createMock(Glyph::class);
        $glyph->method('getCanonicalName')->willReturn($name);
        // will be called in the rendering process of this input.
        $glyph->method('withUnavailableAction')->willReturnSelf();

        return $glyph;
    }

Here is the caller graph for this function:

getMarkdownRendererMock()

MarkdownTest::getMarkdownRendererMock ( )

protected

Definition at line 496 of file MarkdownTest.php.

References $markdown_renderer.

Referenced by setUp().

                                                : MarkdownRenderer
    {
        $markdown_renderer = $this->createMock(MarkdownRenderer::class);
        $markdown_renderer->method('getAsyncUrl')->willReturn(self::TEST_ASYNC_URL);
        $markdown_renderer->method('getParameterName')->willReturn(self::TEST_PARAMETER_NAME);
        $markdown_renderer->method('render')->willReturnCallback(
            static function ($value) {
                return $value;
            }
        );

        return $markdown_renderer;
    }

Here is the caller graph for this function:

getRendererWithStubs()

MarkdownTest::getRendererWithStubs ( )

protected

Definition at line 467 of file MarkdownTest.php.

References null.

Referenced by testRender(), testRenderWithByline(), testRenderWithDisabled(), testRenderWithError(), testRenderWithLimits(), and testRenderWithRequired().

                                             : TestDefaultRenderer
    {
        return $this->getDefaultRenderer(null, [
            $this->view_control_mock,
            $this->header_glyph_mock,
            $this->italic_glyph_mock,
            $this->bold_glyph_mock,
            $this->link_glyph_mock,
            $this->numberedlist_glyph_mock,
            $this->bulledpoint_glyph_mock,
        ]);
    }

Here is the caller graph for this function:

getSymbolFactoryMock()

MarkdownTest::getSymbolFactoryMock ( )

protected

Definition at line 510 of file MarkdownTest.php.

Referenced by getUIFactory().

                                             : SymbolFactory
    {
        $glyph_factory = $this->createMock(GlyphFactory::class);
        $glyph_factory->method('header')->willReturn($this->header_glyph_mock);
        $glyph_factory->method('italic')->willReturn($this->italic_glyph_mock);
        $glyph_factory->method('bold')->willReturn($this->bold_glyph_mock);
        $glyph_factory->method('link')->willReturn($this->link_glyph_mock);
        $glyph_factory->method('numberedlist')->willReturn($this->numberedlist_glyph_mock);
        $glyph_factory->method('bulletlist')->willReturn($this->bulledpoint_glyph_mock);

        $symbol_factory = $this->createMock(SymbolFactory::class);
        $symbol_factory->method('glyph')->willReturn($glyph_factory);

        return $symbol_factory;
    }

Here is the caller graph for this function:

getUIFactory()

MarkdownTest::getUIFactory

(

)

The rendering of this input requires actual or minimal instances of:

• ViewControlFactory
• ButtonFactory
• SymbolFactory

See also

ILIAS_UI_TestBase::getDefaultRenderer()

Definition at line 86 of file MarkdownTest.php.

References ILIAS\GlobalScreen\Provider\__construct(), buildButtonFactory(), ILIAS\Repository\button(), getSymbolFactoryMock(), getViewControlFactoryMock(), and ILIAS\Repository\symbol().

                                  : NoUIFactory
    {
        return new class (
            $this->getViewControlFactoryMock(),
            $this->buildButtonFactory(),
            $this->getSymbolFactoryMock(),
        ) extends NoUIFactory {
            protected ViewControlFactory $view_control_factory;
            protected ButtonFactory $button_factory;
            protected SymbolFactory $symbol_factory;

            public function __construct(
                ViewControlFactory $view_control_factory,
                ButtonFactory $button_factory,
                SymbolFactory $symbol_factory,
            ) {
                $this->view_control_factory = $view_control_factory;
                $this->button_factory = $button_factory;
                $this->symbol_factory = $symbol_factory;
            }

            public function viewControl(): ViewControlFactory
            {
                return $this->view_control_factory;
            }

            public function button(): ButtonFactory
            {
                return $this->button_factory;
            }

            public function symbol(): SymbolFactory
            {
                return $this->symbol_factory;
            }
        };
    }

Here is the call graph for this function:

getViewControlFactoryMock()

MarkdownTest::getViewControlFactoryMock ( )

protected

Definition at line 526 of file MarkdownTest.php.

References getViewControlModeStub().

Referenced by getUIFactory().

                                                  : ViewControlFactory
    {
        $view_control_factory = $this->createMock(ViewControlFactory::class);
        $view_control_factory->method('mode')->willReturn($this->getViewControlModeStub());

        return $view_control_factory;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getViewControlModeStub()

MarkdownTest::getViewControlModeStub ( )

protected

Definition at line 534 of file MarkdownTest.php.

Referenced by getViewControlFactoryMock(), and setUp().

                                               : ViewControlMode
    {
        $view_control = $this->createMock(ViewControlMode::class);
        $view_control->method('getCanonicalName')->willReturn('view_control_mode');

        return $view_control;
    }

Here is the caller graph for this function:

setUp()

MarkdownTest::setUp

(

)

Definition at line 61 of file MarkdownTest.php.

References buildMinimalFieldFactory(), factory(), getGlyphStub(), getMarkdownRendererMock(), and getViewControlModeStub().

                           : void
    {
        $this->markdown_renderer = $this->getMarkdownRendererMock();
        $this->factory = $this->buildMinimalFieldFactory();
        $this->name_source = new DefNamesource();

        $this->view_control_mock = $this->getViewControlModeStub();
        $this->numberedlist_glyph_mock = $this->getGlyphStub('numberedlist');
        $this->bulledpoint_glyph_mock = $this->getGlyphStub('bulletpoint');
        $this->header_glyph_mock = $this->getGlyphStub('header');
        $this->italic_glyph_mock = $this->getGlyphStub('italic');
        $this->link_glyph_mock = $this->getGlyphStub('link');
        $this->bold_glyph_mock = $this->getGlyphStub('bold');

        parent::setUp();
    }

Here is the call graph for this function:

testRender()

MarkdownTest::testRender

(

)

Definition at line 124 of file MarkdownTest.php.

References factory(), and getRendererWithStubs().

                                : void
    {
        $label = 'test_label';

        $input = $this->factory->markdown($this->markdown_renderer, $label)->withNameFrom($this->name_source);

        $expected = $this->brutallyTrimHTML(
            "
            <fieldset class=\"c-input\" data-il-ui-component=\"markdown-field-input\" data-il-ui-input-name=\"name_0\" id=\"id_8\" tabindex=\"0\">
                <label>$label</label>
                <div class=\"c-input__field\">

                    <div class=\"c-field-markdown\">
                        <div class=\"c-field-markdown__controls\">
                            view_control_mode
                            <div class=\"c-field-markdown__actions\">
                                <span data-action=\"insert-heading\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_2\">header</button>
                                </span>
                                <span data-action=\"insert-link\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_3\">link</button>
                                </span>
                                <span data-action=\"insert-bold\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_4\">bold</button>
                                </span>
                                <span data-action=\"insert-italic\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_5\">italic</button>
                                </span>
                                <span data-action=\"insert-bullet-points\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_7\">bulletpoint</button>
                                </span>
                                <span data-action=\"insert-enumeration\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_6\">numberedlist</button>
                                </span>
                            </div>
                        </div>
                             <textarea id=\"id_1\" class=\"c-field-textarea\" name=\"name_0\"></textarea>
                        <div class=\"c-field-markdown__preview hidden\">
                        </div>
                    </div>

                </div>
            </fieldset>
            "
        );

        $html = $this->brutallyTrimHTML($this->getRendererWithStubs()->render($input));
        $this->assertEquals($expected, $html);
    }

Here is the call graph for this function:

testRenderWithByline()

MarkdownTest::testRenderWithByline

(

)

Definition at line 174 of file MarkdownTest.php.

References factory(), and getRendererWithStubs().

                                          : void
    {
        $label = 'test_label';
        $byline = 'test_byline';

        $input = $this->factory->markdown(
            $this->markdown_renderer,
            $label,
            $byline
        )->withNameFrom($this->name_source);

        $expected = $this->brutallyTrimHTML(
            "
            <fieldset class=\"c-input\" data-il-ui-component=\"markdown-field-input\" data-il-ui-input-name=\"name_0\" id=\"id_8\" tabindex=\"0\">
                <label>$label</label>
                <div class=\"c-input__field\">

                    <div class=\"c-field-markdown\">
                        <div class=\"c-field-markdown__controls\">
                            view_control_mode
                            <div class=\"c-field-markdown__actions\">
                                <span data-action=\"insert-heading\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_2\">header</button>
                                </span>
                                <span data-action=\"insert-link\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_3\">link</button>
                                </span>
                                <span data-action=\"insert-bold\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_4\">bold</button>
                                </span>
                                <span data-action=\"insert-italic\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_5\">italic</button>
                                </span>
                                <span data-action=\"insert-bullet-points\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_7\">bulletpoint</button>
                                </span>
                                <span data-action=\"insert-enumeration\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_6\">numberedlist</button>
                                </span>
                            </div>
                        </div>

                             <textarea id=\"id_1\" class=\"c-field-textarea\" name=\"name_0\"></textarea>
                        
                        <div class=\"c-field-markdown__preview hidden\">
                        </div>

                    </div>
                
                </div>
                <div class=\"c-input__help-byline\">$byline</div>
            </fieldset>
        "
        );

        $html = $this->brutallyTrimHTML($this->getRendererWithStubs()->render($input));

        $this->assertEquals($expected, $html);
    }

Here is the call graph for this function:

testRenderWithDisabled()

MarkdownTest::testRenderWithDisabled

(

)

Definition at line 294 of file MarkdownTest.php.

References factory(), and getRendererWithStubs().

                                            : void
    {
        $label = 'test_label';
        $byline = 'test_byline';

        $input = $this->factory->markdown(
            $this->markdown_renderer,
            $label,
            $byline
        )->withDisabled(true)->withNameFrom($this->name_source);

        $expected = $this->brutallyTrimHTML(
            "
            <fieldset class=\"c-input\" data-il-ui-component=\"markdown-field-input\" data-il-ui-input-name=\"name_0\" disabled=\"disabled\" id=\"id_2\" tabindex=\"0\">
                <label>$label</label>
                <div class=\"c-input__field\">

                    <div class=\"c-field-markdown\">
                        <div class=\"c-field-markdown__controls\">
                            view_control_mode
                            <div class=\"c-field-markdown__actions\">
                                <span data-action=\"insert-heading\">
                                    <button class=\"btn btn-default\" data-action=\"#\" disabled=\"disabled\">header</button>
                                </span>
                                <span data-action=\"insert-link\">
                                    <button class=\"btn btn-default\" data-action=\"#\" disabled=\"disabled\">link</button>
                                </span>
                                <span data-action=\"insert-bold\">
                                    <button class=\"btn btn-default\" data-action=\"#\" disabled=\"disabled\">bold</button>
                                </span>
                                <span data-action=\"insert-italic\">
                                    <button class=\"btn btn-default\" data-action=\"#\" disabled=\"disabled\">italic</button>
                                </span>
                                <span data-action=\"insert-bullet-points\">
                                    <button class=\"btn btn-default\" data-action=\"#\" disabled=\"disabled\">bulletpoint</button>
                                </span>
                                <span data-action=\"insert-enumeration\">
                                    <button class=\"btn btn-default\" data-action=\"#\" disabled=\"disabled\">numberedlist</button>
                                </span>
                            </div>
                        </div>
                             <textarea id=\"id_1\" class=\"c-field-textarea\" name=\"name_0\"></textarea>
                        <div class=\"c-field-markdown__preview hidden\">
                        </div>
                    </div>

                </div>
                <div class=\"c-input__help-byline\">$byline</div>
            </fieldset>
            "
        );

        $html = $this->brutallyTrimHTML($this->getRendererWithStubs()->render($input));

        $this->assertEquals($expected, $html);
    }

Here is the call graph for this function:

testRenderWithError()

MarkdownTest::testRenderWithError

(

)

Definition at line 408 of file MarkdownTest.php.

References factory(), and getRendererWithStubs().

                                         : void
    {
        $label = 'test_label';
        $byline = 'test_byline';
        $error = 'test_error';

        $input = $this->factory->markdown(
            $this->markdown_renderer,
            $label,
            $byline
        )->withError($error)->withNameFrom($this->name_source);

        $expected = $this->brutallyTrimHTML(
            "
            <fieldset class=\"c-input\" data-il-ui-component=\"markdown-field-input\" data-il-ui-input-name=\"name_0\" aria-describedby=\"id_9\" id=\"id_8\" tabindex=\"0\">
                <label>$label</label>
                <div class=\"c-input__field\">

                        <div class=\"c-field-markdown\">
                            <div class=\"c-field-markdown__controls\">
                                view_control_mode
                                <div class=\"c-field-markdown__actions\">
                                    <span data-action=\"insert-heading\">
                                        <button class=\"btn btn-default\" data-action=\"#\" id=\"id_2\">header</button>
                                    </span>
                                    <span data-action=\"insert-link\">
                                        <button class=\"btn btn-default\" data-action=\"#\" id=\"id_3\">link</button>
                                    </span>
                                    <span data-action=\"insert-bold\">
                                        <button class=\"btn btn-default\" data-action=\"#\" id=\"id_4\">bold</button>
                                    </span>
                                    <span data-action=\"insert-italic\">
                                        <button class=\"btn btn-default\" data-action=\"#\" id=\"id_5\">italic</button>
                                    </span>
                                    <span data-action=\"insert-bullet-points\">
                                        <button class=\"btn btn-default\" data-action=\"#\" id=\"id_7\">bulletpoint</button>
                                    </span>
                                    <span data-action=\"insert-enumeration\">
                                        <button class=\"btn btn-default\" data-action=\"#\" id=\"id_6\">numberedlist</button>
                                    </span>
                                </div>
                            </div>
                                 <textarea id=\"id_1\" class=\"c-field-textarea\" name=\"name_0\"></textarea>
                        <div class=\"c-field-markdown__preview hidden\">
                        </div>
                    </div>

                </div>
                <div class=\"c-input__error-msg alert alert-danger\" id=\"id_9\"><span class=\"sr-only\">ui_error:</span>$error</div>
                <div class=\"c-input__help-byline\">$byline</div>
            </fieldset>
            "
        );

        $html = $this->brutallyTrimHTML($this->getRendererWithStubs()->render($input));

        $this->assertEquals($expected, $html);
    }

Here is the call graph for this function:

testRenderWithLimits()

MarkdownTest::testRenderWithLimits

(

)

Definition at line 234 of file MarkdownTest.php.

References factory(), and getRendererWithStubs().

                                          : void
    {
        $label = 'test_label';
        $byline = 'test_byline';
        $min = 1;
        $max = 9;

        $input = $this->factory->markdown(
            $this->markdown_renderer,
            $label,
            $byline
        )->withMinLimit($min)->withMaxLimit($max)->withNameFrom($this->name_source);

        $expected = $this->brutallyTrimHTML(
            "
            <fieldset class=\"c-input\" data-il-ui-component=\"markdown-field-input\" data-il-ui-input-name=\"name_0\" id=\"id_8\" tabindex=\"0\">
                <label>$label</label>
                <div class=\"c-input__field\">

                    <div class=\"c-field-markdown\">
                        <div class=\"c-field-markdown__controls\">
                            view_control_mode
                            <div class=\"c-field-markdown__actions\">
                                <span data-action=\"insert-heading\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_2\">header</button>
                                </span>
                                <span data-action=\"insert-link\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_3\">link</button>
                                </span>
                                <span data-action=\"insert-bold\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_4\">bold</button>
                                </span>
                                <span data-action=\"insert-italic\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_5\">italic</button>
                                </span>
                                <span data-action=\"insert-bullet-points\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_7\">bulletpoint</button>
                                </span>
                                <span data-action=\"insert-enumeration\">
                                    <button class=\"btn btn-default\" data-action=\"#\" id=\"id_6\">numberedlist</button>
                                </span>
                            </div>
                        </div>
                             <textarea id=\"id_1\" class=\"c-field-textarea\" name=\"name_0\" minlength=\"$min\" maxlength=\"$max\"></textarea>
                            <div class=\"ui-input-textarea-remainder\"> ui_chars_remaining<span data-action=\"remainder\">$max</span></div>
                        <div class=\"c-field-markdown__preview hidden\">
                        </div>
                    </div>
                
                </div>
                <div class=\"c-input__help-byline\">$byline</div>
            </fieldset>
            "
        );

        $html = $this->brutallyTrimHTML($this->getRendererWithStubs()->render($input));

        $this->assertEquals($expected, $html);
    }

Here is the call graph for this function:

testRenderWithRequired()

MarkdownTest::testRenderWithRequired

(

)

Definition at line 351 of file MarkdownTest.php.

References factory(), and getRendererWithStubs().

                                            : void
    {
        $label = 'test_label';
        $byline = 'test_byline';

        $input = $this->factory->markdown(
            $this->markdown_renderer,
            $label,
            $byline
        )->withRequired(true)->withNameFrom($this->name_source);

        $expected = $this->brutallyTrimHTML(
            "
            <fieldset class=\"c-input\" data-il-ui-component=\"markdown-field-input\" data-il-ui-input-name=\"name_0\" id=\"id_8\" tabindex=\"0\">
                <label>$label<span class=\"asterisk\" aria-label=\"required_field\">*</span></label>
                <div class=\"c-input__field\">

                        <div class=\"c-field-markdown\">
                            <div class=\"c-field-markdown__controls\">
                                view_control_mode
                                <div class=\"c-field-markdown__actions\">
                                    <span data-action=\"insert-heading\">
                                        <button class=\"btn btn-default\" data-action=\"#\" id=\"id_2\">header</button>
                                    </span>
                                    <span data-action=\"insert-link\">
                                        <button class=\"btn btn-default\" data-action=\"#\" id=\"id_3\">link</button>
                                    </span>
                                    <span data-action=\"insert-bold\">
                                        <button class=\"btn btn-default\" data-action=\"#\" id=\"id_4\">bold</button>
                                    </span>
                                    <span data-action=\"insert-italic\">
                                        <button class=\"btn btn-default\" data-action=\"#\" id=\"id_5\">italic</button>
                                    </span>
                                    <span data-action=\"insert-bullet-points\">
                                        <button class=\"btn btn-default\" data-action=\"#\" id=\"id_7\">bulletpoint</button>
                                    </span>
                                    <span data-action=\"insert-enumeration\">
                                        <button class=\"btn btn-default\" data-action=\"#\" id=\"id_6\">numberedlist</button>
                                    </span>
                                </div>
                            </div>
                                 <textarea id=\"id_1\" class=\"c-field-textarea\" name=\"name_0\"></textarea>
                        <div class=\"c-field-markdown__preview hidden\">
                        </div>
                    </div>

                </div>
                <div class=\"c-input__help-byline\">$byline</div>
            </fieldset>
            "
        );

        $html = $this->brutallyTrimHTML($this->getRendererWithStubs()->render($input));

        $this->assertEquals($expected, $html);
    }

Here is the call graph for this function:

Field Documentation

$bold_glyph_mock

Glyph MarkdownTest::$bold_glyph_mock

protected

Definition at line 59 of file MarkdownTest.php.

$bulledpoint_glyph_mock

Glyph MarkdownTest::$bulledpoint_glyph_mock

protected

Definition at line 55 of file MarkdownTest.php.

$factory

FieldFactory MarkdownTest::$factory

protected

Definition at line 51 of file MarkdownTest.php.

$header_glyph_mock

Glyph MarkdownTest::$header_glyph_mock

protected

Definition at line 56 of file MarkdownTest.php.

$italic_glyph_mock

Glyph MarkdownTest::$italic_glyph_mock

protected

Definition at line 57 of file MarkdownTest.php.

$link_glyph_mock

Glyph MarkdownTest::$link_glyph_mock

protected

Definition at line 58 of file MarkdownTest.php.

$markdown_renderer

MarkdownRenderer MarkdownTest::$markdown_renderer

protected

Definition at line 49 of file MarkdownTest.php.

Referenced by getMarkdownRendererMock().

$name_source

DefNamesource MarkdownTest::$name_source

protected

Definition at line 50 of file MarkdownTest.php.

$numberedlist_glyph_mock

Glyph MarkdownTest::$numberedlist_glyph_mock

protected

Definition at line 54 of file MarkdownTest.php.

$view_control_mock

ViewControlMode MarkdownTest::$view_control_mock

protected

Definition at line 53 of file MarkdownTest.php.

TEST_ASYNC_URL

const MarkdownTest::TEST_ASYNC_URL = 'https://localhost'

protected

Definition at line 46 of file MarkdownTest.php.

TEST_PARAMETER_NAME

const MarkdownTest::TEST_PARAMETER_NAME = 'preview'

protected

Definition at line 47 of file MarkdownTest.php.

---

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

• components/ILIAS/UI/tests/Component/Input/Field/MarkdownTest.php