Bitrix API

MyReference extends Dummy

Table of Contents

Methods

checkBeforeSave()  : Result
Must return false, if block data is not correct for saving.
getData()  : array<string|int, mixed>
Optionally transforms data before giving out.
getDefaultData()  : array<string|int, mixed>
Returns block form's manifest.
getManifest()  : array<string|int, mixed>
Returns block's manifest.
getViewData()  : array<string|int, mixed>
isEmpty()  : bool
Returns true, if block is empty (no data).
wasUpdatedOnBlank()  : void
Calls when block success added or updated on blank.

Methods

checkBeforeSave()

Must return false, if block data is not correct for saving.

public static checkBeforeSave(Block $block) : Result
Parameters
$block : Block

Block instance.

Return values
Result

getData()

Optionally transforms data before giving out.

public static getData(array<string|int, mixed> $data, Document|null $document) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

Data to set.

$document : Document|null

Document instance, if we're within document context.

Return values
array<string|int, mixed>

getDefaultData()

Returns block form's manifest.

public static getDefaultData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getManifest()

Returns block's manifest.

public static getManifest() : array<string|int, mixed>
Return values
array<string|int, mixed>

getViewData()

public static getViewData(array<string|int, mixed> $data, Document|null $document) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$document : Document|null
Return values
array<string|int, mixed>

isEmpty()

Returns true, if block is empty (no data).

public static isEmpty(array<string|int, mixed> $data) : bool
Parameters
$data : array<string|int, mixed>

Block's data.

Return values
bool

wasUpdatedOnBlank()

Calls when block success added or updated on blank.

public static wasUpdatedOnBlank(Block $block) : void
Parameters
$block : Block

Block instance.


        
On this page

Search results