Generator
Class for create sitemap files
Table of Contents
Methods
- __construct() : mixed
- getState() : array<string|int, mixed>
- Return current state
- getStatusMessage() : string
- Text message about current progress
- getStep() : int
- Return current step (int value, not name)
- init() : Generator
- Init current parameter for generator run
- run() : bool
Methods
__construct()
public
__construct(int $sitemapId) : mixed
Parameters
- $sitemapId : int
getState()
Return current state
public
getState() : array<string|int, mixed>
Return values
array<string|int, mixed>getStatusMessage()
Text message about current progress
public
getStatusMessage() : string
Return values
stringgetStep()
Return current step (int value, not name)
public
getStep() : int
Return values
intinit()
Init current parameter for generator run
public
init(int $step, array<string|int, mixed> $state) : Generator
Parameters
- $step : int
- $state : array<string|int, mixed>
Return values
Generatorrun()
public
run() : bool
Return values
bool —- false if error in process