PHP Класс Nahid\Talk\Talk

Автор: Nahid Bin Azhar
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$authUserId integer Currently loggedin user id.
$broadcast
$config
$conversation Nahid\Talk\Conversations\ConversationRepository The ConversationRepository class instance.
$message Nahid\Talk\Messages\MessageRepository The MessageRepository class instance.

Открытые методы

Метод Описание
__construct ( Illuminate\Contracts\Config\Repository $config, Broadcast $broadcast, ConversationRepository $conversation, MessageRepository $message ) Initialize and instantiate conversation and message repositories.
__construct ( ConversationRepository $conversation, MessageRepository $message ) : void Initialize and instantiate conversation and message repositories.
deleteConversations ( integer $id ) : boolean delete message threat or conversation by conversation id.
deleteForever ( integer $messageId ) : boolean permanently delete message for this id.
deleteMessage ( integer $messageId ) : boolean delete a specific message, its a softdelete process. All message stored in db.
deleteThread ( integer $id = null ) : boolean its an alias of deleteConversations.
getConversationsAllById ( integer $conversationId, integer $offset, integer $take = 20 ) : Message fetch all conversation with soft deleted messages by using coversation id.
getConversationsAllByUserId ( integer $senderId, integer $offset, integer $take = 20 ) : Message | boolean create a new message by using sender id.
getConversationsById ( integer $conversationId, integer $offset, integer $take = 20 ) : Message fetch all conversation by using coversation id.
getConversationsByUserId ( integer $senderId, integer $offset, integer $take = 20 ) : Message | boolean create a new message by using sender id.
getInbox ( $order = 'desc', integer $offset, integer $take = 20 ) : array fetch all inbox for currently loggedin user with pagination.
getInbox ( integer $offset, integer $take = 20 ) : array fetch all inbox for currently loggedin user with pagination.
getInboxAll ( $order = 'desc', integer $offset, integer $take = 20 ) : array fetch all inbox with soft deleted message for currently loggedin user with pagination.
getInboxAll ( integer $offset, integer $take = 20 ) : array fetch all inbox with soft deleted message for currently loggedin user with pagination.
getMessages ( integer $conversationId ) : Message | boolean its an alias of getConversationById.
getMessages ( integer $conversationId, $offset, $take = 20 ) : Message | boolean its an alias of getConversationById.
getMessagesAll ( integer $conversationId, $offset, $take = 20 ) : Message | boolean its an alias of getConversationAllById.
getMessagesAllByUserId ( $userId, $offset, $take = 20 ) : Message | boolean its an alias by getConversationAllByUserId.
getMessagesByUserId ( $userId ) : Message | boolean its an alias by getConversationByUserId.
getMessagesByUserId ( $userId, $offset, $take = 20 ) : Message | boolean its an alias by getConversationByUserId.
getReceiverInfo ( integer $conversationId ) : UserModel get receiver information for this conversation.
isAuthenticUser ( integer $conversationId, integer $userId ) : boolean check the given user exist for the given conversation.
isConversationExists ( integer $userId ) : boolean | integer make sure is this conversation exist for this user with currently loggedin user.
makeSeen ( integer $messageId ) : boolean make a message as seen.
readMessage ( integer $messageId = null ) : Message | boolean read a single message by message id.
sendMessage ( $conversatonId, string $message ) : Message | boolean send a message by using converstionid.
sendMessageByUserId ( integer $receiverId, string $message ) : Message create a new message by using receiverid.
setAuthUserId ( integer $id = null ) : integer | boolean set currently authenticated user id for global usage.
threads ( $order = 'desc', integer $offset, integer $take = 20 ) : array its a alias of getInbox method.
threads ( integer $offset, integer $take = 20 ) : array its a alias of getInbox method.
threadsAll ( $order = 'desc', integer $offset, integer $take = 20 ) : array its a alias of getInboxAll method.
threadsAll ( integer $offset, integer $take = 20 ) : array its a alias of getInboxAll method.
user ( $id = null ) * its set user id instantly when you fetch or access data. if you you haven't set authenticated user id globally or you want to fetch work with instant users information, you may use it

Защищенные методы

Метод Описание
getSerializeUser ( integer $user1, integer $user2 ) : array make two users as serialize with ascending order.
makeMessage ( integer $conversationId, string $message ) : Message create a new message by using conversationId.
makeMessageCollection ( $conversations )
newConversation ( integer $receiverId ) : integer make new conversation the given receiverId with currently loggedin user.

Описание методов

__construct() публичный Метод

Initialize and instantiate conversation and message repositories.
public __construct ( Illuminate\Contracts\Config\Repository $config, Broadcast $broadcast, ConversationRepository $conversation, MessageRepository $message )
$config Illuminate\Contracts\Config\Repository
$broadcast Nahid\Talk\Live\Broadcast
$conversation Nahid\Talk\Conversations\ConversationRepository
$message Nahid\Talk\Messages\MessageRepository

__construct() публичный Метод

Initialize and instantiate conversation and message repositories.
public __construct ( ConversationRepository $conversation, MessageRepository $message ) : void
$conversation Nahid\Talk\Conversations\ConversationRepository
$message Nahid\Talk\Messages\MessageRepository
Результат void

deleteConversations() публичный Метод

delete message threat or conversation by conversation id.
public deleteConversations ( integer $id ) : boolean
$id integer
Результат boolean

deleteForever() публичный Метод

permanently delete message for this id.
public deleteForever ( integer $messageId ) : boolean
$messageId integer
Результат boolean

deleteMessage() публичный Метод

delete a specific message, its a softdelete process. All message stored in db.
public deleteMessage ( integer $messageId ) : boolean
$messageId integer
Результат boolean

deleteThread() публичный Метод

its an alias of deleteConversations.
public deleteThread ( integer $id = null ) : boolean
$id integer
Результат boolean

getConversationsAllById() публичный Метод

fetch all conversation with soft deleted messages by using coversation id.
public getConversationsAllById ( integer $conversationId, integer $offset, integer $take = 20 ) : Message
$conversationId integer
$offset integer = 0
$take integer = 20
Результат Nahid\Talk\Messages\Message

getConversationsAllByUserId() публичный Метод

create a new message by using sender id.
public getConversationsAllByUserId ( integer $senderId, integer $offset, integer $take = 20 ) : Message | boolean
$senderId integer
$offset integer = 0
$take integer = 20
Результат Nahid\Talk\Messages\Message | boolean

getConversationsById() публичный Метод

fetch all conversation by using coversation id.
public getConversationsById ( integer $conversationId, integer $offset, integer $take = 20 ) : Message
$conversationId integer
$offset integer = 0
$take integer = 20
Результат Nahid\Talk\Messages\Message

getConversationsByUserId() публичный Метод

create a new message by using sender id.
public getConversationsByUserId ( integer $senderId, integer $offset, integer $take = 20 ) : Message | boolean
$senderId integer
$offset integer = 0
$take integer = 20
Результат Nahid\Talk\Messages\Message | boolean

getInbox() публичный Метод

fetch all inbox for currently loggedin user with pagination.
public getInbox ( $order = 'desc', integer $offset, integer $take = 20 ) : array
$offset integer
$take integer
Результат array

getInbox() публичный Метод

fetch all inbox for currently loggedin user with pagination.
public getInbox ( integer $offset, integer $take = 20 ) : array
$offset integer
$take integer
Результат array

getInboxAll() публичный Метод

fetch all inbox with soft deleted message for currently loggedin user with pagination.
public getInboxAll ( $order = 'desc', integer $offset, integer $take = 20 ) : array
$offset integer
$take integer
Результат array

getInboxAll() публичный Метод

fetch all inbox with soft deleted message for currently loggedin user with pagination.
public getInboxAll ( integer $offset, integer $take = 20 ) : array
$offset integer
$take integer
Результат array

getMessages() публичный Метод

its an alias of getConversationById.
public getMessages ( integer $conversationId ) : Message | boolean
$conversationId integer
Результат Nahid\Talk\Messages\Message | boolean

getMessages() публичный Метод

its an alias of getConversationById.
public getMessages ( integer $conversationId, $offset, $take = 20 ) : Message | boolean
$conversationId integer
Результат Nahid\Talk\Messages\Message | boolean

getMessagesAll() публичный Метод

its an alias of getConversationAllById.
public getMessagesAll ( integer $conversationId, $offset, $take = 20 ) : Message | boolean
$conversationId integer
Результат Nahid\Talk\Messages\Message | boolean

getMessagesAllByUserId() публичный Метод

its an alias by getConversationAllByUserId.
public getMessagesAllByUserId ( $userId, $offset, $take = 20 ) : Message | boolean
Результат Nahid\Talk\Messages\Message | boolean

getMessagesByUserId() публичный Метод

its an alias by getConversationByUserId.
public getMessagesByUserId ( $userId ) : Message | boolean
Результат Nahid\Talk\Messages\Message | boolean

getMessagesByUserId() публичный Метод

its an alias by getConversationByUserId.
public getMessagesByUserId ( $userId, $offset, $take = 20 ) : Message | boolean
Результат Nahid\Talk\Messages\Message | boolean

getReceiverInfo() публичный Метод

get receiver information for this conversation.
Устаревший: since version 2.0.0 Remove it from version 2.0.2
public getReceiverInfo ( integer $conversationId ) : UserModel
$conversationId integer
Результат UserModel

getSerializeUser() защищенный Метод

make two users as serialize with ascending order.
protected getSerializeUser ( integer $user1, integer $user2 ) : array
$user1 integer
$user2 integer
Результат array

isAuthenticUser() публичный Метод

check the given user exist for the given conversation.
public isAuthenticUser ( integer $conversationId, integer $userId ) : boolean
$conversationId integer
$userId integer
Результат boolean

isConversationExists() публичный Метод

make sure is this conversation exist for this user with currently loggedin user.
public isConversationExists ( integer $userId ) : boolean | integer
$userId integer
Результат boolean | integer

makeMessage() защищенный Метод

create a new message by using conversationId.
protected makeMessage ( integer $conversationId, string $message ) : Message
$conversationId integer
$message string
Результат Nahid\Talk\Messages\Message

makeMessageCollection() защищенный Метод

protected makeMessageCollection ( $conversations )

makeSeen() публичный Метод

make a message as seen.
public makeSeen ( integer $messageId ) : boolean
$messageId integer
Результат boolean

newConversation() защищенный Метод

make new conversation the given receiverId with currently loggedin user.
protected newConversation ( integer $receiverId ) : integer
$receiverId integer
Результат integer

readMessage() публичный Метод

read a single message by message id.
public readMessage ( integer $messageId = null ) : Message | boolean
$messageId integer
Результат Nahid\Talk\Messages\Message | boolean

sendMessage() публичный Метод

send a message by using converstionid.
public sendMessage ( $conversatonId, string $message ) : Message | boolean
$message string
Результат Nahid\Talk\Messages\Message | boolean

sendMessageByUserId() публичный Метод

create a new message by using receiverid.
public sendMessageByUserId ( integer $receiverId, string $message ) : Message
$receiverId integer
$message string
Результат Nahid\Talk\Messages\Message

setAuthUserId() публичный Метод

set currently authenticated user id for global usage.
public setAuthUserId ( integer $id = null ) : integer | boolean
$id integer
Результат integer | boolean

threads() публичный Метод

its a alias of getInbox method.
public threads ( $order = 'desc', integer $offset, integer $take = 20 ) : array
$offset integer
$take integer
Результат array

threads() публичный Метод

its a alias of getInbox method.
public threads ( integer $offset, integer $take = 20 ) : array
$offset integer
$take integer
Результат array

threadsAll() публичный Метод

its a alias of getInboxAll method.
public threadsAll ( $order = 'desc', integer $offset, integer $take = 20 ) : array
$offset integer
$take integer
Результат array

threadsAll() публичный Метод

its a alias of getInboxAll method.
public threadsAll ( integer $offset, integer $take = 20 ) : array
$offset integer
$take integer
Результат array

user() публичный Метод

* its set user id instantly when you fetch or access data. if you you haven't set authenticated user id globally or you want to fetch work with instant users information, you may use it
public user ( $id = null )
$id

Описание свойств

$authUserId защищенное свойство

Currently loggedin user id.
protected int $authUserId
Результат integer

$broadcast защищенное свойство

protected $broadcast

$config защищенное свойство

protected $config

$conversation защищенное свойство

The ConversationRepository class instance.
protected ConversationRepository,Nahid\Talk\Conversations $conversation
Результат Nahid\Talk\Conversations\ConversationRepository

$message защищенное свойство

The MessageRepository class instance.
protected MessageRepository,Nahid\Talk\Messages $message
Результат Nahid\Talk\Messages\MessageRepository