Bitrix API

IntranetManager

Table of Contents

Methods

deleteCustomPagesByEntityTypeId()  : Result
getCustomSection()  : CustomSection|null
getCustomSectionByEntityTypeId()  : CustomSection|null
Returns first custom section that contains the provided entity type
getCustomSections()  : array<string|int, CustomSection>|null
Returns array of custom sections that are associated with CRM
getEntityTypeIdByPageSettings()  : int|null
Extracts entityTypeId from page settings if its possible
getEntityTypesInCustomSection()  : array<string|int, mixed>
getEntityTypesInCustomSections()  : array<string|int, int>
getUrlForCustomSection()  : Uri|null
getUrlForCustomSectionPage()  : Uri|null
Returns url for a custom section page
isCustomSectionExists()  : bool
isCustomSectionsAvailable()  : bool
Return true if intranet custom pages api available.
isEntityTypeInCustomSection()  : bool
Returns true if the specified entity type is included in a custom section
isExternalUser()  : bool
Check if user is extranet user
isSubordinate()  : mixed
isSupervisor()  : bool
Check if user is head of any company departmant
preparePageSettingsForItemsList()  : string
Returns page settings for item list of the specified entity type

Methods

deleteCustomPagesByEntityTypeId()

public static deleteCustomPagesByEntityTypeId(int $entityTypeId) : Result
Parameters
$entityTypeId : int
Return values
Result

getCustomSectionByEntityTypeId()

Returns first custom section that contains the provided entity type

public static getCustomSectionByEntityTypeId(int $entityTypeId) : CustomSection|null
Parameters
$entityTypeId : int
  • entity type to find
Return values
CustomSection|null

getCustomSections()

Returns array of custom sections that are associated with CRM

public static getCustomSections() : array<string|int, CustomSection>|null
Return values
array<string|int, CustomSection>|null

getEntityTypeIdByPageSettings()

Extracts entityTypeId from page settings if its possible

public static getEntityTypeIdByPageSettings(string $pageSettings) : int|null
Parameters
$pageSettings : string
Return values
int|null

getEntityTypesInCustomSection()

public static getEntityTypesInCustomSection(string $customSectionCode) : array<string|int, mixed>
Parameters
$customSectionCode : string
Return values
array<string|int, mixed>

getEntityTypesInCustomSections()

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

getUrlForCustomSectionPage()

Returns url for a custom section page

public static getUrlForCustomSectionPage(string $customSectionCode, string $pageCode) : Uri|null
Parameters
$customSectionCode : string
$pageCode : string
Return values
Uri|null

isCustomSectionExists()

public static isCustomSectionExists(string|null $customSectionCode) : bool
Parameters
$customSectionCode : string|null
Return values
bool

isCustomSectionsAvailable()

Return true if intranet custom pages api available.

public static isCustomSectionsAvailable() : bool
Return values
bool

isEntityTypeInCustomSection()

Returns true if the specified entity type is included in a custom section

public static isEntityTypeInCustomSection(int $entityTypeId) : bool
Parameters
$entityTypeId : int
Return values
bool

isExternalUser()

Check if user is extranet user

public static isExternalUser(int $userID) : bool
Parameters
$userID : int

User ID

Return values
bool

isSubordinate()

public static isSubordinate(mixed $employeeID, mixed $managerID) : mixed
Parameters
$employeeID : mixed
$managerID : mixed

isSupervisor()

Check if user is head of any company departmant

public static isSupervisor(int $userID) : bool
Parameters
$userID : int

User ID

Return values
bool

preparePageSettingsForItemsList()

Returns page settings for item list of the specified entity type

public static preparePageSettingsForItemsList(int $entityTypeId) : string
Parameters
$entityTypeId : int
Return values
string

        
On this page

Search results