AutomaticScanStarter
in package
Uses
UtilsProvider
Automatically start the scan process when the user has first interaction with the plugin.
Table of Contents
Constants
- OPTION_NAME = RCB_OPT_PREFIX . '-automatic-scan-starter'
- REAL_QUEUE_TYPE = 'rcb-automatic-scan-starter'
- STATUS_INITIALIZED = 'initialized'
- STATUS_PENDING = 'pending'
- STATUS_STARTED = 'started'
Methods
- addJobToQueue() : mixed
- Add the job to start the scanner to the `real-queue`.
- getPluginConstantPrefix() : string
- Get the prefix of this plugin so composer packages can dynamically build other constant values on it.
- getStatus() : string
- Get the status of the automatic scan process.
- instance() : mixed
- New instance.
- probablyAddClientJob() : mixed
- Check if the job to start the scanner can be added.
- __construct() : mixed
- C'tor.
Constants
OPTION_NAME
public
mixed
OPTION_NAME
= RCB_OPT_PREFIX . '-automatic-scan-starter'
REAL_QUEUE_TYPE
public
mixed
REAL_QUEUE_TYPE
= 'rcb-automatic-scan-starter'
STATUS_INITIALIZED
public
mixed
STATUS_INITIALIZED
= 'initialized'
STATUS_PENDING
public
mixed
STATUS_PENDING
= 'pending'
STATUS_STARTED
public
mixed
STATUS_STARTED
= 'started'
Methods
addJobToQueue()
Add the job to start the scanner to the `real-queue`.
public
addJobToQueue() : mixed
getPluginConstantPrefix()
Get the prefix of this plugin so composer packages can dynamically build other constant values on it.
public
getPluginConstantPrefix() : string
Tags
Return values
stringgetStatus()
Get the status of the automatic scan process.
public
getStatus() : string
Return values
stringinstance()
New instance.
public
static instance() : mixed
Tags
probablyAddClientJob()
Check if the job to start the scanner can be added.
public
probablyAddClientJob() : mixed
__construct()
C'tor.
private
__construct() : mixed