Chat_ChatAjax_Action
extends Action
in package
Uses
ExposeMethod
Action to get Chat data.
Tags
Table of Contents
- $headers : Headers
- $activatedLocale : bool
- $exposedMethods : array<string|int, string>
- Control the exposure of methods to be invoked from client (kind-of RPC).
- $csrfInitiated : bool
- __construct() : mixed
- Constructor.
- addParticipant() : mixed
- Add participant.
- addPrivateRoom() : mixed
- Add private room.
- archivePrivateRoom() : mixed
- Archive rooms.
- checkPermission() : mixed
- {@inheritdoc}
- getChatConfig() : void
- Get chat init data.
- getHistory() : mixed
- Get history.
- getMessages() : mixed
- Get messages from chat.
- getMoreMessages() : mixed
- Get more messages from chat.
- getRecordRoom() : mixed
- Show chat for record.
- getRoomPrivateUnpinnedUsers() : mixed
- Get room private unpinned users.
- getRooms() : mixed
- Get rooms function.
- getRoomsMessages() : mixed
- Get rooms messages from chat.
- getRoomsUnpinned() : void
- Get rooms unpinned.
- getUnread() : mixed
- Get all unread messages.
- invokeExposedMethod() : type
- Function invokes exposed methods for this class.
- isMethodExposed() : bool
- Function checks if the method is exposed for client usage.
- isSessionExtend() : mixed
- {@inheritdoc}
- loginRequired() : bool
- Function to check login required permission.
- postProcess() : mixed
- Post process function.
- postProcessAjax() : mixed
- Post process ajax function.
- preProcess() : mixed
- Pre process function.
- preProcessAjax() : mixed
- Pre process ajax function.
- process() : mixed
- Process function.
- search() : mixed
- Search meassages.
- send() : mixed
- Send message function.
- sendHeaders() : mixed
- Send headers.
- setMessagesResult() : mixed
- Set messages result.
- validateRequest() : void
- Function to validate request method.
- exposeMethod() : mixed
- Function that will expose methods for external access.
- isNextPage() : bool
- Check if there are more messages.
Properties
$headers
public
Headers
$headers
Headers instance.
$activatedLocale
protected
static bool
$activatedLocale
= false
Activated language locale.
$exposedMethods
Control the exposure of methods to be invoked from client (kind-of RPC).
protected
array<string|int, string>
$exposedMethods
= []
$csrfInitiated
private
static bool
$csrfInitiated
= false
CSRF already initiated.
Methods
__construct()
Constructor.
public
__construct() : mixed
Return values
mixed —addParticipant()
Add participant.
public
addParticipant(Request $request) : mixed
Parameters
- $request : Request
Tags
Return values
mixed —addPrivateRoom()
Add private room.
public
addPrivateRoom(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —archivePrivateRoom()
Archive rooms.
public
archivePrivateRoom(Request $request) : mixed
Parameters
- $request : Request
Tags
Return values
mixed —checkPermission()
{@inheritdoc}
public
checkPermission(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —getChatConfig()
Get chat init data.
public
getChatConfig(Request $request) : void
Parameters
- $request : Request
Return values
void —getHistory()
Get history.
public
getHistory(Request $request) : mixed
Parameters
- $request : Request
Tags
Return values
mixed —getMessages()
Get messages from chat.
public
getMessages(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —getMoreMessages()
Get more messages from chat.
public
getMoreMessages(Request $request) : mixed
Parameters
- $request : Request
Tags
Return values
mixed —getRecordRoom()
Show chat for record.
public
getRecordRoom(Request $request) : mixed
Parameters
- $request : Request
Tags
Return values
mixed —getRoomPrivateUnpinnedUsers()
Get room private unpinned users.
public
getRoomPrivateUnpinnedUsers(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —getRooms()
Get rooms function.
public
getRooms(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —getRoomsMessages()
Get rooms messages from chat.
public
getRoomsMessages(Request $request) : mixed
Parameters
- $request : Request
Tags
Return values
mixed —getRoomsUnpinned()
Get rooms unpinned.
public
getRoomsUnpinned(Request $request) : void
Parameters
- $request : Request
Return values
void —getUnread()
Get all unread messages.
public
getUnread(Request $request) : mixed
Parameters
- $request : Request
Tags
Return values
mixed —invokeExposedMethod()
Function invokes exposed methods for this class.
public
invokeExposedMethod() : type
Tags
Return values
type —isMethodExposed()
Function checks if the method is exposed for client usage.
public
isMethodExposed(string $name) : bool
Parameters
- $name : string
-
- method name
Return values
bool —isSessionExtend()
{@inheritdoc}
public
isSessionExtend(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —loginRequired()
Function to check login required permission.
public
loginRequired() : bool
Return values
bool —postProcess()
Post process function.
public
postProcess(Request $request[, bool $display = true ]) : mixed
Parameters
- $request : Request
- $display : bool = true
Return values
mixed —postProcessAjax()
Post process ajax function.
public
postProcessAjax(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —preProcess()
Pre process function.
public
preProcess(Request $request[, bool $display = true ]) : mixed
Parameters
- $request : Request
- $display : bool = true
Return values
mixed —preProcessAjax()
Pre process ajax function.
public
preProcessAjax(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —process()
Process function.
public
abstract process(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —search()
Search meassages.
public
search(Request $request) : mixed
Parameters
- $request : Request
Tags
Return values
mixed —send()
Send message function.
public
send(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —sendHeaders()
Send headers.
public
sendHeaders() : mixed
Return values
mixed —setMessagesResult()
Set messages result.
public
setMessagesResult(Request $request) : mixed
Parameters
- $request : Request
Tags
Return values
mixed —validateRequest()
Function to validate request method.
public
validateRequest(Request $request) : void
Parameters
- $request : Request
Return values
void —exposeMethod()
Function that will expose methods for external access.
protected
exposeMethod(string $name) : mixed
Parameters
- $name : string
-
- method name
Return values
mixed —isNextPage()
Check if there are more messages.
private
isNextPage(int $numberOfMessages) : bool
Parameters
- $numberOfMessages : int