API

Для удобной работы с модулем региональных поддоменов создано специальное API, предназначенное в первую очередь для упрощения генерации seo-текстов.

На данный момент решение предоставляет функции, описанные ниже.

makeText

string makeText(string $text = "", array $aReplace = null);

Описание

Функция похожа на стандартную для Битрикса GetMessage, с той лишь разницей, что во второй параметр не надо добавлять регионозависимые переменные, они сами берутся из сессии. Для вставки переменной из сессионного массива региона используйте префикс #VREGION_.

Пример вызова

Реальный пример того, как можно задавать динамическую мету на детальной товара. Код взят из component_epilog.php шаблона компонента catalog.element.

global $APPLICATION;
$APPLICATION->SetPageProperty("title", Aristov\VRegions\Tools::makeText("#NAME# в #VREGION_WHERE#", Array("#NAME#" => $arResult["NAME"])));
$APPLICATION->SetPageProperty("keywords", Aristov\VRegions\Tools::makeText("#NAME# в #VREGION_WHERE#, купить #NAME# в #VREGION_WHERE#, приобрести #NAME# в #VREGION_WHERE#", Array("#NAME#" => $arResult["NAME"])));
$APPLICATION->SetPageProperty("description", Aristov\VRegions\Tools::makeText("#NAME# в самом лучшем интернет-магазине в #VREGION_WHERE#", Array("#NAME#" => $arResult["NAME"])));

ifRegionIsDefault

boolean ifRegionIsDefault(integer $reginID = null);

Описание

Выдаёт true в случае, если переданный регион задан как регион по умолчанию.

Пример вызова

if (Aristov\VRegions\Tools::ifRegionIsDefault($_SESSION["VREGIONS_REGION"]["ID"])){?>
	<p>Возможен самовывоз.</p>
<?}