ilCtrlContextTest Class Reference

Class ilCtrlContextTest. More...

Inheritance diagram for ilCtrlContextTest:

Collaboration diagram for ilCtrlContextTest:

Public Member Functions
	testContextPropertyAdoptionByRequest ()
	testContextAsyncPropertyAdoptionByRequest ()
	testContextBaseClassPropertyAdoptionByRequest ()
	testContextPropertyAdoptionWithoutCidPathAndBaseClass ()
	testContextPropertiesThatCantBeAdopted ()
	testContextCommandClassPropertyWithoutBaseClass ()
	testContextCommandClassPropertyWithBaseClass ()
	testContextPathProgressionWhenSettingClasses ()

Protected Member Functions
	setUp ()
	getPath (string $cid_path=null)
	getContextWithManualAdoption (array $request_values=null)

Private Attributes
ArrayBasedRequestWrapper	$request
ilCtrlPathFactory	$factory
Refinery	$refinery
array	$values

Detailed Description

Class ilCtrlContextTest.

Author

Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch

Definition at line 15 of file ilCtrlContextTest.php.

Member Function Documentation

getContextWithManualAdoption()

ilCtrlContextTest::getContextWithManualAdoption ( array  $request_values = null )

protected

Parameters

array | null

$request_values

Returns

ilCtrlContextInterface

Definition at line 74 of file ilCtrlContextTest.php.

References $factory, $refinery, $request, ILIAS\UI\examples\Layout\Page\Standard\$request_wrapper, ILIAS\MetaData\Repository\Validation\Data\__construct(), ilCtrlPathFactory\null(), and ILIAS\Repository\refinery().

Referenced by testContextAsyncPropertyAdoptionByRequest(), testContextBaseClassPropertyAdoptionByRequest(), testContextCommandClassPropertyWithBaseClass(), testContextCommandClassPropertyWithoutBaseClass(), testContextPropertyAdoptionByRequest(), and testContextPropertyAdoptionWithoutCidPathAndBaseClass().

                                                                                 : ilCtrlContextInterface
    {
        $this->values = $request_values ?? [];

        return new class ($this->factory, $this->request, $this->refinery) extends ilCtrlContext {
            // override parent constructor, so the request values
            // are not adopted immediately.
            public function __construct(
                ilCtrlPathFactory $path_factory,
                ArrayBasedRequestWrapper $request_wrapper,
                Refinery $refinery
            ) {
                $this->path_factory = $path_factory;
                $this->path = $path_factory->null();
                $this->request_wrapper = $request_wrapper;
                $this->refinery = $refinery;
            }

            // provide a public method that manually adopts the
            // request values.
            public function adopt(): void
            {
                $this->adoptRequestParameters();
            }
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPath()

ilCtrlContextTest::getPath ( string  $cid_path = null )

protected

Parameters

string | null

$cid_path

Returns

ilCtrlPathInterface

Definition at line 58 of file ilCtrlContextTest.php.

References ILIAS\MetaData\Repository\Validation\Data\__construct().

Referenced by testContextBaseClassPropertyAdoptionByRequest(), testContextCommandClassPropertyWithBaseClass(), testContextCommandClassPropertyWithoutBaseClass(), and testContextPropertyAdoptionByRequest().

                                                       : ilCtrlPathInterface
    {
        return new class ($cid_path) extends ilCtrlAbstractPath {
            // override parent constructor, so we don't
            // have to mock the ilCtrlStructure.
            public function __construct(string $cid_path = null)
            {
                $this->cid_path = $cid_path;
            }
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setUp()

ilCtrlContextTest::setUp ( )

protected

Definition at line 40 of file ilCtrlContextTest.php.

References ILIAS\LTI\ToolProvider\$key, and ILIAS\Repository\refinery().

                              : void
    {
        $this->values = [];
        $this->refinery = $this->createMock(Refinery::class);
        $this->factory = $this->createMock(ilCtrlPathFactory::class);
        $this->request = $this->createMock(ArrayBasedRequestWrapper::class);
        $this->request->method('has')->willReturn(true);
        $this->request
            ->method('retrieve')
            ->willReturnCallback(function ($key) {
                return $this->values[$key] ?? null;
            });
    }

Here is the call graph for this function:

testContextAsyncPropertyAdoptionByRequest()

ilCtrlContextTest::testContextAsyncPropertyAdoptionByRequest

(

)

Definition at line 148 of file ilCtrlContextTest.php.

References $context, ilCtrlInterface\CMD_MODE_ASYNC, ilCtrlInterface\CMD_MODE_HTML, ilCtrlInterface\CMD_MODE_PROCESS, getContextWithManualAdoption(), and ilCtrlInterface\PARAM_CMD_MODE.

                                                               : void
    {
        $context = $this->getContextWithManualAdoption();
        $this->assertFalse($context->isAsync());

        $this->values[ilCtrlInterface::PARAM_CMD_MODE] = ilCtrlInterface::CMD_MODE_PROCESS;
        $context->adopt();
        $this->assertFalse($context->isAsync());

        $this->values[ilCtrlInterface::PARAM_CMD_MODE] = ilCtrlInterface::CMD_MODE_HTML;
        $context->adopt();
        $this->assertFalse($context->isAsync());

        $this->values[ilCtrlInterface::PARAM_CMD_MODE] = ilCtrlInterface::CMD_MODE_ASYNC;
        $context->adopt();
        $this->assertTrue($context->isAsync());
    }

Here is the call graph for this function:

testContextBaseClassPropertyAdoptionByRequest()

ilCtrlContextTest::testContextBaseClassPropertyAdoptionByRequest

(

)

Definition at line 166 of file ilCtrlContextTest.php.

References $context, getContextWithManualAdoption(), getPath(), and ilCtrlInterface\PARAM_BASE_CLASS.

                                                                   : void
    {
        $expected_cid_path = '0';
        $this->factory
            ->method('find')
            ->willReturn($this->getPath($expected_cid_path));

        $context = $this->getContextWithManualAdoption();
        $this->assertNull($context->getBaseClass());

        $this->values[ilCtrlInterface::PARAM_BASE_CLASS] = ilCtrlBaseClass1TestGUI::class;
        $context->adopt();

        $this->assertEquals(ilCtrlBaseClass1TestGUI::class, $context->getBaseClass());
        $this->assertEquals($expected_cid_path, $context->getPath()->getCidPath());
    }

Here is the call graph for this function:

testContextCommandClassPropertyWithBaseClass()

ilCtrlContextTest::testContextCommandClassPropertyWithBaseClass

(

)

Definition at line 233 of file ilCtrlContextTest.php.

References $context, getContextWithManualAdoption(), getPath(), ilCtrlInterface\PARAM_CMD_CLASS, and ILIAS\Repository\refinery().

                                                                  : void
    {
        $context = new ilCtrlContext($this->factory, $this->request, $this->refinery);
        $this->factory
            ->method('find')
            ->willReturn($this->getPath('http://localhost'));

        $context->setBaseClass(ilCtrlBaseClass1TestGUI::class);
        $this->assertEquals(ilCtrlBaseClass1TestGUI::class, $context->getCmdClass());

        $context->setCmdClass(ilCtrlCommandClass1TestGUI::class);
        $this->assertEquals(ilCtrlBaseClass1TestGUI::class, $context->getBaseClass());
        $this->assertEquals(ilCtrlCommandClass1TestGUI::class, $context->getCmdClass());

        $context = $this->getContextWithManualAdoption([
            ilCtrlInterface::PARAM_CMD_CLASS => ilCtrlBaseClass1TestGUI::class,
        ]);

        $this->assertNull($context->getCmdClass());
        $context->adopt();
        $this->assertEquals(ilCtrlBaseClass1TestGUI::class, $context->getCmdClass());
    }

Here is the call graph for this function:

testContextCommandClassPropertyWithoutBaseClass()

ilCtrlContextTest::testContextCommandClassPropertyWithoutBaseClass

(

)

Definition at line 213 of file ilCtrlContextTest.php.

References $context, getContextWithManualAdoption(), getPath(), ilCtrlInterface\PARAM_CMD_CLASS, and ILIAS\Repository\refinery().

                                                                     : void
    {
        $context = new ilCtrlContext($this->factory, $this->request, $this->refinery);
        $this->factory
            ->method('find')
            ->willReturn($this->getPath('http://localhost'));

        $this->assertNull($context->getCmdClass());
        $context->setCmdClass(ilCtrlCommandClass1TestGUI::class);
        $this->assertEquals(ilCtrlCommandClass1TestGUI::class, $context->getCmdClass());

        $context = $this->getContextWithManualAdoption([
            ilCtrlInterface::PARAM_CMD_CLASS => ilCtrlBaseClass1TestGUI::class,
        ]);

        $this->assertNull($context->getCmdClass());
        $context->adopt();
        $this->assertEquals(ilCtrlBaseClass1TestGUI::class, $context->getCmdClass());
    }

Here is the call graph for this function:

testContextPathProgressionWhenSettingClasses()

ilCtrlContextTest::testContextPathProgressionWhenSettingClasses

(

)

Definition at line 256 of file ilCtrlContextTest.php.

References $context, $structure, and ILIAS\Repository\refinery().

                                                                  : void
    {
        // for this test an actual instance of the path factory
        // is required, therefore we have to creat the test ctrl
        // structure.

        $structure_artifact = require __DIR__ . '/Data/Structure/test_ctrl_structure.php';
        $base_class_artifact = require __DIR__ . '/Data/Structure/test_base_classes.php';

        $structure = new ilCtrlStructure(
            $structure_artifact,
            $base_class_artifact,
            []
        );

        $path_factory = new ilCtrlPathFactory($structure);
        $context = new ilCtrlContext($path_factory, $this->request, $this->refinery);
        $this->assertNull($context->getPath()->getCidPath());

        $context->setBaseClass(ilCtrlInvalidGuiClass::class);
        $this->assertNull($context->getPath()->getCidPath());
        $this->assertNull($context->getBaseClass());

        $context->setCmdClass(ilCtrlCommandClass1TestGUI::class);
        $this->assertNull($context->getPath()->getCidPath());
        $this->assertNull($context->getCmdClass());

        $context->setBaseClass(ilCtrlBaseClass1TestGUI::class);
        $this->assertEquals('0', $context->getPath()->getCidPath());
        $this->assertEquals(ilCtrlBaseClass1TestGUI::class, $context->getBaseClass());
        $this->assertEquals(ilCtrlBaseClass1TestGUI::class, $context->getCmdClass());

        $context->setCmdClass(ilCtrlCommandClass1TestGUI::class);
        $this->assertEquals('0:2', $context->getPath()->getCidPath());
        $this->assertEquals(ilCtrlBaseClass1TestGUI::class, $context->getBaseClass());
        $this->assertEquals(ilCtrlCommandClass1TestGUI::class, $context->getCmdClass());
    }

Here is the call graph for this function:

testContextPropertiesThatCantBeAdopted()

ilCtrlContextTest::testContextPropertiesThatCantBeAdopted

(

)

Definition at line 195 of file ilCtrlContextTest.php.

References $context, and ILIAS\Repository\refinery().

                                                            : void
    {
        $context = new ilCtrlContext($this->factory, $this->request, $this->refinery);

        $this->assertNull($context->getObjType());
        $this->assertNull($context->getObjId());
        $this->assertEquals('ilias.php', $context->getTargetScript());

        $context
            ->setObjType('test_type')
            ->setObjId(42)
            ->setTargetScript('test_script');

        $this->assertEquals('test_type', $context->getObjType());
        $this->assertEquals(42, $context->getObjId());
        $this->assertEquals('test_script', $context->getTargetScript());
    }

Here is the call graph for this function:

testContextPropertyAdoptionByRequest()

ilCtrlContextTest::testContextPropertyAdoptionByRequest

(

)

Definition at line 101 of file ilCtrlContextTest.php.

References $context, getContextWithManualAdoption(), getPath(), ilCtrlInterface\PARAM_BASE_CLASS, ilCtrlInterface\PARAM_CID_PATH, ilCtrlInterface\PARAM_CMD, ilCtrlInterface\PARAM_CMD_CLASS, ilCtrlInterface\PARAM_CMD_MODE, and ilCtrlInterface\PARAM_REDIRECT.

                                                          : void
    {
        $expected_cid_path = 'test_cid_path';
        $this->factory
            ->method('existing')
            ->willReturn($this->getPath($expected_cid_path));

        $this->factory
            ->method('find')
            ->willReturn($this->getPath($expected_cid_path));

        $context = $this->getContextWithManualAdoption([
            ilCtrlInterface::PARAM_CMD_MODE => 'test_cmd_mode',
            ilCtrlInterface::PARAM_REDIRECT => 'test_redirect_source',
            ilCtrlInterface::PARAM_BASE_CLASS => 'test_base_class',
            ilCtrlInterface::PARAM_CMD_CLASS => 'test_cmd_class',
            ilCtrlInterface::PARAM_CMD => 'test_cmd',
            ilCtrlInterface::PARAM_CID_PATH => $expected_cid_path,
        ]);

        $this->assertFalse($context->isAsync());
        $this->assertEquals('ilias.php', $context->getTargetScript());
        $this->assertNull($context->getCmdMode());
        $this->assertNull($context->getRedirectSource());
        $this->assertNull($context->getBaseClass());
        $this->assertNull($context->getCmdClass());
        $this->assertNull($context->getCmd());
        $this->assertNull($context->getPath()->getCidPath());
        $this->assertNull($context->getObjType());
        $this->assertNull($context->getObjId());

        // manually adopt request values.
        $context->adopt();

        $this->assertFalse($context->isAsync());
        $this->assertNull($context->getObjType());
        $this->assertNull($context->getObjId());
        $this->assertEquals('ilias.php', $context->getTargetScript());

        $this->assertEquals('test_cmd_mode', $context->getCmdMode());
        $this->assertEquals('test_redirect_source', $context->getRedirectSource());
        $this->assertEquals('test_base_class', $context->getBaseClass());
        $this->assertEquals('test_cmd_class', $context->getCmdClass());
        $this->assertEquals('test_cmd', $context->getCmd());
        $this->assertEquals('test_cid_path', $context->getPath()->getCidPath());
    }

Here is the call graph for this function:

testContextPropertyAdoptionWithoutCidPathAndBaseClass()

ilCtrlContextTest::testContextPropertyAdoptionWithoutCidPathAndBaseClass

(

)

Definition at line 183 of file ilCtrlContextTest.php.

References $context, and getContextWithManualAdoption().

                                                                           : void
    {
        $context = $this->getContextWithManualAdoption();
        $this->assertNull($context->getBaseClass());
        $this->assertNull($context->getPath()->getCidPath());

        $context->adopt();

        $this->assertNull($context->getBaseClass());
        $this->assertNull($context->getPath()->getCidPath());
    }

Here is the call graph for this function:

Field Documentation

$factory

ilCtrlPathFactory ilCtrlContextTest::$factory

private

Definition at line 25 of file ilCtrlContextTest.php.

Referenced by getContextWithManualAdoption().

$refinery

Refinery ilCtrlContextTest::$refinery

private

Definition at line 30 of file ilCtrlContextTest.php.

Referenced by getContextWithManualAdoption().

$request

ArrayBasedRequestWrapper ilCtrlContextTest::$request

private

Definition at line 20 of file ilCtrlContextTest.php.

Referenced by getContextWithManualAdoption().

$values

array ilCtrlContextTest::$values

private

Definition at line 35 of file ilCtrlContextTest.php.

---

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

• Services/UICore/test/ilCtrlContextTest.php