PHP Class Nahid\Talk\Talk

Author: Nahid Bin Azhar
Datei anzeigen Open project: nahid/talk

Protected Properties

Property Type Description
$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.

Public Methods

Method Description
__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

Protected Methods

Method Description
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.

Method Details

__construct() public method

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() public method

Initialize and instantiate conversation and message repositories.
public __construct ( ConversationRepository $conversation, MessageRepository $message ) : void
$conversation Nahid\Talk\Conversations\ConversationRepository
$message Nahid\Talk\Messages\MessageRepository
return void

deleteConversations() public method

delete message threat or conversation by conversation id.
public deleteConversations ( integer $id ) : boolean
$id integer
return boolean

deleteForever() public method

permanently delete message for this id.
public deleteForever ( integer $messageId ) : boolean
$messageId integer
return boolean

deleteMessage() public method

delete a specific message, its a softdelete process. All message stored in db.
public deleteMessage ( integer $messageId ) : boolean
$messageId integer
return boolean

deleteThread() public method

its an alias of deleteConversations.
public deleteThread ( integer $id = null ) : boolean
$id integer
return boolean

getConversationsAllById() public method

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
return Nahid\Talk\Messages\Message

getConversationsAllByUserId() public method

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
return Nahid\Talk\Messages\Message | boolean

getConversationsById() public method

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
return Nahid\Talk\Messages\Message

getConversationsByUserId() public method

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
return Nahid\Talk\Messages\Message | boolean

getInbox() public method

fetch all inbox for currently loggedin user with pagination.
public getInbox ( $order = 'desc', integer $offset, integer $take = 20 ) : array
$offset integer
$take integer
return array

getInbox() public method

fetch all inbox for currently loggedin user with pagination.
public getInbox ( integer $offset, integer $take = 20 ) : array
$offset integer
$take integer
return array

getInboxAll() public method

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
return array

getInboxAll() public method

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
return array

getMessages() public method

its an alias of getConversationById.
public getMessages ( integer $conversationId ) : Message | boolean
$conversationId integer
return Nahid\Talk\Messages\Message | boolean

getMessages() public method

its an alias of getConversationById.
public getMessages ( integer $conversationId, $offset, $take = 20 ) : Message | boolean
$conversationId integer
return Nahid\Talk\Messages\Message | boolean

getMessagesAll() public method

its an alias of getConversationAllById.
public getMessagesAll ( integer $conversationId, $offset, $take = 20 ) : Message | boolean
$conversationId integer
return Nahid\Talk\Messages\Message | boolean

getMessagesAllByUserId() public method

its an alias by getConversationAllByUserId.
public getMessagesAllByUserId ( $userId, $offset, $take = 20 ) : Message | boolean
return Nahid\Talk\Messages\Message | boolean

getMessagesByUserId() public method

its an alias by getConversationByUserId.
public getMessagesByUserId ( $userId ) : Message | boolean
return Nahid\Talk\Messages\Message | boolean

getMessagesByUserId() public method

its an alias by getConversationByUserId.
public getMessagesByUserId ( $userId, $offset, $take = 20 ) : Message | boolean
return Nahid\Talk\Messages\Message | boolean

getReceiverInfo() public method

get receiver information for this conversation.
Deprecation: since version 2.0.0 Remove it from version 2.0.2
public getReceiverInfo ( integer $conversationId ) : UserModel
$conversationId integer
return UserModel

getSerializeUser() protected method

make two users as serialize with ascending order.
protected getSerializeUser ( integer $user1, integer $user2 ) : array
$user1 integer
$user2 integer
return array

isAuthenticUser() public method

check the given user exist for the given conversation.
public isAuthenticUser ( integer $conversationId, integer $userId ) : boolean
$conversationId integer
$userId integer
return boolean

isConversationExists() public method

make sure is this conversation exist for this user with currently loggedin user.
public isConversationExists ( integer $userId ) : boolean | integer
$userId integer
return boolean | integer

makeMessage() protected method

create a new message by using conversationId.
protected makeMessage ( integer $conversationId, string $message ) : Message
$conversationId integer
$message string
return Nahid\Talk\Messages\Message

makeMessageCollection() protected method

protected makeMessageCollection ( $conversations )

makeSeen() public method

make a message as seen.
public makeSeen ( integer $messageId ) : boolean
$messageId integer
return boolean

newConversation() protected method

make new conversation the given receiverId with currently loggedin user.
protected newConversation ( integer $receiverId ) : integer
$receiverId integer
return integer

readMessage() public method

read a single message by message id.
public readMessage ( integer $messageId = null ) : Message | boolean
$messageId integer
return Nahid\Talk\Messages\Message | boolean

sendMessage() public method

send a message by using converstionid.
public sendMessage ( $conversatonId, string $message ) : Message | boolean
$message string
return Nahid\Talk\Messages\Message | boolean

sendMessageByUserId() public method

create a new message by using receiverid.
public sendMessageByUserId ( integer $receiverId, string $message ) : Message
$receiverId integer
$message string
return Nahid\Talk\Messages\Message

setAuthUserId() public method

set currently authenticated user id for global usage.
public setAuthUserId ( integer $id = null ) : integer | boolean
$id integer
return integer | boolean

threads() public method

its a alias of getInbox method.
public threads ( $order = 'desc', integer $offset, integer $take = 20 ) : array
$offset integer
$take integer
return array

threads() public method

its a alias of getInbox method.
public threads ( integer $offset, integer $take = 20 ) : array
$offset integer
$take integer
return array

threadsAll() public method

its a alias of getInboxAll method.
public threadsAll ( $order = 'desc', integer $offset, integer $take = 20 ) : array
$offset integer
$take integer
return array

threadsAll() public method

its a alias of getInboxAll method.
public threadsAll ( integer $offset, integer $take = 20 ) : array
$offset integer
$take integer
return array

user() public method

* 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

Property Details

$authUserId protected_oe property

Currently loggedin user id.
protected int $authUserId
return integer

$broadcast protected_oe property

protected $broadcast

$config protected_oe property

protected $config

$conversation protected_oe property

The ConversationRepository class instance.
protected ConversationRepository,Nahid\Talk\Conversations $conversation
return Nahid\Talk\Conversations\ConversationRepository

$message protected_oe property

The MessageRepository class instance.
protected MessageRepository,Nahid\Talk\Messages $message
return Nahid\Talk\Messages\MessageRepository