Класс Generator

Открытые члены
	__construct (int $sitemapId)
	init (int $step, array $state)
	setStep (int $step)
	getStep ()
	setState (array $state)
	getState ()
	getStatusMessage ()
	run ()

Защищенные члены
	runInit ()
	runFiles ()
	processDirectory ($dirData, File\Base $sitemapFile)
	runIblockIndex ()
	runIblock ()
	runForumIndex ()
	runForum ()
	runIndex ()
	finish ()
	getSitemapSettings ()

Защищенные статические члены
static	getTimeFinish ()

Защищенные данные
const	STEP_DURATION = 13
int	$sitemapId
array	$sitemapData = []
int	$step
array	$state
string	$statusMessage = ''

Подробное описание

Class for create sitemap files

См. определение в файле Generator.php строка 20

Конструктор(ы)

__construct()

__construct

(

int

$sitemapId

)

См. определение в файле Generator.php строка 57

Методы

finish()

finish ( )

protected

См. определение в файле Generator.php строка 1168

getSitemapSettings()

getSitemapSettings ( )

protected

For save in Sitemap table

Возвращает

array

См. определение в файле Generator.php строка 1181

getState()

getState

(

)

Return current state

Возвращает

array

См. определение в файле Generator.php строка 134

getStatusMessage()

getStatusMessage

(

)

Text message about current progress

Возвращает

string

См. определение в файле Generator.php строка 143

getStep()

getStep

(

)

Return current step (int value, not name)

Возвращает

int

См. определение в файле Generator.php строка 113

getTimeFinish()

static getTimeFinish ( )

staticprotected

Return microtime, when current step must be stopped

Возвращает

float

См. определение в файле Generator.php строка 1194

init()

init	(	int	$step,
		array	$state )

Init current parameter for generator run

Аргументы

int	$step
array	$state

Возвращает

void

См. определение в файле Generator.php строка 82

processDirectory()

processDirectory ( $dirData, File\Base $sitemapFile )

protected

Add files from directory to sitemap

Аргументы

	$dirData
File\Base	$sitemapFile

Возвращает

void

См. определение в файле Generator.php строка 335

run()

run

(

)

Возвращает

bool - false if error in process

См. определение в файле Generator.php строка 151

runFiles()

runFiles ( )

protected

См. определение в файле Generator.php строка 234

runForum()

runForum ( )

protected

См. определение в файле Generator.php строка 925

runForumIndex()

runForumIndex ( )

protected

См. определение в файле Generator.php строка 861

runIblock()

runIblock ( )

protected

См. определение в файле Generator.php строка 499

runIblockIndex()

runIblockIndex ( )

protected

См. определение в файле Generator.php строка 443

runIndex()

runIndex ( )

protected

См. определение в файле Generator.php строка 1108

runInit()

runInit ( )

protected

Clear previously, and init new Runtime

Возвращает

bool

См. определение в файле Generator.php строка 200

setState()

setState

(

array

$state

)

Initialize current state

Аргументы

array

$state

Возвращает

Generator

См. определение в файле Generator.php строка 123

setStep()

setStep

(

int

$step

)

Set current step (by value, not name)

Аргументы

int

$step

Возвращает

Generator

См. определение в файле Generator.php строка 96

Данные класса

$sitemapData

array $sitemapData = []

protected

См. определение в файле Generator.php строка 37

$sitemapId

int $sitemapId

protected

См. определение в файле Generator.php строка 31

$state

array $state

protected

См. определение в файле Generator.php строка 49

$statusMessage

string $statusMessage = ''

protected

См. определение в файле Generator.php строка 55

$step

int $step

protected

См. определение в файле Generator.php строка 43

STEP_DURATION

const STEP_DURATION = 13

protected

Max time of run one step, in seconds

См. определение в файле Generator.php строка 25