Документация для разработчиков
Темная тема
Недоступно в редакциях: Малый бизнес, Стандарт, Старт

Поиск пользователей


Описание socialnetwork.user_search

Компонент позволяет искать пользователей социальной сети. Компонент является стандартным и входит в дистрибутив модуля.

Компонент относится к модулю Социальная сеть.

В визуальном редакторе компонент находится в Компоненты > Общение > Социальная сеть.



Параметры

Поле Параметр Описание
Внешний вид
Число записей на страницу ITEMS_COUNT Указывается количество найденных пользователей, отоброжаемых на одной странице. Все найденные пользователи будут выведены с помощью постраничной навигации.
Формат даты DATE_TIME_FORMAT Указывается формат показа даты и времени. В выпадающем списке перечислены все возможные варианты показа даты, формируемые внутри компонента. Выбрав пункт (другое)->, можно сформировать свой вариант на основании php-функции date.
Шаблоны ссылок
Шаблон пути к странице пользователя PATH_TO_USER Задается путь к странице профиля пользователя социальной сети.
Шаблон пути к странице поиска пользователей PATH_TO_SEARCH Задается путь к странице поиска пользователей социальной сети.
Шаблон пути к внутренней странице поиска пользователей PATH_TO_SEARCH_INNER Задается путь к внутренней странице поиска пользователей социальной сети.
Шаблон пути к странице добавления в друзья PATH_TO_USER_FRIENDS_ADD Задается путь к странице добавления в друзья социальной сети.
Шаблон пути к странице отправки сообщений PATH_TO_MESSAGE_FORM Задается путь к странице отправки сообщений социальной сети.
Шаблон пути к странице чата PATH_TO_MESSAGES_CHAT Задается путь к странице чата социальной сети.
Настройки кеширования
Тип кеширования CACHE_TYPE Тип кеширования:
  • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
  • Y - Кешировать: для кеширования необходимо определить время кеширования;
  • N - Не кешировать: кеширования нет в любом случае.
Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.
Дополнительные настройки
Устанавливать цепочку навигации SET_NAVCHAIN [Y|N] При отмеченной опции в цепочку навигации будет добавлен пункт Поиск пользователей.
Устанавливать заголовок страницы SET_TITLE [Y|N] При отмеченной опции на странице в качестве заголовка будет установлено Поиск пользователей.
Выбирать пользователей без заданного фильтра SHOW_USERS_WITHOUT_FILTER_SET [Y|N] При отмеченной опции на странице будут отображен список пользователей.
Поля пользователя для простой формы поиска USER_FIELDS_SEARCH_SIMPLE Указываются свойства пользователя, которые должны быть отображены на простой форме поиска сотрудника.
Пользовательские свойства пользователя для простой формы поиска USER_PROPERTIES_SEARCH_SIMPLE Указываются дополнительные свойства пользователя, которые также должны быть отображены на простой форме поиска сотрудника.
Поля пользователя для расширенной формы поиска USER_FIELDS_SEARCH_ADV Указываются свойства пользователя, которые должны быть отображены на расширенной форме поиска сотрудника.
Пользовательские свойства пользователя для расширенной формы поиска USER_PROPERTIES_SEARCH_ADV Указываются дополнительные свойства пользователя, которые также должны быть отображены на расширенной форме поиска сотрудника.
Поля пользователя для вывода в списке USER_FIELDS_LIST Указываются поля пользователя, которые должны быть отображены при показе списка сотрудников.
Пользовательские свойства пользователя для вывода в списке USER_PROPERTIES_LIST Указываются дополнительные свойства пользователя, которые также должны быть отображены при показе списка сотрудников.
Поля пользователя, по которым возможен поиск SONET_USER_FIELDS_SEARCHABLE Указываются поля пользователя, по которым будет осуществляться поиск сотрудников.
Пользовательские свойства пользователя, по которым возможен поиск SONET_USER_PROPERTY_SEARCHABLE Указываются дополнительные свойства пользователя, по которым также будет осуществляться поиск сотрудников.
Показывать год рождения SHOW_YEAR Параметр определяет для каких сотрудников должен быть отображен год рождения:
  • Y - всем;
  • M - только мужчинам;
  • N - никому.
Учитывать рейтинг в сортировке ALLOW_RATING_SORT [Y|N] При отмеченной опции при выводе поискового запроса по пользователям будет учитываться их рейтинг.
Включить рейтингSHOW_RATINGУказывается включать ли вывод рейтинга:
  • - по умолчанию;
  • Y - да;
  • N - нет.
РейтингRATING_IDУказывается какой будет использоваться рейтинг.
Вид кнопок рейтингаRATING_TYPEУказывается тип кнопки рейтинга:
  • - по умолчанию;
  • like - Мне нравится (текстовый);
  • like_graphic - Мне нравится (графический);
  • standart_text - Нравится / Не нравится (текстовый);
  • standart - Нравится / Не нравится (графический).
Имена переменных
Имя переменной для страницы PAGE_VAR Указывается имя переменной, которой передается страница социальной сети.
Имя переменной для пользователя USER_VAR Указывается имя переменной, которой передается идентификатор пользователя социальной сети.


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

<?$APPLICATION->IncludeComponent("bitrix:socialnetwork.user_search","",Array(
        "SET_NAVCHAIN" => "Y", 
        "PAGE_VAR" => "page", 
        "USER_VAR" => "user_id", 
        "PATH_TO_USER" => "index.php?page=user&user_id=#user_id#", 
        "PATH_TO_SEARCH" => "/company/index.php", 
        "PATH_TO_SEARCH_INNER" => "user_search.php", 
        "PATH_TO_USER_FRIENDS_ADD" => "user_friends_add.php?page=user_friends_add&user_id=#user_id#", 
        "PATH_TO_MESSAGE_FORM" => "message_form.php?page=message_form&user_id=#user_id#", 
        "PATH_TO_MESSAGES_CHAT" => "messages_chat.php?page=messages_chat&user_id=#user_id#", 
        "ITEMS_COUNT" => "10", 
        "DATE_TIME_FORMAT" => "d.m.Y H:i:s", 
        "SET_TITLE" => "Y", 
        "USER_FIELDS_SEARCH_SIMPLE" => Array(), 
        "SHOW_USERS_WITHOUT_FILTER_SET" => "N",
        "USER_PROPERTIES_SEARCH_SIMPLE" => Array("UF_DEPARTMENT"), 
        "USER_FIELDS_SEARCH_ADV" => Array("EMAIL"), 
        "USER_PROPERTIES_SEARCH_ADV" => Array("UF_DEPARTMENT"), 
        "USER_FIELDS_LIST" => Array("NAME","SECOND_NAME","LAST_NAME","EMAIL"), 
        "USER_PROPERTIES_LIST" => Array("UF_DEPARTMENT"), 
        "SONET_USER_FIELDS_SEARCHABLE" => Array("NAME","SECOND_NAME","LAST_NAME","EMAIL"), 
        "SONET_USER_PROPERTY_SEARCHABLE" => Array(), 
        "SHOW_YEAR" => "Y",
        "CACHE_TYPE" => "A",
        "CACHE_TIME" => "3600"
        "SHOW_RATING" => "Y",
        "RATING_ID" => array(),
    )
);?>


© «Битрикс», 2001-2020, «1С-Битрикс», 2020
Наверх