Класс Generation

Открытые члены
	__construct ()
	getAuthorId ()
	setChatId (int $chatId)
	getChatId ()
	setScenario (IScenario $scenario)
	getScenario ()
	setSiteData (Data\Site $siteData)
	getSiteData ()
	getData (?string $key=null)
	setData (string $key, mixed $data)
	deleteData (string $key)
	setWishes (Data\Wishes $wishes)
	getId ()
	getStep ()
	getTimer ()
	initById (int $generationId)
	initBySiteId (int $siteId, IScenario $scenario)
	execute ()
	finish ()
	isFinished ()
	isError ()
	clearErrors ()
	getEvent ()
	getBlocksData (array $blocks)

Открытые статические члены
static	checkExists (int $id)

Защищенные данные
Generation Event	$event = null

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

This class is responsible for generating site content using various managers and connectors.

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

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

__construct()

__construct

(

)

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

Методы

checkExists()

checkExists ( int $id )

static

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

clearErrors()

clearErrors

(

)

Prepare scenario to restart generation after error

Возвращает

$this

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

deleteData()

deleteData

(

string

$key

)

Delete one key from data

Аргументы

string

$key

Возвращает

void

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

execute()

execute

(

)

Run process.

Возвращает

bool - false if error while executing

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

finish()

finish

(

)

Finish all generation processed, mark as completed

Возвращает

void

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

getAuthorId()

getAuthorId

(

)

ID of user who created the site

Возвращает

int

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

getBlocksData()

getBlocksData

(

array

$blocks

)

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

getChatId()

getChatId

(

)

If generation started by chat - get ID

Возвращает

int|null

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

getData()

getData

(

?string

$key = null

)

Get custom data for generations

Аргументы

string | null

$key

Возвращает

mixed|null - null if key not set

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

getEvent()

getEvent

(

)

Get object for send front and backend events

Возвращает

Generation\Event

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

getId()

getId

(

)

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

getScenario()

getScenario

(

)

Возвращает

IScenario|null

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

getSiteData()

getSiteData

(

)

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

getStep()

getStep

(

)

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

getTimer()

getTimer

(

)

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

initById()

initById

(

int

$generationId

)

Try to find exists generation and init current by them data

Аргументы

int

$generationId

Возвращает

bool

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

initBySiteId()

initBySiteId	(	int	$siteId,
		IScenario	$scenario )

Try to find exists generation by site ID and init current by them data

Аргументы

int	$siteId
IScenario	$scenario

Возвращает

bool

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

isError()

isError

(

)

Check if at least one scenario step has error and not execute

Возвращает

bool

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

isFinished()

isFinished

(

)

Check if scenario execute all steps

Возвращает

bool

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

setChatId()

setChatId

(

int

$chatId

)

If generation start by chat - set ID

Аргументы

int

$chatId

Возвращает

Generation

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

setData()

setData	(	string	$key,
		mixed	$data )

Set custom data for generations

Аргументы

string	$key
mixed	$data

Возвращает

void

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

setScenario()

setScenario

(

IScenario

$scenario

)

Аргументы

IScenario

$scenario

Возвращает

Generation

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

setSiteData()

setSiteData

(

Data\Site

$siteData

)

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

setWishes()

setWishes

(

Data\Wishes

$wishes

)

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

Поля

$event

Generation Event $event = null

protected

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

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/landing/lib/Copilot/Generation.php