Job
Control process of sitemap generation. Multistep, reload, agent etc
Table of Contents
Constants
- STATUS_ERROR = 'E'
- STATUS_FINISH = 'F'
- STATUS_PROCESS = 'P'
- STATUS_REGISTER = 'R'
- Statuses of current job
Methods
- addJob() : Job|null
- Register new job or get existing
- clearBySitemap() : mixed
- doJobAgent() : string
- Method for run agent
- doStep() : Result
- Run one step of generation
- findJob() : Job|null
- Find job for sitemap, If find - return object, null if not
- getData() : array<string|int, mixed>
- Get data od generation process
- markToRegenerate() : bool
- Create agent for automatic re-generate sitemap in background.
Constants
STATUS_ERROR
public
mixed
STATUS_ERROR
= 'E'
STATUS_FINISH
public
mixed
STATUS_FINISH
= 'F'
STATUS_PROCESS
public
mixed
STATUS_PROCESS
= 'P'
STATUS_REGISTER
Statuses of current job
public
mixed
STATUS_REGISTER
= 'R'
Methods
addJob()
Register new job or get existing
public
static addJob(int $sitemapId) : Job|null
Parameters
- $sitemapId : int
-
Id of map.
Tags
Return values
Job|nullclearBySitemap()
public
static clearBySitemap(int $sitemapId) : mixed
Parameters
- $sitemapId : int
doJobAgent()
Method for run agent
public
static doJobAgent(int $sitemapId) : string
Parameters
- $sitemapId : int
-
Id of map.
Return values
stringdoStep()
Run one step of generation
public
doStep() : Result
Return values
ResultfindJob()
Find job for sitemap, If find - return object, null if not
public
static findJob(int $sitemapId) : Job|null
Parameters
- $sitemapId : int
-
Id of map.
Return values
Job|nullgetData()
Get data od generation process
public
getData() : array<string|int, mixed>
Return values
array<string|int, mixed>markToRegenerate()
Create agent for automatic re-generate sitemap in background.
public
static markToRegenerate(int $sitemapId) : bool
Parameters
- $sitemapId : int
-
Id of map.