ILIAS\WOPI\Handler\GetFileInfoResponseTest Class Reference

Inheritance diagram for ILIAS\WOPI\Handler\GetFileInfoResponseTest:

Collaboration diagram for ILIAS\WOPI\Handler\GetFileInfoResponseTest:

Public Member Functions
	testViewSessionDoesNotClaimRestrictionsItDoesNotMean ()
	RestrictedWebViewOnly restricts what the user may do with the file and its effect is up to the client; UserCanAttend is about viewing a broadcast. More...
	testEditSessionDoesNotClaimRestrictionsItDoesNotMean ()
	testViewSessionStaysReadOnly ()
	testEditSessionMayWrite ()
	testViewSessionOfAUserWhoMayWriteStaysReadOnlyButDoesNotBlameTheirRights ()
	The content tab of a file object is a viewer, also for someone who holds the permission to edit the file. More...
	testViewSessionOfAUserWhoMayNotWrite ()
	testTheHostDoesNotOfferAWayIntoEditMode ()
	ILIAS never handles the UI_Edit message, so it must not announce that it does. More...
	testNoCloseButtonOfTheClientIsAnnounced ()
	ILIAS closes the WOPI client itself, a close button of the client would do nothing. More...
	testIdsAndVersionAreStrings ()

Protected Member Functions
	setUp ()

Private Member Functions
	responseFor (bool $editable, ?bool $user_can_write=null)

Detailed Description

See also

https://mantis.ilias.de/view.php?id=48246

Definition at line 30 of file GetFileInfoResponseTest.php.

Member Function Documentation

responseFor()

ILIAS\WOPI\Handler\GetFileInfoResponseTest::responseFor ( bool  $editable, ?bool  $user_can_write = null  )

private

Definition at line 49 of file GetFileInfoResponseTest.php.

                                                                              : array
    {
        $information = $this->createStub(Information::class);
        $information->method('getSuffix')->willReturn('odt');
        $information->method('getSize')->willReturn(1234);
        $information->method('getCreationDate')->willReturn(new \DateTimeImmutable('2026-01-01 12:00:00'));
 
        $revision = $this->createStub(Revision::class);
        $revision->method('getTitle')->willReturn('minutes.odt');
        $revision->method('getVersionNumber')->willReturn(3);
        $revision->method('getOwnerId')->willReturn(6);
        $revision->method('getInformation')->willReturn($information);
 
        return (new GetFileInfoResponse($revision, 6, $editable, $user_can_write))->jsonSerialize();
    }

Referenced by ILIAS\WOPI\Handler\GetFileInfoResponseTest\testEditSessionDoesNotClaimRestrictionsItDoesNotMean(), ILIAS\WOPI\Handler\GetFileInfoResponseTest\testEditSessionMayWrite(), ILIAS\WOPI\Handler\GetFileInfoResponseTest\testIdsAndVersionAreStrings(), ILIAS\WOPI\Handler\GetFileInfoResponseTest\testNoCloseButtonOfTheClientIsAnnounced(), ILIAS\WOPI\Handler\GetFileInfoResponseTest\testTheHostDoesNotOfferAWayIntoEditMode(), ILIAS\WOPI\Handler\GetFileInfoResponseTest\testViewSessionDoesNotClaimRestrictionsItDoesNotMean(), ILIAS\WOPI\Handler\GetFileInfoResponseTest\testViewSessionOfAUserWhoMayNotWrite(), ILIAS\WOPI\Handler\GetFileInfoResponseTest\testViewSessionOfAUserWhoMayWriteStaysReadOnlyButDoesNotBlameTheirRights(), and ILIAS\WOPI\Handler\GetFileInfoResponseTest\testViewSessionStaysReadOnly().

Here is the caller graph for this function:

setUp()

ILIAS\WOPI\Handler\GetFileInfoResponseTest::setUp ( )

protected

Definition at line 32 of file GetFileInfoResponseTest.php.

                              : void
    {
        if (!defined('ILIAS_HTTP_PATH')) {
            define('ILIAS_HTTP_PATH', 'https://ilias.example.org');
        }
 
        $GLOBALS['DIC'] ??= new \ILIAS\DI\Container();
        if (!isset($GLOBALS['DIC']['ilDB'])) {
            $db = $this->createStub(\ilDBInterface::class);
            $db->method('queryF')->willReturn($this->createStub(\ilDBStatement::class));
            $db->method('fetchAssoc')->willReturn(
                ['firstname' => 'Ada', 'lastname' => 'Lovelace', 'title' => '', 'login' => 'ada']
            );
            $GLOBALS['DIC']['ilDB'] = static fn(): \ilDBInterface => $db;
        }
    }

References ILIAS\$db, and $GLOBALS.

testEditSessionDoesNotClaimRestrictionsItDoesNotMean()

ILIAS\WOPI\Handler\GetFileInfoResponseTest::testEditSessionDoesNotClaimRestrictionsItDoesNotMean

(

)

Definition at line 78 of file GetFileInfoResponseTest.php.

                                                                          : void
    {
        $response = $this->responseFor(true);
 
        $this->assertArrayNotHasKey('RestrictedWebViewOnly', $response);
        $this->assertArrayNotHasKey('UserCanAttend', $response);
    }

References $response, and ILIAS\WOPI\Handler\GetFileInfoResponseTest\responseFor().

Here is the call graph for this function:

testEditSessionMayWrite()

ILIAS\WOPI\Handler\GetFileInfoResponseTest::testEditSessionMayWrite

(

)

Definition at line 95 of file GetFileInfoResponseTest.php.

                                             : void
    {
        $response = $this->responseFor(true);
 
        $this->assertFalse($response['ReadOnly']);
        $this->assertTrue($response['UserCanWrite']);
        $this->assertTrue($response['SupportsUpdate']);
    }

References $response, and ILIAS\WOPI\Handler\GetFileInfoResponseTest\responseFor().

Here is the call graph for this function:

testIdsAndVersionAreStrings()

ILIAS\WOPI\Handler\GetFileInfoResponseTest::testIdsAndVersionAreStrings

(

)

Definition at line 150 of file GetFileInfoResponseTest.php.

                                                 : void
    {
        $response = $this->responseFor(true);
 
        $this->assertSame('6', $response['OwnerId']);
        $this->assertSame('6', $response['UserId']);
        $this->assertIsString($response['Version']);
    }

References $response, and ILIAS\WOPI\Handler\GetFileInfoResponseTest\responseFor().

Here is the call graph for this function:

testNoCloseButtonOfTheClientIsAnnounced()

ILIAS\WOPI\Handler\GetFileInfoResponseTest::testNoCloseButtonOfTheClientIsAnnounced

(

)

ILIAS closes the WOPI client itself, a close button of the client would do nothing.

Definition at line 140 of file GetFileInfoResponseTest.php.

                                                             : void
    {
        foreach ([false, true] as $editable) {
            $response = $this->responseFor($editable);
 
            $this->assertArrayNotHasKey('CloseUrl', $response);
            $this->assertFalse($response['ClosePostMessage']);
        }
    }

References $response, and ILIAS\WOPI\Handler\GetFileInfoResponseTest\responseFor().

Here is the call graph for this function:

testTheHostDoesNotOfferAWayIntoEditMode()

ILIAS\WOPI\Handler\GetFileInfoResponseTest::testTheHostDoesNotOfferAWayIntoEditMode

(

)

ILIAS never handles the UI_Edit message, so it must not announce that it does.

Definition at line 131 of file GetFileInfoResponseTest.php.

                                                             : void
    {
        $this->assertFalse($this->responseFor(false, true)['EditModePostMessage']);
        $this->assertFalse($this->responseFor(true)['EditModePostMessage']);
    }

References ILIAS\WOPI\Handler\GetFileInfoResponseTest\responseFor().

Here is the call graph for this function:

testViewSessionDoesNotClaimRestrictionsItDoesNotMean()

ILIAS\WOPI\Handler\GetFileInfoResponseTest::testViewSessionDoesNotClaimRestrictionsItDoesNotMean

(

)

RestrictedWebViewOnly restricts what the user may do with the file and its effect is up to the client; UserCanAttend is about viewing a broadcast.

Neither describes the fact that this session opened a viewer, so neither is sent any more.

Definition at line 70 of file GetFileInfoResponseTest.php.

                                                                          : void
    {
        $response = $this->responseFor(false);
 
        $this->assertArrayNotHasKey('RestrictedWebViewOnly', $response);
        $this->assertArrayNotHasKey('UserCanAttend', $response);
    }

References $response, and ILIAS\WOPI\Handler\GetFileInfoResponseTest\responseFor().

Here is the call graph for this function:

testViewSessionOfAUserWhoMayNotWrite()

ILIAS\WOPI\Handler\GetFileInfoResponseTest::testViewSessionOfAUserWhoMayNotWrite

(

)

Definition at line 119 of file GetFileInfoResponseTest.php.

                                                          : void
    {
        $response = $this->responseFor(false, false);
 
        $this->assertTrue($response['ReadOnly']);
        $this->assertFalse($response['SupportsUpdate']);
        $this->assertFalse($response['UserCanWrite']);
    }

References $response, and ILIAS\WOPI\Handler\GetFileInfoResponseTest\responseFor().

Here is the call graph for this function:

testViewSessionOfAUserWhoMayWriteStaysReadOnlyButDoesNotBlameTheirRights()

ILIAS\WOPI\Handler\GetFileInfoResponseTest::testViewSessionOfAUserWhoMayWriteStaysReadOnlyButDoesNotBlameTheirRights

(

)

The content tab of a file object is a viewer, also for someone who holds the permission to edit the file.

The session stays read-only, but the client is told that the user is not the reason for it - otherwise it explains the viewer with missing access rights.

Definition at line 110 of file GetFileInfoResponseTest.php.

                                                                                              : void
    {
        $response = $this->responseFor(false, true);
 
        $this->assertTrue($response['ReadOnly']);
        $this->assertFalse($response['SupportsUpdate']);
        $this->assertTrue($response['UserCanWrite']);
    }

References $response, and ILIAS\WOPI\Handler\GetFileInfoResponseTest\responseFor().

Here is the call graph for this function:

testViewSessionStaysReadOnly()

ILIAS\WOPI\Handler\GetFileInfoResponseTest::testViewSessionStaysReadOnly

(

)

Definition at line 86 of file GetFileInfoResponseTest.php.

                                                  : void
    {
        $response = $this->responseFor(false);
 
        $this->assertTrue($response['ReadOnly']);
        $this->assertFalse($response['UserCanWrite']);
        $this->assertFalse($response['SupportsUpdate']);
    }

References $response, and ILIAS\WOPI\Handler\GetFileInfoResponseTest\responseFor().

Here is the call graph for this function:

---

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

• components/ILIAS/WOPI/tests/Handler/GetFileInfoResponseTest.php