Онлайн-руководство разработчика NetCat
Модуль «Поиск по сайту» 12.2.1Начало работы с модулем 12.2.2Язык запросов 12.2.3Способы хранения индекса 12.2.4Интерфейс модуля в панели управления сайтом 12.2.5Области индексирования 12.2.6Области HTML-страниц 12.2.7Области поиска на сайте 12.2.8Индексирование по расписанию, запуск индексирования в фоновом режиме 12.2.9Правила индексирования 12.2.10Постановка задачи переиндексирования в очередь 12.2.11Интеграция модуля в макеты дизайна сайта 12.2.12Простая форма поиска 12.2.13Расширенная форма поиска 12.2.14Вывод результатов поиска 12.2.15Стилизация списка подсказок 12.2.16Расширенные настройки 12.2.17Разработка расширений модуля 12.2.18Обзор архитектуры модуля 12.2.19Обработчики документов различных типов 12.2.20Текстовые фильтры 12.2.21Анализаторы текста 12.2.22Корректировщики запросов 12.2.23Подключение других поисковых систем 12.2.24Решение проблем с поиском 12.2.25Решение проблем с индексированием 12.2.26Справочник API

Функции модуля

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

nc_blog_show_blogs()

Функция вывода листинга блогов, устарела, вместо неё используется функция nc_blog_list().
 

nc_blog_list ( $sub, $template = "", $orderBy = "", $ignore_access = "" ) 

Функция возвращает форматированный список блогов из раздела $sub сколько блогов, сами блоги, ссылки на них, сколько сообщений и юзеров.

Параметр Описание
$sub идентификатор директории с блогами
$template (опционально) шаблон вывода списка, аналогичный шаблонам вывода навигации
$orderBy (опционально) порядок сортировки списка, например "Users DESC, Subdivision_Name ASC"
$ignore_access (опционально) указывает на то, какой уровень доступа должен быть игнорирован при формировании результата, задаётся в виде числа или массива чисел, основывается на идентификаторах доступа, заданных в списке BlogMessagesAccess


nc_blog_get_blogs($sub, $orderBy = "", $ignore_access="")

Функция возвращает массив с полными данными о разделе с блогами, сколько блогов, сами блоги, ссылки на них, сколько сообщений и юзеров. Используется как вспомогательная функция для функции nc_blog_list().

Параметр Описание
$sub идентификатор директории с блогами
$orderBy (опционально) порядок сортировки списка, например "Users DESC, Subdivision_Name ASC", поля сортировки - ключи результирующего массива
$ignore_access (опционально) указывает на то, какой уровень доступа должен быть игнорирован при формировании результата, задаётся в виде числа или массива чисел, основывается на идентификаторах доступа, заданных в списке BlogMessagesAccess

Возвращает массив, каждый элемент которого - блог в разделе $sub.
 

nc_blog_check_name ( $sub, $blogname )

Функция проверяет, свободно ли имя $blogname в разделе $sub. Если блог (раздел) с таким именем уже есть в этом разделе, функция возвратит его идентификатор.

Пример использования:

<?=(nc_blog_check_name(123, "techno") ? "такой блог уже существует" : "");?>


nc_blog_user_permission ( $sub, $cc )

Функция возвратит права данного пользователя на текущйй раздел или компонент. Формат возвращаемого значения – «u», «m», «a». Что соответственно означает – пользователь, модератор, администратор.
 

nc_blog_get_type ( $sub, $is_child=false ) 

Функция возвращает тип блога. $sub – идентификатор раздела. Если раздел является блогом, то вызов функции должен осуществляться с параметром $is_child=1. Если раздел $sub является корневой директорией для блогов (корнем блогов), то дополнительный параметр не требуется.

Пример использования: для корневой директории:

<?=($blog_type=nc_blog_get_type(45)?"":””);?>

Для блога пользователя, который находится в корневой директории:

<?=($blog_type=nc_blog_get_type(55, 1)?"":””);?>


nc_blog_get_creator ( $sub )

Функция возвращает создателя блога с идентификатором $sub. $sub – идентификатор раздела блога.

Пример использования:

<?=($blog_creator=nc_blog_get_creator(55)?"":””);?>


nc_blog_get_blogtype() 

Функция является устаревшим аналогом nc_blog_get_type(). В данный момент следует использовать новую функцию nc_blog_get_type().


nc_blog_visual_settings ( $sub, $VS_template_Header="", $VS_template_Object="", $VS_template_Footer="" ) 

Функция вывода визуальных настроек во front-office.

  • $sub – идентификатор раздела, в котором осуществляется настройка;
  • $VS_template_Header - шапка макета вывода;
  • $VS_template_Object – объект в макете;
  • $VS_template_Footer – футер макета вывода.

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

<form name='adminForm' enctype='multipart/form-data' method='post' action='/netcat/modules/blog/add.php'>
    <input name='sub' value='$sub' type='hidden'>
    <input name='cc' value='$cc' type='hidden'>
    <input name='nc_blog_operation' value='visual_settings' type='hidden'>
    <?=NC_Blog_Visual_Settings($sub, $VS_template_Header, $VS_template_Object, $VS_template_Footer);?>
    <input value='Сохранить' type='submit'>
</form>


nc_blog_is_friend ( $friendID ) 

Данная функция определяет, является ли пользователь с идентификатором $friendID другом текущего пользователя. Предполагается применение только для личных блогов.
 

nc_blog_bbcode() 

Функция в данный момент не используется, т.к. Её функционал входит в состав функции nc_bbcode().


nc_blog_cut() 

Функция в данный момент не используется, т.к. Её функционал входит в состав функции nc_bbcode().

Описание проекта