PHP 클래스 Nahid\Talk\Talk

저자: Nahid Bin Azhar
파일 보기 프로젝트 열기: nahid/talk

보호된 프로퍼티들

프로퍼티 타입 설명
$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