\MessageQueueTask

Message Queue Task

Summary

Methods
Properties
Constants
mainAction()
quiet()
consoleLog()
quit()
log()
inputMasked()
finish()
No public properties found
No constants found
getClientList()
$loud
N/A
handleQueuedMessages()
$queueable
N/A

Properties

$loud

$loud : 

Type

$queueable

$queueable : 

Type

Methods

mainAction()

mainAction(  $params = null) 

Default handler, override for default action.

Otherwise, will print actions for task

Parameters

$params

quiet()

quiet() 

Quiet the console

consoleLog()

consoleLog(string  $message, string  $color = 'green', boolean  $endline = true) 

Log output to console. Provides easy way to color output

Parameters

string $message
string $color
boolean $endline

set "false" to disable output clearing

quit()

quit(string  $message) 

Quit and dump the error

Parameters

string $message

log()

log(string  $message, string  $log_file = '/tmp/app.log') 

Log output

Parameters

string $message
string $log_file

Location of log file

inputMasked()

inputMasked(  $message,   $color = 'green') 

Parameters

$message
$color

finish()

finish() 

Finish is called after everything else has run. This checks the queued messages per user and processes all pending messages

getClientList()

getClientList() : Array

Determines installed CEO clients based on installed configs.

Returns

Array —

client codes

handleQueuedMessages()

handleQueuedMessages(  $user,   $queuedMessages) 

Handles messages on a per user basis

Parameters

$user
$queuedMessages