Bitrix API

Copyright extends Page

Table of Contents

Methods

__construct()  : mixed
Class constructor.
dataExist()  : bool
Exist or not data in this hook.
enabled()  : bool
Enable or not the hook.
enabledInEditMode()  : bool
Exec or not hook in edit mode.
enabledInIntranetMode()  : bool
Exec or not hook in intranet mode.
exec()  : void
Exec hook. Now do nothing, because using print in template
fieldsHash()  : string
Get unique hash from hook fields.
getCode()  : string
Get code of hook.
getDescription()  : string
Description of Hook, if you want.
getFields()  : array<string|int, Field>
Get fields of current Page Hook.
getLockedMessage()  : string
Gets message for locked state.
getPageFields()  : array<string|int, mixed>
Get fields of current Page Hook in Page context.
getRandomPhraseId()  : int
Get random text code from collection
getSort()  : int
Get sort of block (execute order).
getTitle()  : string
Title of Hook, if you want.
isFree()  : bool
Enable only in high plan.
isLocked()  : bool
Locked or not current hook in free plan.
isNeedPublication()  : bool
isPage()  : bool
This hook is instance for page?
issetCustomExec()  : bool
If isset custom exec method.
onCopy()  : array<string|int, mixed>|null
Hook copy handler for save editor value, randomizer
setCustomExec()  : void
Set custom exec method.
setData()  : void
Set data to the fields current hook.
setLang()  : void
Save current site language
setSiteId()  : void
Save current site id
view()  : string
Return footer html

Methods

__construct()

Class constructor.

public __construct([bool $editMode = false ][, bool $isPage = true ]) : mixed
Parameters
$editMode : bool = false

Edit mode if true.

$isPage : bool = true

Instance of page.

dataExist()

Exist or not data in this hook.

public dataExist() : bool
Return values
bool

enabled()

Enable or not the hook.

public enabled() : bool
Return values
bool

enabledInEditMode()

Exec or not hook in edit mode.

public enabledInEditMode() : bool
Return values
bool

enabledInIntranetMode()

Exec or not hook in intranet mode.

public enabledInIntranetMode() : bool
Return values
bool

exec()

Exec hook. Now do nothing, because using print in template

public exec() : void

fieldsHash()

Get unique hash from hook fields.

public fieldsHash() : string
Return values
string

getCode()

Get code of hook.

public getCode() : string
Return values
string

getDescription()

Description of Hook, if you want.

public getDescription() : string
Return values
string

getFields()

Get fields of current Page Hook.

public getFields() : array<string|int, Field>
Return values
array<string|int, Field>

getLockedMessage()

Gets message for locked state.

public getLockedMessage() : string
Return values
string

getPageFields()

Get fields of current Page Hook in Page context.

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

getRandomPhraseId()

Get random text code from collection

public static getRandomPhraseId() : int
Return values
int

getSort()

Get sort of block (execute order).

public getSort() : int
Return values
int

getTitle()

Title of Hook, if you want.

public getTitle() : string
Return values
string

isFree()

Enable only in high plan.

public isFree() : bool
Return values
bool

isLocked()

Locked or not current hook in free plan.

public isLocked() : bool
Return values
bool

isNeedPublication()

public isNeedPublication() : bool
Return values
bool —
  • true if hook change required forced page/site publication

isPage()

This hook is instance for page?

public isPage() : bool
Return values
bool

issetCustomExec()

If isset custom exec method.

public issetCustomExec() : bool
Return values
bool

onCopy()

Hook copy handler for save editor value, randomizer

public static onCopy(array<string|int, mixed>|null $data, int $entityId, string $type[, bool $publication = false ]) : array<string|int, mixed>|null
Parameters
$data : array<string|int, mixed>|null

Data.

$entityId : int

Entity.

$type : string

Type.

$publication : bool = false

Is publication.

Return values
array<string|int, mixed>|null

setCustomExec()

Set custom exec method.

public setCustomExec(callable $callback) : void
Parameters
$callback : callable

Callback function.

setData()

Set data to the fields current hook.

public setData(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>

Data array.

setLang()

Save current site language

public setLang(string|null $lang) : void
Parameters
$lang : string|null

Language.

setSiteId()

Save current site id

public setSiteId(int|null $siteId) : void
Parameters
$siteId : int|null

SiteId.

view()

Return footer html

public view() : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results