Documentation

Z_Chat extends Base
in package

Class Chat.

Table of Contents

$logs  : mixed
$chatActive  : bool
Is chat active.
$globalRoom  : bool|array<string|int, mixed>
Global room.
$listId  : array<string|int, int>
ID list.
$logToFile  : bool
$users  : array<string|int, int>
List of user IDs.
setUpBeforeClass()  : void
Setting of tests.
tearDownAfterClass()  : void
Cleaning after tests.
testAddMessageCrm()  : mixed
Testing adding messages to Crm chat room.
testAddNewMessage()  : mixed
Testing adding messages.
testAssigningToGroup()  : mixed
Test assigning a user to a group room.
testConfiguration()  : mixed
Configuration testing.
testCreatingChatRoomCrm()  : mixed
Testing creating a chat room.
testCurrentRoom()  : mixed
Testing the method of the current chat room.
testCurrentRoomAfterDeletingRecord()  : void
Test the current chat room after deleting the record.
testGeneralRoom()  : mixed
Check if the general chat room exists.
testGroup()  : mixed
Chat testing for groups.
testHistory()  : mixed
Message history test.
testNewMessage()  : mixed
Testing the method for checking new messages.
testRemoveFromFavorites()  : mixed
Remove test from favorites.
testRemoveRecordCrm()  : void
Testing the removal of Crm chat room.
testRoomCrm()  : mixed
Testing a CRM chat room.
testSwitchRoom()  : mixed
Chat room switching test.
disableLogs()  : void
Disable system logs.
enableLogs()  : void
Enable system logs.
onNotSuccessfulTest()  : void
This method is called when a test method did not execute successfully.
getKeyMessage()  : int|false
Get key of message.
getKeyRoom()  : bool|int
Get key of chat room.
getUserFromParticipants()  : bool|int|string
Get user from participants.

Properties

$logs

public mixed $logs

$chatActive

Is chat active.

private static bool $chatActive = false

$globalRoom

Global room.

private static bool|array<string|int, mixed> $globalRoom = false

$listId

ID list.

private static array<string|int, int> $listId

$logToFile

private bool $logToFile

$users

List of user IDs.

private static array<string|int, int> $users = []

Methods

setUpBeforeClass()

Setting of tests.

public static setUpBeforeClass() : void
Return values
void

tearDownAfterClass()

Cleaning after tests.

public static tearDownAfterClass() : void
Tags
codeCoverageIgnore
Return values
void

testAddMessageCrm()

Testing adding messages to Crm chat room.

public testAddMessageCrm() : mixed
Return values
mixed

testAddNewMessage()

Testing adding messages.

public testAddNewMessage() : mixed
Return values
mixed

testAssigningToGroup()

Test assigning a user to a group room.

public testAssigningToGroup() : mixed
Tags
throws
IllegalValue
Return values
mixed

testConfiguration()

Configuration testing.

public testConfiguration() : mixed
Return values
mixed

testCreatingChatRoomCrm()

Testing creating a chat room.

public testCreatingChatRoomCrm() : mixed
Return values
mixed

testCurrentRoom()

Testing the method of the current chat room.

public testCurrentRoom() : mixed
Return values
mixed

testCurrentRoomAfterDeletingRecord()

Test the current chat room after deleting the record.

public testCurrentRoomAfterDeletingRecord() : void
Return values
void

testGeneralRoom()

Check if the general chat room exists.

public testGeneralRoom() : mixed
Return values
mixed

testGroup()

Chat testing for groups.

public testGroup() : mixed
Return values
mixed

testHistory()

Message history test.

public testHistory() : mixed
Tags
throws
IllegalValue
Return values
mixed

testNewMessage()

Testing the method for checking new messages.

public testNewMessage() : mixed
Return values
mixed

testRemoveFromFavorites()

Remove test from favorites.

public testRemoveFromFavorites() : mixed
Tags
throws
IllegalValue
throws
Exception
Return values
mixed

testRemoveRecordCrm()

Testing the removal of Crm chat room.

public testRemoveRecordCrm() : void
Tags
throws
Exception
Return values
void

testRoomCrm()

Testing a CRM chat room.

public testRoomCrm() : mixed
Return values
mixed

testSwitchRoom()

Chat room switching test.

public testSwitchRoom() : mixed
Tags
throws
IllegalValue
Return values
mixed

disableLogs()

Disable system logs.

protected disableLogs() : void
Return values
void

enableLogs()

Enable system logs.

protected enableLogs() : void
Return values
void

onNotSuccessfulTest()

This method is called when a test method did not execute successfully.

protected onNotSuccessfulTest(Throwable $t) : void
Parameters
$t : Throwable
Tags
codeCoverageIgnore
Return values
void

getKeyMessage()

Get key of message.

private static getKeyMessage(array<string|int, mixed> $entries, int $id) : int|false
Parameters
$entries : array<string|int, mixed>
$id : int
Tags
codeCoverageIgnore
Return values
int|false

getKeyRoom()

Get key of chat room.

private static getKeyRoom(array<string|int, mixed> $userRooms, string $roomType, int $recordId) : bool|int
Parameters
$userRooms : array<string|int, mixed>
$roomType : string
$recordId : int
Tags
codeCoverageIgnore
Return values
bool|int

getUserFromParticipants()

Get user from participants.

private static getUserFromParticipants(array<string|int, mixed> $participants, int $userId) : bool|int|string
Parameters
$participants : array<string|int, mixed>
$userId : int
Tags
codeCoverageIgnore
Return values
bool|int|string

Search results