ilChatroomAbstractTaskTestBase.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use PHPUnit\Framework\MockObject\Builder\InvocationMocker;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\MockObject\Rule\InvocationOrder;

abstract class ilChatroomAbstractTaskTestBase extends ilChatroomAbstractTestBase
{
    protected MockObject&ilChatroomObjectGUI $gui;
    protected MockObject&ilChatroomServerConnector $ilChatroomServerConnectorMock;
    protected MockObject&ilObjChatroom $object;

    protected function setUp(): void
    {
        parent::setUp();

        if (!defined('ROOT_FOLDER_ID')) {
            define('ROOT_FOLDER_ID', time());
        }
    }

    protected function createGlobalIlLanguageMock(): ilLanguage
    {
        $lng = $this->getMockBuilder(ilLanguage::class)->disableOriginalConstructor()->onlyMethods(
            ['loadLanguageModule', 'txt']
        )->getMock();

        $lng->method('loadLanguageModule')->with(
            $this->logicalOr(
                $this->equalTo('chatroom'),
                $this->equalTo('meta')
            )
        );
        $lng->method('txt');

        $this->setGlobalVariable('lng', $lng);

        return $lng;
    }

    protected function createGlobalRbacSystemMock(): ilRbacSystem
    {
        $rbacsystem = $this->getMockBuilder(ilRbacSystem::class)->disableOriginalConstructor()->onlyMethods(
            ['checkAccess']
        )->getMock();

        $this->setGlobalVariable('rbacsystem', $rbacsystem);

        return $rbacsystem;
    }

    protected function createGlobalRbacSystemCheckAccessMock(
        string $permission,
        bool $result,
        ?InvocationOrder $times = null
    ) {
        if ($times === null) {
            $times = $this->any();
        }

        return $GLOBALS['rbacsystem']->expects($times)
            ->method('checkAccess')
            ->with($this->equalTo($permission))->willReturn(
                $result
            );
    }

    protected function createGlobalIlCtrlMock(): ilCtrlInterface
    {
        $ctrl = $this->createMock(ilCtrlInterface::class);

        $this->setGlobalVariable('ilCtrl', $ctrl);

        return $GLOBALS['ilCtrl'];
    }

    protected function createGlobalIlUserMock(): ilObjUser
    {
        $user = $this->getMockBuilder(ilObjUser::class)->disableOriginalConstructor()->getMock();

        $this->setGlobalVariable('ilUser', $user);

        return $user;
    }

    protected function createIlObjChatroomGUIGetConnectorMock($returnValue): void
    {
        $this->gui->method('getConnector')->willReturn($returnValue);
    }

    protected function createIlChatroomIsOwnerOfPrivateRoomMock(
        int $userId,
        int $subRoomId,
        bool $result
    ): InvocationMocker {
        return $this->ilChatroomMock->method('isOwnerOfPrivateRoom')->with(
            $this->equalTo($userId),
            $this->equalTo($subRoomId)
        )->willReturn($result);
    }

    protected function createIlChatroomUserGetUserIdMock(int $userId): InvocationMocker
    {
        return $this->ilChatroomUserMock->method('getUserId')->willReturn($userId);
    }

    protected function createIlChatroomServerConnectorMock(
        ilChatroomServerSettings $settings
    ): ilChatroomServerConnector {
        $this->ilChatroomServerConnectorMock = $this->getMockBuilder(ilChatroomServerConnector::class)->setConstructorArgs(
            [$settings]
        )->onlyMethods(['file_get_contents'])->getMock();

        return $this->ilChatroomServerConnectorMock;
    }

    protected function createIlChatroomServerConnectorFileGetContentsMock($returnValue): InvocationMocker
    {
        return $this->ilChatroomServerConnectorMock->method('file_get_contents')->willReturn(
            $returnValue
        );
    }

    protected function createIlObjChatroomMock(int $id): ilObjChatroom
    {
        $this->object = $this->getMockBuilder(ilObjChatroom::class)->disableOriginalConstructor()->onlyMethods(
            ['getId']
        )->getMock();
        $this->object->method('getId')->willReturn($id);

        return $this->object;
    }

    protected function createSendResponseMock(MockObject $mock, $response): void
    {
        $mock->expects($this->once())->method('sendResponse')->with(
            $this->equalTo($response)
        )->willReturnCallback(
            static function (): never {
                throw new Exception('Exit', 0);
            }
        );
    }
}