\BXmaker\GeoIP\Region

\BXmaker\GeoIP\Region -

Класс для работы с регионами

namespace BXmaker\GeoIP;
class Region
{
    //...
}

Методы

canBeUsed

Проверка, можно ли исопльзовать. Можно только при установленном модуле хайлоадблоков [highloadblock]

/**
 * @return bool
 * @throws \Bitrix\Main\LoaderException
 */
public function canBeUsed();

createDefaultItem

Вернет регион по умолчанию

/**
 * @return \BXmaker\GeoIP\Region\Item|null
 * @throws \Bitrix\Main\ArgumentException
 * @throws \Bitrix\Main\ObjectPropertyException
 * @throws \Bitrix\Main\SystemException
 */
public function createDefaultItem();

createItemById

Создаст объект региона по его идентификатору

/**
 * @param $regionId
 * @return \BXmaker\GeoIP\Region\Item|null
 */
public function createItemById($regionId);

createItemBySearchItem

Создаст объект региона по найденному местоположению

/**
 * @param \BXmaker\GeoIP\Location\Search\Item|null $oItem
 * @return \BXmaker\GeoIP\Region\Item|null
 */
public function createItemBySearchItem($oItem);

createItemByUrl

Вернет объект региона на основе url

/**
 * @param $url
 * @return null | \BXmaker\GeoIP\Region\Item
 */
public function createItemByUrl($url);

createItemsByIds

Создаст объекты регионов по его идентификатору

/**
 * @param $regionId
 * @return \BXmaker\GeoIP\Region\Item[]|array
 */
public function createItemsByIds($regionIds);

getIdToName

Вернет список соответствий идентификаторов и названий регионов

/**
 * @return mixed
 */
public function getIdToName();

getSelectList

Вернем массив для выпадающего списка

/**
 * @param bool $withNoSelect - добавить вариант - не выбрано
 * @return array[]
 */
public function getSelectList($withNoSelect = true);

getVersion

public function getVersion();

highloadblock

/**
 * @return \BXmaker\GeoIP\Region\Highloadblock
 */
public function highloadblock();

updateVersion

public function updateVersion();