Документация для разработчиков
Темная тема

Методы

Класс \Bitrix\Main\UI\Spotlight позволяет:

  • Зафиксировать факт просмотра подсказки конкретным пользователем.
  • Определить нужно ли конкретному пользователю показывать пульсирующий круг.
Метод Описание С версии
new Spotlight(
   $id
)
Конструктор класса.

Параметр:

  • id - идентификатор подсказки.

Пример:

use \Bitrix\Main\UI\Spotlight;

$spotlight = new Spotlight("my-hint");
$spotlight->setEndDate(time() - 3600);
$spotlight->setLifetime(3600 * 5);
$spotlight->setUserTimeSpan(3600 * 5);
$spotlight->setUserType(Spotlight::USER_TYPE_NEW); //для новых пользователей
if ($spotlight->isAvailable())
{
  //можно показывать подсказку
}
spotlight.isAvailable(
   $userId = false
)
Возвращает true, если подсказка доступна пользователю.

Параметры:

  • userId {number} - Идентификатор пользователя.
spotlight.getActivationDate
Возвращает дату (timestamp) активации подсказки на сайте.
spotlight.activate(
   $activationDate = false
)
Активирует подсказку на сайте.

Параметры:

  • activationDate {number} - Дата активации подсказки на сайте в секундах (timestamp). По умолчанию текущее время.
spotlight.deactivate
Деактивирует подсказку на сайте.
spotlight.isViewed(
   $userId
)
Возвращает true, если подсказка была просмотрена.

Параметры:

  • userId {number} - Идентификатор пользователя.
spotlight.getViewDate(
   $userId
)
Возвращает дату просмотра подсказки.

Параметры:

  • userId {number} - Идентификатор пользователя.
spotlight.setViewDate(
   $userId,
   $date = false
)
Устанавливает дату просмотра подсказки.

Параметры:

  • userId {number} - Идентификатор пользователя.
  • date {number} - Дата просмотра подсказки в секундах (timestamp). По умолчанию текущее время.
spotlight.unsetViewDate(
   $userId
)
Сбрасывает дату просмотра подсказки.

Параметры:

  • userId {number} - Идентификатор пользователя.
spotlight.getId
Возвращает идентификатор подсказки.
spotlight.getUserType
Возвращает тип пользователя. Возвращаемые значения:
  • NEW - новый пользователь.
  • OLD - старый пользователь.
  • ALL - любой пользователь.
spotlight.setUserType(
   $userType
)
Устанавливает тип пользователя, для которого нужно определить доступность подсказки.

Параметры:

  • userType - Тип пользователя. Допустимые значения:
    • Spotlight::USER_TYPE_OLD - старый пользователь.
    • Spotlight::USER_TYPE_NEW - новый пользователь.
    • Spotlight::USER_TYPE_ALL - любой пользователь.
spotlight.setUserTimeSpan(
   $userTimeSpan
)
Устанавливает промежуток времени, по которому определяется новый/старый пользователь.

Параметры:

  • userTimeSpan {number} - Промежуток времени в секундах.
spotlight.getUserTimeSpan
Возвращает промежуток времени, по которому определяется новый/старый пользователь.
spotlight.getLifetime
Возвращает время жизни подсказки в секундах.
spotlight.setLifetime(
   $lifetime
)
Устанавливает время жизни подсказки.

Параметры:

  • lifetime {number} - Время жизни подсказки в секундах
spotlight.getStartDate
Возвращает дату, с которой начнется показ подсказки. Возвращает null, если дата не задана.
spotlight.setStartDate(
   $startDate
)
Устанавливает дату, с которой начнется показ подсказки.

Параметры:

  • startDate {number|null} - Дата, с которой начнется показ подсказки в секундах (timestamp).
spotlight.getEndDate
Возвращает дату, до которой возможен показ подсказки. Возвращает null, если дата не задана.
spotlight.setEndDate(
   $endDate
)
Устанавливает дату, до которой возможен показ подсказки.

Параметры:

  • endDate {number|null} - Дата, до которой возможен показ подсказки в секундах (timestamp).


© «Битрикс», 2001-2023, «1С-Битрикс», 2023