Bitrix API

B24button 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.
fieldsHash()  : string
Get unique hash from hook fields.
getButtonIdByCode()  : bool|string
Find button ID by script code
getButtons()  : array<string|int, mixed>
Get b24 buttons.
getButtonsData()  : array<string|int, mixed>|null
Get raw data of b24 buttons
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.
getPageTitle()  : string
Title of page Hook, if you want.
getSort()  : int
Get sort of block (execute order).
getTitle()  : string
Title of Hook, if you want.
isFree()  : bool
Enable only in high plan or not.
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.
setCustomExec()  : void
Set custom exec method.
setData()  : void
Set data to the fields current hook.

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

fieldsHash()

Get unique hash from hook fields.

public fieldsHash() : string
Return values
string

getButtonIdByCode()

Find button ID by script code

public static getButtonIdByCode(mixed $code) : bool|string
Parameters
$code : mixed
  • script for button
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
LoaderException
throws
SystemException
Return values
bool|string

getButtons()

Get b24 buttons.

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

getButtonsData()

Get raw data of b24 buttons

public static getButtonsData() : array<string|int, mixed>|null
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
LoaderException
throws
SystemException
Return values
array<string|int, mixed>|null

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>

getPageTitle()

Title of page Hook, if you want.

public getPageTitle() : string
Return values
string

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 or not.

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

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.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results