Chat_Room_Action
extends Action
in package
Uses
ExposeMethod
Chat Entries Action Class.
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 with a list of allowed methods.
- addToFavorites() : mixed
- Add to favorites.
- checkPermission() : mixed
- Function to check permission.
- 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.
- removeFromFavorites() : mixed
- Remove from favorites.
- removeUserFromRoom() : mixed
- Remove user from room.
- sendHeaders() : mixed
- Send headers.
- validateRequest() : void
- Function to validate request method.
- exposeMethod() : mixed
- Function that will expose methods for external access.
- checkPermissionByRoom() : void
- Check permission by room.
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 with a list of allowed methods.
public
__construct() : mixed
Return values
mixed —addToFavorites()
Add to favorites.
public
addToFavorites(Request $request) : mixed
Parameters
- $request : Request
Tags
Return values
mixed —checkPermission()
Function to check permission.
public
checkPermission(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 —removeFromFavorites()
Remove from favorites.
public
removeFromFavorites(Request $request) : mixed
Parameters
- $request : Request
Tags
Return values
mixed —removeUserFromRoom()
Remove user from room.
public
removeUserFromRoom(Request $request) : mixed
Parameters
- $request : Request
Tags
Return values
mixed —sendHeaders()
Send headers.
public
sendHeaders() : mixed
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 —checkPermissionByRoom()
Check permission by room.
private
checkPermissionByRoom(Request $request) : void
Parameters
- $request : Request