Улучшенный выбор местоположения с определением по IP, замена контента в зависимости от города

Установка

Решение устанавливается стандартно. После установки Вы будете перенаправлены в интерфейс настройки модуля.

Для корректной работы модуля на редакциях «Бизнес» и «Малый бизнес» необходимо, чтобы были загружены местоположения в базу модуля «Интернет-магазин» dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=42&LESSON_ID=3074&LESSON_PATH=3912.4580.4828.3074#load

Подключение компонента улучшенного выбора местоположений

Вы можете вставить ссылку на выбор местоположения города в шапку сайта. Для этого в нужном месте шаблона добавьте вызов компонента:

<?$APPLICATION->IncludeComponent("twofingers:location","",Array());?>

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

Если вы используете модифицированный компонент sale.order.ajax, для того, чтобы использовать улучшенный выбор местоположения при оформлении заказа, необходимо для компонента sale.ajax.locations прописать шаблон tf_location.

Вызов пользовательской javascript-функции

В настройках модуля можно вписать JS функцию, которая будет выполняться при выборе города пользователем. В её названии можно использовать плейсхолдеры:

#TF_LOCATION_CITY_ID# - ID выбранного города
#TF_LOCATION_CITY_NAME# - Имя выбранного города

Например: handleMePlease("#TF_LOCATION_CITY_ID#", "#TF_LOCATION_CITY_NAME#");

Обработка javascript-события onTFLocationSetLocation

Также после выбора местоположения генерируется javascript-событие "onTFLocationSetLocation", в которое передаётся DOM-объект выбранного местоположения. Пример обработчика:

BX.addCustomEvent("onTFLocationSetLocation", function(response)
{
    if (response.hasOwnProperty('location')) {
        console.log(response.location);
    }
    if (response.hasOwnProperty('content')) {
        console.log(response.content);
    }
});

Получение выбранного местоположения на сайте

Выбранное местоположение сохраняется в сессию или куки (в зависимости от настроек) и может быть получено и использовано в любых местах сайта. Например, выведем регион и стран для текущего местоположения:

use Bitrix\Main\Composite\BufferArea;
use Bitrix\Main\Loader;
use TwoFingers\Location\Entity\Location;
use TwoFingers\Location\Factory\LocationFactory;
$frame = new BufferArea("my_dynamic_area"); // для композитного режима
$frame->begin(); // для композитного режима
if (Loader::includeModule('twofingers.location')
    && $location = LocationFactory::buildByStorage())
{
    echo $location->getId() . '<br>'; // ID местоположения
    echo $location->getCode() . '<br>'; // Код местоположения
    echo $location->getName() . '<br>'; // название местоположения

    if ($location->hasParent())
    {
        $parents = LocationFactory::buildParentsCollection($location);
        /** @var Location $parent */
        foreach ($parents as $parent)
        {
            // выводим только регион и страну
            if (in_array($parent->getType(), [Location::TYPE_REGION, Location::TYPE_COUNTRY]))
            {
                echo $parent->getId() . '<br>'; // ID родительского местоположения
                echo $parent->getCode() . '<br>'; // Код родительского местоположения
                echo $parent->getName() . '<br>'; // название родительского местоположения
            }
        }
    }
}
$frame->end(); // для композитного режима

Получение текущего местоположения:

use Bitrix\Main\Composite\BufferArea;
use Bitrix\Main\Loader;
use TwoFingers\Location\Factory\LocationFactory;
$frame = new BufferArea("my_dynamic_area"); // для композитного режима
$frame->begin(); // для композитного режима
if (Loader::includeModule('twofingers.location')) {
    $location = LocationFactory::buildCurrent();
    if ($location) {
        echo $location->getName();
    }
}
$frame->end(); // для композитного режима

Получение местоположения по ip:

use Bitrix\Main\Composite\BufferArea;
use Bitrix\Main\Loader;
use TwoFingers\Location\Factory\LocationFactory;
$frame = new BufferArea("my_dynamic_area"); // для композитного режима
$frame->begin(); // для композитного режима
if (Loader::includeModule('twofingers.location')) {
    $location = LocationFactory::buildByIp('5.255.255.88'); //yandex.ru
    if ($location) {
        echo $location->getName();
    }
}
$frame->end(); // для композитного режима

Получение местоположения по умолчанию для текущего сайта:

use Bitrix\Main\Composite\BufferArea;
use Bitrix\Main\Loader;
use TwoFingers\Location\Factory\LocationFactory;
$frame = new BufferArea("my_dynamic_area"); // для композитного режима
$frame->begin(); // для композитного режима
if (Loader::includeModule('twofingers.location')) {
    $location = LocationFactory::buildDefault();
    if ($location) {
        echo $location->getName();
    }
}
$frame->end(); // для композитного режима

Склонение названия местоположения по падежам (бета)

Чтобы получить склонение названия местоположения в выбранном падеже, надо передать соответствующую константу в метод getName() местоположения.

echo $location->getName(); // Москва
echo $location->getName(Location::CASE_ROD); // Москвы
echo $location->getName(Location::CASE_DAT); // Москве
echo $location->getName(Location::CASE_VIN); // Москву
echo $location->getName(Location::CASE_TVOR); // Москвой
echo $location->getName(Location::CASE_PRED); // Москве

Получение информации из инфоблока в зависимости от местоположения

При установке модуля будет создан инфоблок "Контент" в типе "Местоположения". В этом инфоблоке Вы можете создавать элементы и привязывать их к местоположениям. Обратите внимание, что с данным инфоблоком вы можете работать так же, как и со всеми остальными: заполнять все доступные поля, добавлять и удалять свойства (кроме системных LOCATION_ID и SITE_ID). Можно обращаться к нему как к обычному инфоблоку, а можно через специальную сущность:

use Bitrix\Main\Composite\BufferArea;
use Bitrix\Main\Loader;
use TwoFingers\Location\Factory\ContentFactory;
use TwoFingers\Location\Factory\LocationFactory;
$frame = new BufferArea("my_dynamic_area"); // для композитного режима
$frame->begin(); // для композитного режима
if (Loader::includeModule('twofingers.location')
    && $location = LocationFactory::buildByStorage())
{
    $content = ContentFactory::buildByLocation($location);
    if ($content)
    {
        echo $content->getPhone() . '<br>';  // вывод значения свойства PHONE инфоблока "Местоположения" -> "Контент", магический метод
        echo $content->getPropertyValue('PHONE') . '<br>'; // тоже самое без магии
        echo $content->getPreviewText() . '<br>'; // вывод анонса, магический метод
        echo $content->getFieldValue('PREVIEW_TEXT') . '<br>'; // анонс без магии
        echo $content->getDomain(); // домен для перенаправления
        var_dump($content->getPriceTypes()); // получить доступные типы цен (только для старших редакций Битрикс)
        var_dump($content->getStores()); // получить доступные склады (только для старших редакций Битрикс)

        var_dump($content->getData()); // все поля и свойства привязанного элемента
    }
}
$frame->end(); // для композитного режима

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

Настройка автоматического редиректа на домены/поддомены для выбранных местоположений

Редирект можно настроить для метоположений, добавленных в инфоблок "Контент" (тип "Местоположения"). Для этого элементу иноблока необходимо добавить домен в свойство "Домен".

Элемент инфоблока обязательно должен быть связан с местоположением через свойство "ИД местоположения" или название.

Предварительно желаемые домены необходимо добавить в инфоблок "Домены" (тип "Местоположения").

Получение домена для перенаправления для местоположения

use Bitrix\Main\Composite\BufferArea;
use Bitrix\Main\Loader;
use TwoFingers\Location\Factory\LocationFactory;
$frame = new BufferArea("my_dynamic_area"); // для композитного режима
$frame->begin(); // для композитного режима
if (Loader::includeModule('twofingers.location')
    && $location = LocationFactory::buildByStorage())
{
    echo $location->getDomain();
}
$frame->end(); // для композитного режима

Редирект между доменами/поддоментам может быть заблокирован политикой CORS на сайте. Необходимо настроить эту политику самостоятельно!

Пример работы с переменными без использования инфоблока

Допустим, нам необходимо менять телефон в шапке сайта в зависимости от города. Привяжемся к названию города. Будем показывать один телефон для Москвы и другой телефон для всех остальных городов.

use Bitrix\Main\Composite\BufferArea;
use Bitrix\Main\Loader;
use TwoFingers\Location\Factory\LocationFactory;
$frame = new BufferArea("my_dynamic_area"); // для композитного режима
$frame->begin(); // для композитного режима
if (Loader::includeModule('twofingers.location')
    && $location = LocationFactory::buildByStorage())
{
    if ($location->getName() == 'Москва')
        echo "+7 (495) 055-65-19";
    else
        echo "8 800 500 40 30";
}
$frame->end(); // для композитного режима

Замена плейсхолдеров

При включенной опции "Заменять плейсхолдеры" в настройке модуля, будут заменены:

• #location_name#, #city_name# — название текущего местоположения;
• #region_name# — название текущего региона, области, края, республики и т.п.;
• #country_name# — название текущей страны;
• #content_%код%# — значение поля или свойства с кодом %код% из привязанного элемента контента. Например, #content_preview_text# будет заменено на анонс, а #content_phone# — на значение свойства PHONE.

Замена производится как в мета-тегах, так и в любом другом месте страницы.

Обработка события afterLocationDetect

Событие afterLocationDetect позволяет модифицировать местоположение после того, как оно было определено автоматически.

Пример обработчика события, размещенного в файле init.php:

use Bitrix\Main\EventManager;
use TwoFingers\Location\Factory\LocationFactory;
use TwoFingers\Location\Storage;
EventManager::getInstance()->addEventHandler('twofingers.location', 'afterLocationDetect', function (){
    $location = LocationFactory::buildByStorage();
    if ($location->getName() == 'Троицк') {
        $newLocation = LocationFactory::buildByName('Москва');
        if ($newLocation) {
            Storage::setLocation($newLocation);
        }
    }
});