Bitrix API

Entity

AbstractYes

Table of Contents

Constants

ENTITY_TYPE_LANDING  = 'L'
Entity type 'LANDING'.
ENTITY_TYPE_SITE  = 'S'
Entity type 'SITE'.

Methods

__construct()  : mixed
Entity constructor.
bindLanding()  : bool
Bind landing for current entity.
bindSite()  : bool
Bind site for current entity.
getList()  : array<string|int, mixed>
Returns binding list of entities by specified binding type.
isForbiddenBindingAction()  : bool
onSiteChange()  : void
Call when site was changed (title, url, or 'delete' flag).
rebindSite()  : bool
Refreshes binding of site.
unbindLanding()  : bool
Unbind landing for current entity.
unbindSite()  : bool
Unbind site for current entity.

Constants

ENTITY_TYPE_LANDING

Entity type 'LANDING'.

public mixed ENTITY_TYPE_LANDING = 'L'

ENTITY_TYPE_SITE

Entity type 'SITE'.

public mixed ENTITY_TYPE_SITE = 'S'

Methods

__construct()

Entity constructor.

public __construct(mixed $code) : mixed
Parameters
$code : mixed

Binding code.

bindLanding()

Bind landing for current entity.

public bindLanding(int $landingId) : bool
Parameters
$landingId : int

Landing id.

Return values
bool

bindSite()

Bind site for current entity.

public bindSite(int $siteId) : bool
Parameters
$siteId : int

Site id.

Return values
bool

getList()

Returns binding list of entities by specified binding type.

public static getList([mixed $code = null ]) : array<string|int, mixed>
Parameters
$code : mixed = null

Binding code.

Return values
array<string|int, mixed>

isForbiddenBindingAction()

public isForbiddenBindingAction() : bool
Return values
bool

onSiteChange()

Call when site was changed (title, url, or 'delete' flag).

public static onSiteChange(int $siteId) : void
Parameters
$siteId : int

Site id.

rebindSite()

Refreshes binding of site.

public rebindSite(int $siteId) : bool
Parameters
$siteId : int

Site id.

Return values
bool

unbindLanding()

Unbind landing for current entity.

public unbindLanding(int $landingId) : bool
Parameters
$landingId : int

Landing id.

Return values
bool

unbindSite()

Unbind site for current entity.

public unbindSite(int $siteId) : bool
Parameters
$siteId : int

Site id.

Return values
bool

        
On this page

Search results