inc\classes\Chat.php

Show: inherited

• Classes
  • \Chat

Table of Contents

Author

Sergey Dilong  

License

GPL-2.0  

Package

Temply-Account\Objects  

\Chat

jump to top

Package: Temply-Account\Objects

Chat object

Controlls participants, chat settings, creates new chats, etc.

Author

Sergey Dilong  

License

GPL-2.0  

Constants

  CHAT_TYPE = array('UNDEFINED_CHAT' => 0, 'PRIVATE_CHAT' => 1, 'MULTI_CHAT' => 2)

Chat types library

Properties

array $data = array()

Chat info

Default valuearray()Details

Type

array

integer|boolean $id = false

Chat ID

Default valuefalseDetails

Type

integer | boolean

\Message $message = false

Last message

Default valuefalseDetails

Type

\Message

array<mixed,\User> $users = array()

Chat participants

Default valuearray()Details

Type

array<mixed,\User>

Methods

Create(array $q, array $o = array()) : boolean

Creates new chat

Creates new chat in DB

Parameters

Name	Type	Description
$q	array	Creation info
$o	array	Options

Returns

Type	Description
boolean

Throws

Exception	Description
\apiException	* [601] Incorrect creation data

Details

Api

 

See

Call this method outside the class  

Init(integer $q, array $o = array()) : void

Generate Chat instance

Gets info about chat

Parameters

Name	Type	Description
$q	integer	Chat ID
$o	array	Options

Throws

Exception	Description
\apiException	* [401] Access denied * [600] Incorrect input data

__construct(array | integer $q, array $o = array()) : void

Construct Chat

Creates new Chat object instance (Router)

Parameters

Name	Type	Description
$q	array | integer	Query
$o	array	Options CREATE_CHAT_MODE - Creates nw chat

Throws

Exception	Description
\apiException	* [401] Access denied * [600] Incorrect input data * [601] Incorrect chat creation data

Details

See

New chat creation  

See

Getting chat instance  

get(array $o = array()) : array

Gets Chat info

Returns stored data in the class

Parameters

Name	Type	Description
$o	array	Options

Returns

Type	Description
array	$r

Details

See

Call this method outside the class