Bitrix API

CatalogBuilder extends IblockBuilder

Table of Contents

Constants

ENTITY_ELEMENT  = 'element'
ENTITY_SECTION  = 'section'
PAGE_CATALOG_SEO  = 'catalogSeo'
PAGE_ELEMENT_COPY  = 'elementCopy'
PAGE_ELEMENT_DETAIL  = 'elementDetail'
PAGE_ELEMENT_LIST  = 'elementList'
PAGE_ELEMENT_SAVE  = 'elementSave'
PAGE_ELEMENT_SEARCH  = 'elementSearch'
PAGE_ELEMENT_SEO  = 'elementSeo'
PAGE_OFFER_DETAIL  = 'offerDetail'
PAGE_SECTION_COPY  = 'sectionCopy'
PAGE_SECTION_DETAIL  = 'sectionDetail'
PAGE_SECTION_LIST  = 'sectionList'
PAGE_SECTION_SAVE  = 'sectionSave'
PAGE_SECTION_SEARCH  = 'sectionSearch'
PAGE_SECTION_SEO  = 'sectionSeo'
TYPE_AUTODETECT  = 'AUTO'
TYPE_ID  = 'CATALOG'

Methods

__construct()  : mixed
__destruct()  : mixed
clearPreloadedUrlData()  : void
getBaseParams()  : string
getCatalogSeoUrl()  : string
getCompiledParams()  : string
getContextMenuItems()  : array<string|int, mixed>|null
getDetailPageSlider()  : string
getElementCopyUrl()  : string
getElementDetailUrl()  : string
getElementListUrl()  : string
getElementSaveUrl()  : string
getElementSearchUrl()  : string
getElementSeoUrl()  : string
getId()  : string
getLanguageId()  : string
getLanguageParam()  : string
getListMode()  : string
getPrefix()  : string
getProductDetailUrl()  : string
getSectionDetailUrl()  : string
getSectionListUrl()  : string
getSectionSaveUrl()  : string
getSectionSearchUrl()  : string
getSectionSeoUrl()  : string
getSliderPathOption()  : array<string|int, mixed>|null
getSliderPathString()  : string
getUrlBuilderIdParam()  : string
getUrlParams()  : string
getWeight()  : int|null
isIblockListMixed()  : bool
isSliderMode()  : bool
openSettingsPage()  : void
Open settings page of IBlock context
preloadUrlData()  : void
setIblockId()  : void
setLanguageId()  : void
setMixedIblockList()  : void
setPrefix()  : void
setSeparateIblockList()  : void
setSliderMode()  : void
setUrlParams()  : void
showDetailPageSlider()  : void
subscribeOnAfterSettingsSave()  : void
Subscribe to save settings events depending on the context
use()  : bool

Constants

ENTITY_ELEMENT

public mixed ENTITY_ELEMENT = 'element'

ENTITY_SECTION

public mixed ENTITY_SECTION = 'section'

PAGE_CATALOG_SEO

public mixed PAGE_CATALOG_SEO = 'catalogSeo'

PAGE_ELEMENT_COPY

public mixed PAGE_ELEMENT_COPY = 'elementCopy'

PAGE_ELEMENT_DETAIL

public mixed PAGE_ELEMENT_DETAIL = 'elementDetail'

PAGE_ELEMENT_LIST

public mixed PAGE_ELEMENT_LIST = 'elementList'

PAGE_ELEMENT_SAVE

public mixed PAGE_ELEMENT_SAVE = 'elementSave'

PAGE_ELEMENT_SEARCH

public mixed PAGE_ELEMENT_SEARCH = 'elementSearch'

PAGE_ELEMENT_SEO

public mixed PAGE_ELEMENT_SEO = 'elementSeo'

PAGE_OFFER_DETAIL

public mixed PAGE_OFFER_DETAIL = 'offerDetail'

PAGE_SECTION_COPY

public mixed PAGE_SECTION_COPY = 'sectionCopy'

PAGE_SECTION_DETAIL

public mixed PAGE_SECTION_DETAIL = 'sectionDetail'

PAGE_SECTION_LIST

public mixed PAGE_SECTION_LIST = 'sectionList'

PAGE_SECTION_SAVE

public mixed PAGE_SECTION_SAVE = 'sectionSave'

PAGE_SECTION_SEARCH

public mixed PAGE_SECTION_SEARCH = 'sectionSearch'

PAGE_SECTION_SEO

public mixed PAGE_SECTION_SEO = 'sectionSeo'

TYPE_AUTODETECT

public mixed TYPE_AUTODETECT = 'AUTO'

Methods

getBaseParams()

public getBaseParams() : string
Return values
string

getCatalogSeoUrl()

public getCatalogSeoUrl([array<string|int, mixed> $options = [] ][, string $additional = '' ]) : string
Parameters
$options : array<string|int, mixed> = []
$additional : string = ''
Return values
string

getCompiledParams()

public getCompiledParams(array<string|int, mixed> $params) : string
Parameters
$params : array<string|int, mixed>
Return values
string

getContextMenuItems()

public getContextMenuItems(string $pageType[, array<string|int, mixed> $items = [] ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>|null
Parameters
$pageType : string
$items : array<string|int, mixed> = []
$options : array<string|int, mixed> = []
Return values
array<string|int, mixed>|null

getDetailPageSlider()

public getDetailPageSlider() : string
Return values
string

getElementCopyUrl()

public getElementCopyUrl(int|null $entityId[, array<string|int, mixed> $options = [] ][, string $additional = '' ]) : string
Parameters
$entityId : int|null
$options : array<string|int, mixed> = []
$additional : string = ''
Return values
string

getElementDetailUrl()

public getElementDetailUrl(int|null $entityId[, array<string|int, mixed> $options = [] ][, string $additional = '' ]) : string
Parameters
$entityId : int|null
$options : array<string|int, mixed> = []
$additional : string = ''
Return values
string

getElementListUrl()

public getElementListUrl(int|null $parentId[, array<string|int, mixed> $options = [] ][, string $additional = '' ]) : string
Parameters
$parentId : int|null
$options : array<string|int, mixed> = []
$additional : string = ''
Return values
string

getElementSaveUrl()

public getElementSaveUrl(int|null $entityId[, array<string|int, mixed> $options = [] ][, string $additional = '' ]) : string
Parameters
$entityId : int|null
$options : array<string|int, mixed> = []
$additional : string = ''
Return values
string

getElementSearchUrl()

public getElementSearchUrl([array<string|int, mixed> $options = [] ][, string $additional = '' ]) : string
Parameters
$options : array<string|int, mixed> = []
$additional : string = ''
Return values
string

getElementSeoUrl()

public getElementSeoUrl(int $productId[, array<string|int, mixed> $options = [] ][, string $additional = '' ]) : string
Parameters
$productId : int
$options : array<string|int, mixed> = []
$additional : string = ''
Return values
string

getId()

public getId() : string
Return values
string

getLanguageId()

public getLanguageId() : string
Return values
string

getLanguageParam()

public getLanguageParam() : string
Return values
string

getListMode()

public getListMode() : string
Return values
string

getPrefix()

public getPrefix() : string
Return values
string

getProductDetailUrl()

public getProductDetailUrl(int $entityId[, array<string|int, mixed> $options = [] ][, string $additional = '' ]) : string
Parameters
$entityId : int
$options : array<string|int, mixed> = []
$additional : string = ''
Return values
string

getSectionDetailUrl()

public getSectionDetailUrl(int|null $entityId[, array<string|int, mixed> $options = [] ][, string $additional = '' ]) : string
Parameters
$entityId : int|null
$options : array<string|int, mixed> = []
$additional : string = ''
Return values
string

getSectionListUrl()

public getSectionListUrl(int|null $parentId[, array<string|int, mixed> $options = [] ][, string $additional = '' ]) : string
Parameters
$parentId : int|null
$options : array<string|int, mixed> = []
$additional : string = ''
Return values
string

getSectionSaveUrl()

public getSectionSaveUrl(int|null $entityId[, array<string|int, mixed> $options = [] ][, string $additional = '' ]) : string
Parameters
$entityId : int|null
$options : array<string|int, mixed> = []
$additional : string = ''
Return values
string

getSectionSearchUrl()

public getSectionSearchUrl([array<string|int, mixed> $options = [] ][, string $additional = '' ]) : string
Parameters
$options : array<string|int, mixed> = []
$additional : string = ''
Return values
string

getSectionSeoUrl()

public getSectionSeoUrl(int $sectionId[, array<string|int, mixed> $options = [] ][, string $additional = '' ]) : string
Parameters
$sectionId : int
$options : array<string|int, mixed> = []
$additional : string = ''
Return values
string

getSliderPathOption()

public getSliderPathOption(string $path) : array<string|int, mixed>|null
Parameters
$path : string
Return values
array<string|int, mixed>|null

getSliderPathString()

public getSliderPathString(string $path) : string
Parameters
$path : string
Return values
string

getUrlBuilderIdParam()

public getUrlBuilderIdParam() : string
Return values
string

getUrlParams()

public getUrlParams([array<string|int, mixed> $options = [] ][, string $additional = '' ]) : string
Parameters
$options : array<string|int, mixed> = []
$additional : string = ''
Return values
string

getWeight()

public getWeight() : int|null
Return values
int|null

isIblockListMixed()

public isIblockListMixed() : bool
Return values
bool

isSliderMode()

public isSliderMode() : bool
Return values
bool

openSettingsPage()

Open settings page of IBlock context

public openSettingsPage() : void

Example: for catalog IBlock it should open settings of catalog

preloadUrlData()

public preloadUrlData(string $entityType, array<string|int, mixed> $entityIds) : void
Parameters
$entityType : string
$entityIds : array<string|int, mixed>

setIblockId()

public setIblockId(int $iblockId) : void
Parameters
$iblockId : int

setLanguageId()

public setLanguageId(string $languageId) : void
Parameters
$languageId : string

setMixedIblockList()

public setMixedIblockList() : void

setPrefix()

public setPrefix(string $prefix) : void
Parameters
$prefix : string

setSeparateIblockList()

public setSeparateIblockList() : void

setSliderMode()

public setSliderMode(bool $mode) : void
Parameters
$mode : bool

setUrlParams()

public setUrlParams(array<string|int, mixed> $list) : void
Parameters
$list : array<string|int, mixed>

showDetailPageSlider()

public showDetailPageSlider() : void

subscribeOnAfterSettingsSave()

Subscribe to save settings events depending on the context

public subscribeOnAfterSettingsSave() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results