Bitrix API

LocationHelper extends NameHelper

FinalYes

Table of Contents

Constants

DEBUG_MODE_OPT  = 'location2_debug_mode'
EDIT_PAGE_URL  = 'sale_location_node_edit.php'
IMPORT_PAGE_URL  = 'sale_location_import.php'
LIST_PAGE_URL  = 'sale_location_node_list.php'
LOCATION_LINK_DATA_CACHE_TAG  = 'sale-location-data'
MENU_ITEMS_QUERY_STRING_DELIMITER  = ':'
MENU_ITEMS_QUERY_STRING_TAG  = 'menu_sale_location_tree'
MENU_LOCATION_PARENT_TAG  = 'menu_sale_location_tree'
MENU_MAX_ITEMS_IN  = 100
MIGRATION_PAGE_URL  = 'sale_location_migration.php'
REINDEX_PAGE_URL  = 'sale_location_reindex.php'
URL_PARAM_ID  = 'id'
URL_PARAM_PARENT_ID  = 'PARENT_ID'

Methods

add()  : mixed
appendMenuChildren()  : mixed
checkFirstImportDone()  : mixed
checkIsNameField()  : mixed
checkLocationEnabled()  : mixed
checkLocationMigrated()  : mixed
checkRequestIsMenuRequest()  : mixed
checkUseFilter()  : mixed
convertToArray()  : mixed
delete()  : mixed
deleteInformer()  : mixed
extractNames()  : mixed
getColumns()  : mixed
getDetailPageRows()  : mixed
getEditUrl()  : mixed
getEntityRoadCode()  : mixed
getEntityRoadMap()  : array<string|int, mixed>
Function returns instructions from where and which columns we take to show in UI
getExternalData()  : mixed
getExternalMap()  : mixed
getExternalServicesList()  : mixed
getFilterColumns()  : mixed
getFormData()  : mixed
getIdsByFilter()  : mixed
getImportUrl()  : mixed
getLanguageList()  : mixed
getList()  : mixed
getListGridColumns()  : mixed
getListUrl()  : mixed
getLocationPathDisplay()  : mixed
getLocationsByZip()  : mixed
getLocationStringByCode()  : mixed
getLocationStringById()  : mixed
getLocationSubMenu()  : mixed
getMap()  : mixed
getMigrationUrl()  : mixed
getNameMap()  : mixed
getNameToDisplay()  : mixed
getParametersForList()  : mixed
getParentId()  : mixed
getPrimaryFieldName()  : mixed
getReindexUrl()  : mixed
getTranslatedName()  : mixed
getTypeList()  : mixed
getUrl()  : mixed
getWidgetAppearance()  : mixed
getYandexMarketExternalServiceId()  : int
getZipByLocation()  : mixed
informAdminLocationDatabaseFailure()  : mixed
makeSafeDisplay()  : mixed
mapLanguage()  : mixed
packItemsQueryString()  : mixed
performGridOperations()  : mixed
prepareLinksForSaving()  : mixed
proxyListRequest()  : mixed
proxyUpdateRequest()  : mixed
readMap()  : mixed
resetLocationsForEntity()  : mixed
translitFromUTF8()  : mixed
unPackItemsQueryString()  : mixed
update()  : mixed
validateUpdateRequest()  : mixed

Constants

DEBUG_MODE_OPT

public mixed DEBUG_MODE_OPT = 'location2_debug_mode'

EDIT_PAGE_URL

public mixed EDIT_PAGE_URL = 'sale_location_node_edit.php'

IMPORT_PAGE_URL

public mixed IMPORT_PAGE_URL = 'sale_location_import.php'

LIST_PAGE_URL

public mixed LIST_PAGE_URL = 'sale_location_node_list.php'

LOCATION_LINK_DATA_CACHE_TAG

public mixed LOCATION_LINK_DATA_CACHE_TAG = 'sale-location-data'

MENU_ITEMS_QUERY_STRING_DELIMITER

public mixed MENU_ITEMS_QUERY_STRING_DELIMITER = ':'

MENU_ITEMS_QUERY_STRING_TAG

public mixed MENU_ITEMS_QUERY_STRING_TAG = 'menu_sale_location_tree'

MENU_LOCATION_PARENT_TAG

public mixed MENU_LOCATION_PARENT_TAG = 'menu_sale_location_tree'

MIGRATION_PAGE_URL

public mixed MIGRATION_PAGE_URL = 'sale_location_migration.php'

REINDEX_PAGE_URL

public mixed REINDEX_PAGE_URL = 'sale_location_reindex.php'

URL_PARAM_PARENT_ID

public mixed URL_PARAM_PARENT_ID = 'PARENT_ID'

Methods

add()

public static add(mixed $data) : mixed
Parameters
$data : mixed

appendMenuChildren()

public static appendMenuChildren(mixed &$attachTo, mixed $attachWhat, mixed $index, mixed $queryParams) : mixed
Parameters
$attachTo : mixed
$attachWhat : mixed
$index : mixed
$queryParams : mixed

checkFirstImportDone()

public static checkFirstImportDone() : mixed

checkIsNameField()

public static checkIsNameField(mixed $code) : mixed
Parameters
$code : mixed

checkLocationEnabled()

public static checkLocationEnabled() : mixed

checkLocationMigrated()

public static checkLocationMigrated() : mixed

checkRequestIsMenuRequest()

public static checkRequestIsMenuRequest() : mixed

checkUseFilter()

public static checkUseFilter() : mixed

convertToArray()

public static convertToArray(mixed $data) : mixed
Parameters
$data : mixed

delete()

public static delete(mixed $primary[, mixed $batch = false ]) : mixed
Parameters
$primary : mixed
$batch : mixed = false

deleteInformer()

public static deleteInformer(mixed $informerTag) : mixed
Parameters
$informerTag : mixed

extractNames()

public static extractNames(mixed &$data) : mixed
Parameters
$data : mixed

getColumns()

public static getColumns(mixed $page) : mixed
Parameters
$page : mixed

getDetailPageRows()

public static getDetailPageRows() : mixed

getEditUrl()

public static getEditUrl([mixed $node = false ][, mixed $parameters = array() ]) : mixed
Parameters
$node : mixed = false
$parameters : mixed = array()

getEntityRoadCode()

public static getEntityRoadCode() : mixed

getEntityRoadMap()

Function returns instructions from where and which columns we take to show in UI

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

getExternalData()

public static getExternalData(mixed $id) : mixed
Parameters
$id : mixed

getExternalServicesList()

public static getExternalServicesList() : mixed

getFormData()

public static getFormData(mixed $id) : mixed
Parameters
$id : mixed

getIdsByFilter()

public static getIdsByFilter(mixed $listFilter) : mixed
Parameters
$listFilter : mixed

getImportUrl()

public static getImportUrl() : mixed

getLanguageList()

public static getLanguageList() : mixed

getList()

public static getList([mixed $parameters = array() ][, mixed $tableId = false ][, mixed $navigation = 20 ][, mixed $params = array() ]) : mixed
Parameters
$parameters : mixed = array()
$tableId : mixed = false
$navigation : mixed = 20
$params : mixed = array()

getListUrl()

public static getListUrl([mixed $parent = false ][, mixed $parameters = array() ]) : mixed
Parameters
$parent : mixed = false
$parameters : mixed = array()

getLocationPathDisplay()

public static getLocationPathDisplay(mixed $primary) : mixed
Parameters
$primary : mixed

getLocationsByZip()

public static getLocationsByZip(mixed $zip[, mixed $parameters = array() ]) : mixed
Parameters
$zip : mixed
$parameters : mixed = array()

getLocationStringByCode()

public static getLocationStringByCode(mixed $primary[, mixed $behaviour = array('INVERSE' => false, 'DELIMITER' => ', ', 'LANGUAGE_ID' => LANGUAGE_ID) ]) : mixed
Parameters
$primary : mixed
$behaviour : mixed = array('INVERSE' => false, 'DELIMITER' => ', ', 'LANGUAGE_ID' => LANGUAGE_ID)

getLocationStringById()

public static getLocationStringById(mixed $primary[, mixed $behaviour = array('INVERSE' => false, 'DELIMITER' => ', ', 'LANGUAGE_ID' => LANGUAGE_ID) ]) : mixed
Parameters
$primary : mixed
$behaviour : mixed = array('INVERSE' => false, 'DELIMITER' => ', ', 'LANGUAGE_ID' => LANGUAGE_ID)

getLocationSubMenu()

public static getLocationSubMenu() : mixed

getMap()

public static getMap(mixed $page) : mixed
Parameters
$page : mixed

getMigrationUrl()

public static getMigrationUrl() : mixed

getNameMap()

public static getNameMap() : mixed

getNameToDisplay()

public static getNameToDisplay(mixed $id) : mixed
Parameters
$id : mixed

getParametersForList()

public static getParametersForList(mixed $proxed) : mixed
Parameters
$proxed : mixed

getParentId()

public static getParentId(mixed $id) : mixed
Parameters
$id : mixed

getPrimaryFieldName()

public static getPrimaryFieldName() : mixed

getReindexUrl()

public static getReindexUrl() : mixed

getTranslatedName()

public static getTranslatedName(mixed $names, mixed $languageId) : mixed
Parameters
$names : mixed
$languageId : mixed

getTypeList()

public static getTypeList() : mixed

Use TypeHelper::getTypes() instead

getUrl()

public static getUrl(mixed $page[, mixed $parameters = array() ]) : mixed
Parameters
$page : mixed
$parameters : mixed = array()

getWidgetAppearance()

public static getWidgetAppearance() : mixed

getYandexMarketExternalServiceId()

public static getYandexMarketExternalServiceId() : int
Return values
int

getZipByLocation()

public static getZipByLocation(mixed $locationCode[, mixed $parameters = array() ]) : mixed
Parameters
$locationCode : mixed
$parameters : mixed = array()

informAdminLocationDatabaseFailure()

public static informAdminLocationDatabaseFailure() : mixed

makeSafeDisplay()

public static makeSafeDisplay(mixed &$value, mixed $code) : mixed
Parameters
$value : mixed
$code : mixed

mapLanguage()

public static mapLanguage(mixed $lid) : mixed
Parameters
$lid : mixed

packItemsQueryString()

public static packItemsQueryString([mixed $parameters = array() ]) : mixed
Parameters
$parameters : mixed = array()

performGridOperations()

public static performGridOperations(mixed $parameters) : mixed
Parameters
$parameters : mixed

prepareLinksForSaving()

public static prepareLinksForSaving(mixed $connectorClass, mixed $links) : mixed
Parameters
$connectorClass : mixed
$links : mixed

proxyListRequest()

public static proxyListRequest([mixed $page = 'list' ]) : mixed
Parameters
$page : mixed = 'list'

proxyUpdateRequest()

public static proxyUpdateRequest(mixed $data) : mixed
Parameters
$data : mixed

readMap()

public static readMap(mixed $entityRoadCode[, mixed $page = 'list' ]) : mixed
Parameters
$entityRoadCode : mixed
$page : mixed = 'list'

resetLocationsForEntity()

public static resetLocationsForEntity(mixed $entityId, mixed $locations, mixed $entityName[, mixed $expectCodes = false ]) : mixed
Parameters
$entityId : mixed
$locations : mixed
$entityName : mixed
$expectCodes : mixed = false

translitFromUTF8()

public static translitFromUTF8(mixed $string) : mixed
Parameters
$string : mixed

unPackItemsQueryString()

public static unPackItemsQueryString() : mixed

update()

public static update(mixed $primary, mixed $data[, mixed $batch = false ]) : mixed
Parameters
$primary : mixed
$data : mixed
$batch : mixed = false

validateUpdateRequest()

public static validateUpdateRequest(mixed $data) : mixed
Parameters
$data : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results