Class Forums

[Строка 23]

Размещен: /Forums/Forums.class.php

Описание

Класс модуля "Форумы"


Свойства класса


Константы класса


Унаследованные константы класса


Унаследованные свойства класса


Методы

Унаследованные методы


Описания методов

    Forums::Forums

    Forums( );

    [ Наверх ]


    Forums::AddBbCode

    AddBbCode( mixed $BBpattern, mixed $BBreplace );

    Описание

    Добавление правила BB-кодов

    Принимаемые параметры

    $BBpattern

    регулярное выражение шаблона

    $BBreplace

    регулярное выражение замены

    [ Наверх ]


    Forums::AddEditTheme

    AddEditTheme( $conference_id, int $forums_id, int $theme_id, string $theme_title, int $theme_close, int $theme_notice, int $theme_visible, string $first_message, int $site_users_id, int $current_time, [array $param = array()] );

    Описание

    Добавление/редактирование темы

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $theme_id

    идентификатор темы

    $theme_title

    заголовок темы

    $theme_close

    флаг открытости (0 - закрыта, 1 - открыта)

    $theme_notice

    флаг объявления (1 - объявление)

    $theme_visible

    флаг видимости (0 - невидима, 1 - видима)

    $first_message

    текст первого сообщения

    $site_users_id

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

    $current_time

    текущее время в Unix формате

    $param

    массив дополнительных параметров:

    • $param['xslname'] string имя xsl шаблона письма куратору форума
    • $param['theme_send_letter'] int параметр, определяющий сообщать куратору форума о добавлении ответов или нет (1- сообщать, 0 - не сообщать). по умолчанию равен 0.
    • $param['content_type'] str по умолчанию 'text/plain'
    • $param['subject_add_theme'] str тема письма о добавлении темы, необязательное поле
    • $param['subject_edit_theme'] str тема письма о редактировании темы, необязательное поле
      1.  <?php
      2.  $Forums = new Forums();
      3.  
      4.  $conference_id = 1;
      5.  $forums_id = 1;
      6.  $theme_id = 0;
      7.  $theme_title 'Новая тема';
      8.  $theme_close = 1;
      9.  $theme_notice = 0;
      10.  $theme_visible = 1;
      11.  $first_message 'Текст первого сообщения';
      12.  $current_time date('Y-m-d H:i:s');
      13.  
      14.  // Если есть модуль "Пользователи сайта", получим текущего пользователя
      15.  if (class_exists('SiteUsers'))
      16.  {
      17.      $SiteUsers singleton('SiteUsers');
      18.     $site_users_id $SiteUsers->GetCurrentSiteUser();
      19.  }
      20.  else
      21.  {
      22.      $site_users_id = 0;
      23.  }
      24.  
      25.  $newid $Forums->AddEditTheme($conference_id$forums_id$theme_id$theme_title$theme_close$theme_notice$theme_visible$first_message$site_users_id$current_time);
      26.  
      27.  // Распечатаем результат
      28.  echo $newid;
      29.  ?>

    $conference_id

    Возвращает

    -2 -- сработала защита от флуда,
    -1 -- неверное значение CAPTCHA,

    1. -- не найден форум или конференция
    2. -- операция выполнена успешно

    [ Наверх ]


    Forums::ApplyTextFunctionWithoutCodeSection

    ApplyTextFunctionWithoutCodeSection( str $text, str $function_name );

    Описание

    Применение функции к фрагментам текста, содержащихся во вне блоков [code]...[/code]

    Принимаемые параметры

    $text

    текст

    $function_name

    имя метода класса

    [ Наверх ]


    Forums::BBcode2HTML

    BBcode2HTML( string $text, [bool $use_typograph = true] );

    Описание

    Замена BBcode на HTML.

    С версии 5.1.7 осуществляет типографирование текста, если модуль "Типограф" активен. Запрет на типографирование передается параметром или объявлением константы DENY_FORUM_TYPOGRAPH со значенем true

    Принимаемые параметры

    $text

    исходный текст

    $use_typograph

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

    Возвращает

    текст после замены

    [ Наверх ]


    Forums::CheckUsersAccessToForum

    CheckUsersAccessToForum( $param );

    Принимаемые параметры

    $param

    [ Наверх ]


    Forums::CloseForum

    CloseForum( int $forums_id );

    Описание

    Метод, закрывающий/открывающий форум

    Принимаемые параметры

    $forums_id

    идентификатор форума

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_id = 1;
    5.  
    6.  $result $Forums->CloseForum($forums_id);
    7.  
    8.  //Распечатаем результат
    9.  echo $result;
    10.  ?>

    [ Наверх ]


    Forums::CloseTheme

    CloseTheme( int $forums_id, int $forums_theme_id, [int $site_users_id = false] );

    Описание

    Открытие/закрытие темы для доступа

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $forums_theme_id

    идентификатор темы

    $site_users_id

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

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_id = 1;
    5.  $forums_theme_id = 1;
    6.  
    7.  $result $Forums->CloseTheme($forums_id$forums_theme_id);
    8.  
    9.  //Распечатаем результат
    10.  echo $result;
    11.  ?>

    [ Наверх ]


    Forums::CopyForum

    CopyForum( int $forums_id, [int $forums_group_id = false] );

    Описание

    Копирование информации о форуме

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $forums_group_id

    идентификатор группы форумов, куда следует скопировать данный форум, если не передан, используется текущая группа

    Возвращает

    Идентификатор скопированной записи, или False

    [ Наверх ]


    Forums::CopyForumsConference

    CopyForumsConference( int $forums_conference_id, [int $site_id = false], [int $structure_id = false] );

    Описание

    Копирование конференции, групп форумов, а так же форумов, входящих в данную конференцию

    Принимаемые параметры

    $forums_conference_id

    идентификатор конференции

    $site_id

    идентификатор сайта на который следует поместить копию конференции, если не передан, используется текущий

    $structure_id

    идентификатор структуры, с которой следует связать копию конференции, если не передан, используется текущая

    Возвращает

    идентификатор скопированной записи, либо False

    [ Наверх ]


    Forums::CopyForumsGroup

    CopyForumsGroup( int $forums_group_id, [int $forums_conference_id = false] );

    Описание

    Копирование информации о группе форумов

    Принимаемые параметры

    $forums_group_id

    идентификатор группы форумов

    $forums_conference_id

    идентификатор конференции, в которую следует перенести скопированную группу форумов

    Возвращает

    идентфикатор скопированной записи, либо False

    [ Наверх ]


    Forums::DeleteConference

    DeleteConference( int $forums_conference_id );

    Описание

    Метод удаления конференции вместе с принадлежащими ей группами форумов и т.п.

    Принимаемые параметры

    $forums_conference_id

    идентификатор конференции

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_conference_id = 2;
    5.  
    6.  $result $Forums->DeleteConference($forums_conference_id);
    7.  
    8.  if ($result)
    9.  {
    10.      echo "Удаление выполнено успешно";
    11.  }
    12.  else
    13.  {
    14.      echo "Ошибка удаления";
    15.  }
    16.  ?>

    Возвращает

    результат выполнения запроса

    [ Наверх ]


    Forums::DeleteForum

    DeleteForum( int $forums_id );

    Описание

    Метод удаления форума

    Принимаемые параметры

    $forums_id

    идентификатор форума

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_id = 5;
    5.  
    6.  $result $Forums->DeleteForum($forums_id);
    7.  
    8.  if ($result)
    9.  {
    10.     echo "Удаление выполнено успешно";
    11.  }
    12.  else
    13.  {
    14.      echo "Ошибка удаления";
    15.  }
    16.  ?>

    [ Наверх ]


    Forums::DeleteThemeUserSubscribe

    DeleteThemeUserSubscribe( array $param );

    Описание

    Удаление подписки пользователя сайта на тему форума

    Принимаемые параметры

    $param

    массив параметров

    • $param['theme_id'] идентификатор темы форума
    • $param['site_user_id'] идентификатор пользователя сайта

    [ Наверх ]


    Forums::DelForumsGroup

    DelForumsGroup( int $forums_group_id );

    Описание

    Метод удаления группы форумов

    Принимаемые параметры

    $forums_group_id

    идентификатор группы форумов

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_group_id = 3;
    5.  
    6.  $result $Forums->DelForumsGroup($forums_group_id);
    7.  
    8.  if ($result)
    9.  {
    10.      echo "Удаление выполнено успешно";
    11.  }
    12.  else
    13.  {
    14.      echo "Ошибка удаления";
    15.  }
    16.  ?>

    Возвращает

    результат выполнения запроса

    [ Наверх ]


    Forums::DelMessage

    DelMessage( int $forums_id, int $forums_theme_id, int $forums_message_id, int $site_users_id );

    Описание

    Метод удаления сообщения темы

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $forums_theme_id

    идентификатор темы форума

    $forums_message_id

    идентификатор сообщения темы

    $site_users_id

    идентификатор пользователя сайта, если false - определяется автоматически. по умолчанию false

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_id = 1;
    5.  $forums_theme_id = 4;
    6.  $forums_message_id = 7;
    7.  
    8.  // Если есть модуль "Пользователи сайта", получим текущего пользователя
    9.  if (class_exists('SiteUsers'))
    10.  {
    11.      $SiteUsers singleton('SiteUsers');
    12.     $site_users_id $SiteUsers->GetCurrentSiteUser();
    13.  }
    14.  else
    15.  {
    16.      $site_users_id = 0;
    17.  }
    18.  
    19.  $result $Forums->DelMessage($forums_id$forums_theme_id$forums_message_id$site_users_id);
    20.  
    21.  if ($result)
    22.  {
    23.     echo "Удаление выполнено успешно";
    24.  }
    25.  else
    26.  {
    27.      echo "Ошибка удаления";
    28.  }
    29.  ?>

    [ Наверх ]


    Forums::DelTheme

    DelTheme( $conference_id, int $forums_id, int $forums_theme_id, [int $site_users_id = false] );

    Описание

    Удаление темы форума

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $forums_theme_id

    идентификатор темы

    $site_users_id

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

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $conference_id = 1;
    5.  $forums_id = 1;
    6.  $forums_theme_id = 3;
    7.  
    8.  $result $Forums->DelTheme($conference_id$forums_id$forums_theme_id);
    9.  
    10.  if ($result)
    11.  {
    12.     echo "Удаление выполнено успешно";
    13.  }
    14.  else
    15.  {
    16.     echo "Ошибка удаления";
    17.  }
    18.  ?>

    $conference_id

    [ Наверх ]


    Forums::GenAddEditThemeXML

    GenAddEditThemeXML( int $forums_id, int $theme_id, int $site_users_id, int $current_page, stringe $xslname, [string $error = ''], [array $param = array()], [ $conference_id = 0] );

    Описание

    УСТАРЕВШИЙ метод формирования XML для формы добавления/редактирования темы и вывод его на экран в соответствии с указанным xsl шаблоном

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $theme_id

    идентификатор темы форума

    $site_users_id

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

    $current_page

    индекс текущей страницы

    $xslname

    имя xsl шаблона

    $error

    текст сообщения об ошибке

    $param

    массив параметров темы:
    $param['theme_close'] int флаг закрытости темы;
    $param['theme_notice'] int флаг объявления;
    $param['theme_visible'] int флаг видимости;
    $param['theme_title'] string заголовок темы;
    $param['theme_message_text'] string текст первого сообщения;
    $param['theme_send_letter'] string отправлять письма с ответами на тему

    $conference_id

    [ Наверх ]


    Forums::GenEditMessageXML

    GenEditMessageXML( int $forums_id, int $forums_theme_id, int $forums_message_id, int $site_users_id, int $current_page_theme, int $current_page_message, string $xslname, [ $error = ''], [array $param = array()], string $error='' );

    Описание

    УСТАРЕШИЙ Метод формирования XML для формы редактирования сообщения и вывод его на экран в соответствии с указанным xsl шаблоном

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $forums_theme_id

    идентификатор темы

    $forums_message_id

    идентификатор сообщения

    $site_users_id

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

    $current_page_theme

    индекс текущей страницы тем

    $current_page_message

    индекс текущей страницы сообщений

    $xslname

    имя xsl шаблона

    $error=''

    текст сообщения об ошибке

    $param

    массив параметров сообщения:
    $param['message_theme'] string тема собщения;
    $param['message_текст'] string текст сообщения

    $error

    [ Наверх ]


    Forums::GenMessageXML

    GenMessageXML( int $forums_id, int $forums_theme_id, int $site_users_id, int $current_page_theme, int $current_page_message, int $items_on_page, string $xslname, [string $error = ''], [array $param = array()] );

    Описание

    Устаревший метод, формирующий XML для таблицы сообщений темы и выводящий его на экран в соответствии с указанным xsl шаблоном

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $forums_theme_id

    идентификатор темы форума

    $site_users_id

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

    $current_page_theme

    индекс текущей страницы тем

    $current_page_message

    индекс текущей страницы сообщений

    $items_on_page

    количество элементов на странице

    $xslname

    имя xsl шаблона

    $error

    текст сообщения об ошибке

    $param

    массив дополнительных параметров

    [ Наверх ]


    Forums::GenSmilesXML

    GenSmilesXML( );

    Описание

    Метод возвращает XML для смайликов

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $newxml $Forums->GenSmilesXML();
    5.  
    6.  // Распечатаем результат
    7.  echo htmlspecialchars($newxml);
    8.  ?>

    Возвращает

    XML

    [ Наверх ]


    Forums::GenUserInfoXML

    GenUserInfoXML( int $forums_id, int $theme_id, int $site_users_id, string $xslname, [ $current_page_theme = 0], [ $current_page_message = 0], [ $error = ''], int $current_page_theme=0, int $current_page_message=0, string $error='' );

    Описание

    УСТАРЕВШИЙ Метод формирования XML для пользователя форума и вывод информации на экран в соответствии с указанным xsl шаблоном

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $theme_id

    идентификатор темы

    $site_users_id

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

    $xslname

    имя xsl шаблона

    $current_page_theme=0

    индекс текущей страницы тем

    $current_page_message=0

    индекс текущей страницы сообщений

    $error=''

    текст сообщения об ошибке

    $current_page_theme

    $current_page_message

    $error

    [ Наверх ]


    Forums::GenXml4InsertEditLetters

    GenXml4InsertEditLetters( array $param, [array $external_propertys = array()] );

    Описание

    Генерация XML для письма о вставке/редактировании

    Принимаемые параметры

    $param

    параметры

    $external_propertys

    массив дополнительных свойств для включения в XML

    [ Наверх ]


    Forums::GenXML4Message

    GenXML4Message( $conference_id, $forum_id, int $forum_message_id, $site_users_id, [ $param = array()], array $row );

    Описание

    Генерация XML для сообщения

    Принимаемые параметры

    $forum_message_id

    идентификатор сообщения

    $row

    массив, содержащзий информацию о сообщении

    $conference_id

    $forum_id

    $site_users_id

    $param

    Возвращает

    строка с XML

    [ Наверх ]


    Forums::GenXml4Theme

    GenXml4Theme( int $forums_theme_id, [ $site_users_id = false], [ $row = false], [ $param = array()] );

    Описание

    Формирование XML для темы форума

    Принимаемые параметры

    $forums_theme_id

    идентификатор темы форума

    $site_users_id

    $row

    $param

    Возвращает

    XMl с данными о теме форума

    [ Наверх ]


    Forums::GetAllConferences

    GetAllConferences( [int $site_id = false] );

    Описание

    Получение информации о всех конференциях сайт.

    Принимаемые параметры

    $site_id

    - идентификатор сайта, если false, то метод вернёт информацию обо всех конференциях всех сайтов.

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $site_id = CURRENT_SITE;
    5.  
    6.  $resource $Forums->GetAllConferences($site_id);
    7.  
    8.  // Распечатаем результат
    9.  while($row mysql_fetch_assoc($resource))
    10.  {
    11.      print_r($row);
    12.  }
    13.  ?>

    Возвращает

    Информация о конференциях.

    [ Наверх ]


    Forums::GetAllForums

    GetAllForums( [int $forums_group_id = false] );

    Описание

    Метод для получения всех форумов

    Принимаемые параметры

    $forums_group_id

    идентификатор группы форумов, если false - получаем форумы всех групп

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_group_id = 1;
    5.  
    6.  $resource $Forums->GetAllForums($forums_group_id);
    7.  
    8.  // Распечатаем результат
    9.  while($row mysql_fetch_assoc($resource))
    10.  {
    11.      print_r($row);
    12.  }
    13.  ?>

    Возвращает

    результат выборки

    [ Наверх ]


    Forums::GetAllForumsGroup

    GetAllForumsGroup( [int $forums_conference_id = false] );

    Описание

    Метод для получения списка всех групп

    Принимаемые параметры

    $forums_conference_id

    идентификатор конференции, если false - метод возвращает список всех конференций

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_conference_id = 1;
    5.  
    6.  $resource $Forums->GetAllForumsGroup($forums_conference_id);
    7.  
    8.  // Распечатаем результат
    9.  while($row mysql_fetch_assoc($resource))
    10.  {
    11.      print_r($row);
    12.  }
    13.  ?>

    Возвращает

    результат выборки

    [ Наверх ]


    Forums::GetAllMessages

    GetAllMessages( [int $forums_theme_id = false], [int $limit_begin = false], [int $limit_count = false], [array $param = array()] );

    Описание

    Метод для получения всех сообщений

    Принимаемые параметры

    $forums_theme_id

    идентификатор темы, если false - получаем сообщения всех тем

    $limit_begin

    строка, с которой выбирать, по умолчанию false

    $limit_count

    количество выбираемых строк, по умочанию false

    $param

    массив дополнительных атрибутов

    • $param['order_field'] - поле сортировки, по умолчанию 'forums_message_datetime'
    • $param['order_type'] - направление сортировки, по умолчанию 'ASC'
      1.  <?php
      2.  $Forums = new Forums();
      3.  
      4.  $row $Forums->GetAllMessages();
      5.  
      6.  // Распечатаем результат
      7.  print_r ($row);
      8.  ?>

    Возвращает

    с результатом выборки или false

    [ Наверх ]


    Forums::GetConference

    GetConference( int $forums_conference_id );

    Описание

    Метод для получения информации о конференции.

    Принимаемые параметры

    $forums_conference_id

    идентификатор конференции.

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_conference_id = 1;
    5.  
    6.  $row $Forums->GetConference($forums_conference_id);
    7.  
    8.  // Распечатаем результат
    9.  print_r ($row);
    10.  ?>

    Возвращает

    возвращает ассоциативный массив с информацией о конференции.

    [ Наверх ]


    Forums::GetConferencePath

    GetConferencePath( int $forums_conference_id );

    Описание

    Получение пути к конференции по ее идентификатору

    Принимаемые параметры

    $forums_conference_id

    идентификатор конференции

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_conference_id = 1;
    5.  
    6.  $path $Forums->GetConferencePath($forums_conference_id);
    7.  
    8.  // Распечатаем результат
    9.  echo $path;
    10.  ?>

    Возвращает

    путь к конференции или false, если конференция не найдена

    [ Наверх ]


    Forums::GetCountMessageTheme

    GetCountMessageTheme( int $forums_theme_id );

    Описание

    Получение количества сообщений в теме

    Принимаемые параметры

    $forums_theme_id

    идентификатор темы

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_theme_id = 1;
    5.  
    6.  $count $Forums->GetCountMessageTheme($forums_theme_id);
    7.  
    8.  // Распечатаем результат
    9.  echo $count;
    10.  ?>

    Возвращает

    количество сообщений

    [ Наверх ]


    Forums::GetForum

    GetForum( int $forums_id );

    Описание

    Получение информации о форуме

    Принимаемые параметры

    $forums_id

    идентификатор форума

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_id = 1;
    5.  
    6.  $row $Forums->GetForum($forums_id);
    7.  
    8.  // Распечатаем результат
    9.  print_r ($row);
    10.  ?>

    Возвращает

    массив с данными о форуме или ложь, если форум не найден

    [ Наверх ]


    Forums::GetForumAccess

    GetForumAccess( int $forums_id );

    Описание

    Метод, возвращающий список групп пользователей имеющих права доступа к указанному форуму

    Принимаемые параметры

    $forums_id

    идентификатор форума

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_id = 1;
    5.  
    6.  $row $Forums->GetForumAccess($forums_id);
    7.  
    8.  // Распечатаем результат
    9.  print_r ($row);
    10.  ?>

    Возвращает

    массив идентификаторов групп пользователей сайта

    [ Наверх ]


    Forums::GetForumAndItemIdFromPath

    GetForumAndItemIdFromPath( int $forums_conference_id, [array $path_array = array()] );

    Описание

    Получение данных об идентификаторе форума и темы по переданному массиву с элементами пути

    Принимаемые параметры

    $forums_conference_id

    идентификатор конференции

    $path_array

    массив с элементами пути, если не передан, используется $GLOBALS['URL_ARRAY']

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_conference_id = 1;
    5.  $path_array $GLOBALS['URL_ARRAY'];
    6.  
    7.  $row $Forums->GetForumAndItemIdFromPath($forums_conference_id$path_array);
    8.  
    9.  // Распечатаем результат
    10.  print_r ($row);
    11.  ?>

    Возвращает


    $result['forum'] - идентификатор форума или false
    $result['theme'] - идентификатор темы или false

    [ Наверх ]


    Forums::GetForumsGroup

    GetForumsGroup( int $forums_group_id );

    Описание

    Метод возвращает информацию о группе форумов

    Принимаемые параметры

    $forums_group_id

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_group_id = 1;
    5.  
    6.  $row $Forums->GetForumsGroup($forums_group_id);
    7.  
    8.  // Распечатаем результат
    9.  print_r ($row);
    10.  ?>

    Возвращает

    ассоциативный массив с ифнормацией о группе форумов или false, если группа с указанным идентификатором отсутствует

    [ Наверх ]


    Forums::GetForumsUsersGroupList

    GetForumsUsersGroupList( int $forums_users_group_list_id );

    Описание

    Получение данных о связи группы пользователей с форумом

    Принимаемые параметры

    $forums_users_group_list_id

    Идентификатор связи

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_users_group_list_id = 1;
    5.  
    6.  $row $Forums->GetForumsUsersGroupList($forums_users_group_list_id);
    7.  
    8.  // Распечатаем результат
    9.  print_r ($row);
    10.  ?>

    Возвращает

    массив данных, либо False

    [ Наверх ]


    Forums::GetForumView

    GetForumView( $site_users_id $site_users_id, $forums_id $forums_id );

    Описание

    Получение информации о дате последнего просмотра форума пользователем

    Принимаемые параметры

    $site_users_id

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

    $forums_id

    идентификатор форума

    Возвращает

    массив или false

    [ Наверх ]


    Forums::GetLastPageTheme

    GetLastPageTheme( int $forums_theme_id );

    Описание

    Получение номера последней страницы темы

    Принимаемые параметры

    $forums_theme_id

    идентификатор темы

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_theme_id = 1;
    5.  
    6.  $page $Forums->GetLastPageTheme($forums_theme_id);
    7.  
    8.  // Распечатаем результат
    9.  echo $page;
    10.  ?>

    Возвращает

    номер последней страницы темы

    [ Наверх ]


    Forums::GetMessage

    GetMessage( int $forums_message_id );

    Описание

    Получение информации о сообщении

    Принимаемые параметры

    $forums_message_id

    идентификатор сообщения

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_message_id = 1;
    5.  
    6.  $row $Forums->GetMessage($forums_message_id);
    7.  
    8.  // Распечатаем результат
    9.  print_r ($row);
    10.  ?>

    Возвращает

    возвращает ассоциативный массив с информацией о сообщении

    [ Наверх ]


    Forums::GetTheme

    GetTheme( int $forums_theme_id );

    Описание

    Метод возвращает информацию о теме форума

    Принимаемые параметры

    $forums_theme_id

    идентификатор темы

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_theme_id = 1;
    5.  
    6.  $row $Forums->GetTheme($forums_theme_id);
    7.  
    8.  //Распечатаем результат
    9.  print_r ($row);
    10.  ?>

    Возвращает

    ассоциативный массив с данными или ложь, если тема не найдена

    [ Наверх ]


    Forums::GetThemeId

    GetThemeId( );

    Описание

    Получение идентификатора добавленнной темы форума

    Возвращает

    идентификатор добавленной темы форума

    [ Наверх ]


    Forums::GetThemeLastMessage

    GetThemeLastMessage( $forums_theme_id $forums_theme_id );

    Описание

    Получение последнего сообщения темы

    Принимаемые параметры

    $forums_theme_id

    идентификатор темы

    Возвращает

    массив или false

    [ Наверх ]


    Forums::GetThemeView

    GetThemeView( $site_users_id $site_users_id, $forums_theme_id $forums_theme_id );

    Описание

    Получение информации о дате последнего просмотра темы форума пользователем

    Принимаемые параметры

    $site_users_id

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

    $forums_theme_id

    идентификатор темы форума

    Возвращает

    массив или false

    [ Наверх ]


    Forums::GetTmpId

    GetTmpId( );

    [ Наверх ]


    Forums::IncCountMessage

    IncCountMessage( int $site_users_id );

    Описание

    Метод наращивания счётчика количества сообщений для пользователя

    Принимаемые параметры

    $site_users_id

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

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  // Если есть модуль "Пользователи сайта", получим текущего пользователя
    5.  if (class_exists('SiteUsers'))
    6.  {
    7.      $SiteUsers singleton('SiteUsers');
    8.      $site_users_id $SiteUsers->GetCurrentSiteUser();
    9.  }
    10.  else
    11.  {
    12.      $site_users_id = 0;
    13.  }
    14.  
    15.  $result $Forums->IncCountMessage($site_users_id);
    16.  
    17.  // Распечатаем результат
    18.  echo $result;
    19.  ?>

    [ Наверх ]


    Forums::IndexationForums

    IndexationForums( int $limit, int $on_step, [array $parameters = array()] );

    Описание

    Метод индексации форумов

    Принимаемые параметры

    $limit

    сколько записей проиндексировано

    $on_step

    сколько индексировать

    $parameters

    массив дополнительных параметров

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $limit = 0;
    5.  $on_step = 10;
    6.  
    7.  $row $Forums->IndexationForums($limit$on_step);
    8.  
    9.  // Распечатаем результат
    10.  print_r ($row);
    11.  ?>

    Возвращает

    массив данных для индексации:
    $result[$i][0] string название страницы;
    $result[$i][1] string адрес страницы;
    $result[$i][2] string текст страницы;
    $result[$i][3] float размер страницы;
    $result[$i][4] int идентификатор сайта (0 - для всех сайтов);
    $result[$i][5] array массив идентификаторов групп пользователей (0 - для всех) $result[$i][6] string дата создания страницы

    [ Наверх ]


    Forums::IndexationForumsMessages

    IndexationForumsMessages( int $limit, int $on_step, [array $parameters = array()] );

    Описание

    Метод индексации сообщений тем форумов

    Принимаемые параметры

    $limit

    сколько записей проиндексировано

    $on_step

    сколько индексировать

    $parameters

    массив дополнительных параметров

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $limit = 0;
    5.  $on_step = 10;
    6.  
    7.  $row $Forums->IndexationForumsMessages($limit$on_step);
    8.  
    9.  // Распечатаем результат
    10.  print_r ($row);
    11.  ?>

    Возвращает

    массив данных для индексации:
    $result[$i][0] string название страницы;
    $result[$i][1] string адрес страницы;
    $result[$i][2] string текст страницы;
    $result[$i][3] float размер страницы;
    $result[$i][4] int идентификатор сайта (0 - для всех сайтов);
    $result[$i][5] array массив идентификаторов групп пользователей (0 - для всех) $result[$i][6] string дата создания страницы

    [ Наверх ]


    Forums::InsertConference

    InsertConference( array $param );

    Описание

    Метод, осуществляющий вставку информации о конференции.

    Принимаемые параметры

    $param

    ассоциативный массив параметров
    string $param['forums_conference_name'] название конференции
    string $param['forums_conference_description'] описание конференции
    int $param['structure_id'] узел структуры
    int $param['forums_conference_on_page_theme'] максимальное количество тем, которое может отображаться на странице
    int $param['forums_conference_on_page_message'] максимальное количество сообщений, которое может отображаться на странице
    int $param['forums_conference_flude_protection'] время задержки для защиты от флуда
    int $param['forums_conference_edit_time'] время, в течение которого можно редактировать свои сообщений
    int $param['forums_conference_del_time'] время, в течение которого можно удалять свои сообщений

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $param['forums_conference_name''Новая конференция';
    5.  $param['forums_conference_description''Описание конференции';
    6.  $param['structure_id'= 36;
    7.  $param['forums_conference_on_page_theme'= 10;
    8.  $param['forums_conference_on_page_message'= 10;
    9.  $param['forums_conference_flude_protection'= 5;
    10.  $param['forums_conference_edit_time'= 60;
    11.  $param['forums_conference_del_time'= 60;
    12.  
    13.  $newid $Forums->InsertConference($param);
    14.  
    15.  // Распечатаем результат
    16.  echo $newid;
    17.  ?>

    Возвращает

    идентификатор вставленной конференции ( false при неудачной вставке)

    [ Наверх ]


    Forums::InsertEditMessage

    InsertEditMessage( array $param, [array $external_propertys = array()] );

    Описание

    Добавление/редактирование сообщения

    Принимаемые параметры

    $param

    - $param['forums_conference_id'] идентификатор конференции

    • $param['forums_id'] идентификатор форума
    • $param['forums_theme_id'] идентификатор темы
    • $param['forums_theme_title'] заголовок сообщения
    • $param['forums_message_text'] текст сообщения
    • $param['site_users_id'] идентификатор пользователя сайта
    • $param['xsl_name_add_user'] имя XSL-шаблона для письма пользователю о добавлении
    • $param['xsl_name_add_curator'] имя XSL-шаблона для письма куратору форума о добавлении
    • $param['xsl_name_edit_user'] имя XSL-шаблона для письма пользователю о редактировании
    • $param['xsl_name_edit_curator'] имя XSL-шаблона для письма куратору форума о редактировании
    • $param['forums_message_id'] идентификатор сообщения для редактирования, необязательный параметр
    • $param['content_type_add_user'] по умолчанию 'text/plain'
    • $param['content_type_add_curator'] по умолчанию 'text/plain'
    • $param['content_type_edit_user'] по умолчанию 'text/plain'
    • $param['content_type_edit_curator'] по умолчанию 'text/plain'

    $external_propertys

    массив дополнительных свойств для включения в XML

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $param['forums_conference_id'= 1;
    5.  $param['forums_id'= 1;
    6.  $param['forums_theme_id'= 1;
    7.  $param['forums_theme_title''Тема_1';
    8.  $param['forums_message_text''Текст Тема_1';
    9.  $param['xsl_name_add_user''ПисьмоДобавленияСообщенияПользователю';
    10.  $param['xsl_name_add_curator''ПисьмоОДобавленииСообщения';
    11.  $param['xsl_name_edit_user''ПисьмоРедактированияСообщенияПользователю';
    12.  $param['xsl_name_edit_curator''ПисьмоРедактированияСообщенияКуратору';
    13.  
    14.  // Если есть модуль "Пользователи сайта", получим текущего пользователя
    15.  if (class_exists('SiteUsers'))
    16.  {
    17.      $SiteUsers singleton('SiteUsers');
    18.     $site_users_id $SiteUsers->GetCurrentSiteUser();
    19.  }
    20.  else
    21.  {
    22.      $site_users_id = 0;
    23.  }
    24.  
    25.  $param['site_users_id'$site_users_id;
    26.  
    27.  $result $Forums->InsertEditMessage($param);
    28.  
    29.  // Распечатаем результат
    30.  echo $result;
    31.  ?>

    [ Наверх ]


    Forums::InsertForum

    InsertForum( array $param );

    Описание

    Добавление/редактирование форума

    Принимаемые параметры

    $param

    массив параметров
    int $param['forums_id'] идентификатор форума
    int $param['forums_group_id'] идентификатор группы форумов
    string $param['forums_name'] название форума
    string $param['forums_description'] описание форума
    string $param['forums_curator_email'] E-mail куратора форума
    int $param['forums_postmoderation'] использовать ли постмодерацию (0 - нет, 1 - да)
    int $param['visible4all'] отображать ли содержимое форума всем посетителям (0 - нет, 1 - да)
    int $param['forums_captcha_used'] использовать ли CAPTCHA (0 - нет, 1 - да)
    int $param['forums_allow_guest'] разрешить добавлять сообщения гостям (0 - нет, 1 - да)
    int $param['users_id'] идентификатор пользователя, если false - берется текущий пользователь.

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $param['forums_id'= 0;
    5.  $param['forums_group_id'= 1;
    6.  $param['forums_name''Новый форум';
    7.  $param['forums_description''Описание форума';
    8.  $param['forums_curator_email''admin@site.ru';
    9.  $param['forums_postmoderation'= 0;
    10.  $param['visible4all'= 0;
    11.  $param['forums_captcha_used'= 0;
    12.  $param['forums_allow_guest'= 0;
    13.  
    14.  $newid $Forums->InsertForum($param);
    15.  
    16.  // Распечатаем результат
    17.  echo $newid;
    18.  ?>

    Возвращает

    идентификатор вставленной/обновленной записи

    [ Наверх ]


    Forums::InsertForumsGroup

    InsertForumsGroup( int $forums_group_id, string $forums_group_name, string $forums_group_comment, int $forums_conference_id, [int $users_id = false] );

    Описание

    Метод добавления/редактирования группы форумов

    Принимаемые параметры

    $forums_group_id

    идентификатор группы форумов

    $forums_group_name

    название группы форумов

    $forums_group_comment

    коментарий к группе форумов

    $forums_conference_id

    идентификатор конференции.

    $users_id

    идентификатор пользователя, если false - берется текущий пользователь.

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_group_id = 0;
    5.  $forums_group_name 'Group1';
    6.  $forums_group_comment 'Коментарий к группе форумов';
    7.  $forums_conference_id = 1;
    8.  
    9.  $newid $Forums->InsertForumsGroup($forums_group_id$forums_group_name$forums_group_comment$forums_conference_id);
    10.  
    11.  // Распечатаем результат
    12.  echo $newid;
    13.  ?>

    Возвращает

    идентификатор вставленной/обновленной записи

    [ Наверх ]


    Forums::InsertForumView

    InsertForumView( $site_users_id $site_users_id, $forums_theme_id $forums_theme_id, [$forums_view_datetime $forums_view_datetime = false] );

    Описание

    Вставка информации о дате последнего посещения темы форума пользователем.

    Если пользователь уже посещал тему, то информация о дате посещения обновится.

    Принимаемые параметры

    $site_users_id

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

    $forums_theme_id

    идентификатор темы форума

    $forums_view_datetime

    дата время в формате MySQL или false. Если указано false - устанавливется текущее дата-время. Необязательное поле.

    [ Наверх ]


    Forums::InsertTheme

    InsertTheme( array $param );

    Описание

    Вставка/обновление информации о теме

    Принимаемые параметры

    $param

    дополнительные праметры

    • int $param['forums_theme_id'] идентификатор темы форума, необязательный параметр
    • int $param['forums_id'] идентификатор форума
    • int $param['forums_theme_visible'] тема видима
    • int $param['forums_theme_notice'] тема является объявлением
    • int $param['forums_theme_close'] тема закрыта
    • int $param['forums_theme_send_letter'] оповещать создателя темы о новых сообщениях
    • int $param['users_id'] идентификатор пользователя, если false - берется текущий пользователь
      1.  <?php
      2.  $Forums = new Forums();
      3.  
      4.  $param['forums_id'= 1;
      5.  $param['forums_theme_visible'= 1;
      6.  $param['forums_theme_notice'= 0;
      7.  $param['forums_theme_close'= 0;
      8.  
      9.  $newid $Forums->InsertTheme($param);
      10.  
      11.  // Распечатаем результат
      12.  echo $newid;
      13.  ?>

    Возвращает

    результат вставки

    [ Наверх ]


    Forums::InsertThemeUserSubscribe

    InsertThemeUserSubscribe( array $param );

    Описание

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

    Принимаемые параметры

    $param

    массив параметров

    • $param['theme_id'] идентификатор темы форума
    • $param['site_user_id'] идентификатор пользователя сайта

    [ Наверх ]


    Forums::InsertUsersGroup

    InsertUsersGroup( int $forums_id, int $site_users_group_id, int $moderator, int $users_id );

    Описание

    Метод добавления/редактирования группы пользователей для определения доступа к форуму

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $site_users_group_id

    идентификатор группы пользователей

    $moderator

    является ли эта группа модераторами (0 - нет, 1 - да)

    $users_id

    идентификатор пользователя центра администрирования, добавившего запись

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_id = 1;
    5.  $site_users_group_id = 7;
    6.  $moderator = 1;
    7.  
    8.  $result $Forums->InsertUsersGroup($forums_id$site_users_group_id$moderator);
    9.  
    10.  if ($result)
    11.  {
    12.     echo "Доступ разрешен";
    13.  }
    14.  else
    15.  {
    16.     echo "Ошибка получения доступа";
    17.  }
    18.  ?>

    [ Наверх ]


    Forums::IssetForumAccess

    IssetForumAccess( $forums_id $forums_id, [$site_users_id $site_users_id = false], [$is_moderator $is_moderator = true] );

    Описание

    Определение доступа пользователя к форуму

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $site_users_id

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

    $is_moderator

    проверять на принадлежность пользователя группе модераторов

    [ Наверх ]


    Forums::IssetThemeUserSubscribe

    IssetThemeUserSubscribe( array $param );

    Описание

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

    Принимаемые параметры

    $param

    массив параметров

    • $param['theme_id'] идентификатор темы форума
    • $param['site_user_id'] идентификатор пользователя сайта

    [ Наверх ]


    Forums::MessageIsTheme

    MessageIsTheme( int $forum_theme_id, int $forum_message_id );

    Описание

    Проверка сообщения на то, что является ли оно темой

    Принимаемые параметры

    $forum_theme_id

    идентификатор темы

    $forum_message_id

    идентификатор сообщения

    [ Наверх ]


    Forums::NoticeTheme

    NoticeTheme( int $forums_id, int $forums_theme_id, [int $site_users_id = false] );

    Описание

    Метод делающий тему объявлением или наоборот

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $forums_theme_id

    идентификатор темы

    $site_users_id

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_id = 1;
    5.  $forums_theme_id = 1;
    6.  
    7.  $result $Forums->NoticeTheme($forums_id$forums_theme_id);
    8.  
    9.  //Распечатаем результат
    10.  echo $result;
    11.  ?>

    [ Наверх ]


    Forums::OrderForums

    OrderForums( int $forums_group_id, array $mas_orders );

    Описание

    Метод изменения порядка сортировки форумов в группе

    Принимаемые параметры

    $forums_group_id

    идентификатор группы форумов

    $mas_orders

    массив коэффициентов вида $mas_orders['order<идентификатор форума>']

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_group_id = 1;
    5.  $mas_orders['order1'= 20;
    6.  $mas_orders['order2'= 10;
    7.  
    8.  $result $Forums->OrderForums($forums_group_id$mas_orders);
    9.  
    10.  // Распечатаем результат
    11.  echo $result;
    12.  ?>

    [ Наверх ]


    Forums::OrderForumsGroup

    OrderForumsGroup( array $mas_orders );

    Описание

    Метод изменения порядка сортировки групп форумов

    Принимаемые параметры

    $mas_orders

    массив коэффициентов вида $mas_orders['order<идентификатор группы форумов>']

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $mas_orders['order1'= 20;
    5.  $mas_orders['order2'= 10;
    6.  
    7.  $result $Forums->OrderForumsGroup($mas_orders);
    8.  
    9.  // Распечатаем результат
    10.  echo $result;
    11.  ?>

    [ Наверх ]


    Forums::SearchIndexing

    SearchIndexing( $limit $limit, $on_step $on_step );

    Описание

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

    Принимаемые параметры

    $limit

    текущая позиция

    $on_step

    шаг

    [ Наверх ]


    Forums::SelectFormThemes

    SelectFormThemes( mixed $forums_id, int $item_begin, int $items_count, [array $param = array()] );

    Описание

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

    Принимаемые параметры

    $forums_id

    идентификатор или массив идентификаторов форума

    $item_begin

    номер записи, с которой надо начать выборку

    $items_count

    число записей в выборке

    $param

    массив дополнительных параметров

    • $param['order_by_forums_theme_notice'] показывать темы-объявления в начале списка, по умочланию true
    • $param['OrderField'] поле сортировки, по умолчанию 'datetime_max'.
    Возможны сортировки по 'datetime_max', 'datetime_min', 'count' и другим полям.
    • $param['OrderType'] направление сортировки, по умолчанию DESC
      1.  <?php
      2.  $Forums = new Forums();
      3.  
      4.  $forums_id = 1;
      5.  $item_begin = 0;
      6.  $items_count = 5;
      7.  
      8.  $resource $Forums->SelectFormThemes($forums_id$item_begin$items_count);
      9.  
      10.  // Распечатаем результат
      11.  while($row mysql_fetch_assoc($resource))
      12.  {
      13.      print_r($row);
      14.  }
      15.  ?>

    Возвращает

    в случае успешного выполнения, false - в противном случае

    [ Наверх ]


    Forums::SelectForumsGroup

    SelectForumsGroup( int $forums_group_id );

    Описание

    Устарвший метод, возвращающий информацию о группе форумов

    Принимаемые параметры

    $forums_group_id

    идентификатор группы форумов (-1 выбрать все)

    Возвращает

    resource при успешном выполнении операции,
    boolean false в противном случае

    [ Наверх ]


    Forums::SelectMessage

    SelectMessage( int $forums_message_id );

    Описание

    Метод возвращающий информацию о сообщении

    Принимаемые параметры

    $forums_message_id

    идентификатор сообщения

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_message_id = 1;
    5.  
    6.  $resource $Forums->SelectMessage($forums_message_id);
    7.  
    8.  // Распечатаем результат
    9.  while($row mysql_fetch_assoc($resource))
    10.  {
    11.      print_r($row);
    12.  }
    13.  ?>

    Возвращает

    resource при успешном выполнении операции,
    boolean false в противном случае

    [ Наверх ]


    Forums::SelectThemeSubscribers

    SelectThemeSubscribers( int $theme_id );

    Описание

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

    Принимаемые параметры

    $theme_id

    идентификатор темы форума

    [ Наверх ]


    Forums::SelectUserSubscriptions

    SelectUserSubscriptions( int $site_users_id );

    Описание

    Получение списка подписанных тем форума

    Принимаемые параметры

    $site_users_id

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

    [ Наверх ]


    Forums::SetModerator

    SetModerator( int $forums_users_group_list_id );

    Описание

    Метод установления/снятия прав модератора текущего форума для группы пользователей

    Принимаемые параметры

    $forums_users_group_list_id

    идентификатор в таблице связи форумов и групп пользователей

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_users_group_list_id = 1;
    5.  
    6.  $result $Forums->SetModerator($forums_users_group_list_id);
    7.  
    8.  if ($result)
    9.  {
    10.     echo "Права установлены";
    11.  }
    12.  else
    13.  {
    14.     echo "Ошибка установки прав";
    15.  }
    16.  ?>

    [ Наверх ]


    Forums::SetThemeId

    SetThemeId( int $theme_id );

    Описание

    Установка значения идентификатора добавленной темы форума

    Принимаемые параметры

    $theme_id

    идентификатор добавленной темы форума

    [ Наверх ]


    Forums::ShowAddEditTheme

    ShowAddEditTheme( $conference_id, int $forums_id, int $theme_id, stringe $xslname, [ $external_propertys = array()], [array $param = array()], int $site_users_id, int $current_page );

    Описание

    Формирование XML для формы добавления/редактирования темы и вывод его на экран в соответствии с указанным xsl шаблоном

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $theme_id

    идентификатор темы форума

    $site_users_id

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

    $current_page

    $xslname

    имя xsl шаблона

    $param

    массив параметров темы:
    $param['theme_close'] int флаг закрытости темы;
    $param['theme_notice'] int флаг объявления;
    $param['theme_visible'] int флаг видимости;
    $param['theme_title'] string заголовок темы;
    $param['theme_message_text'] string текст первого сообщения;
    $param['theme_send_letter'] string отправлять письма с ответами на тему;
    $param['site_users_id'] идентификатор пользователя сайта, если не передан - определяется автоматически $param['current_page'] int индекс текущей страницы

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $conference_id = 1;
    5.  $forums_id = 1;
    6.  $theme_id = 1;
    7.  $xslname 'СозданиеТемы';
    8.  
    9.  $Forums->ShowAddEditTheme($conference_id$forums_id$theme_id$xslname);
    10.  ?>

    $conference_id

    $external_propertys

    [ Наверх ]


    Forums::ShowConference

    ShowConference( int $conference_id, string $xslname, [array $external_propertys = array()], [array $param = array()] );

    Описание

    Метод отображения конференции

    Принимаемые параметры

    $conference_id

    идентификатор конференции

    $xslname

    имя XSL-шаблона для отображения

    $external_propertys

    массив внешних параметров, передающихся в XML

    $param

    массив дополнительных параметров

    • $param['site_users_id'] - идентификатор пользователя сайта, если не передан - определяется автоматически
      1.  <?php
      2.  $Forums = new Forums();
      3.  
      4.  $conference_id = 1;
      5.  $xslname 'Форумы';
      6.  
      7.  $Forums->ShowConference($conference_id$xslname);
      8.  
      9.  ?>

    Возвращает


    -1 -- Конференция с указанным кодом не найдена

    [ Наверх ]


    Forums::ShowEditMessage

    ShowEditMessage( $conference_id, int $forums_id, int $forums_theme_id, int $forums_message_id, string $xslname, [ $external_propertys = array()], [array $param = array()], int $site_users_id, int $current_page_theme, int $current_page_message, string $error='' );

    Описание

    Формирование XML для формы редактирования сообщения и вывод его на экран в соответствии с указанным xsl шаблоном

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $forums_theme_id

    идентификатор темы

    $forums_message_id

    идентификатор сообщения

    $site_users_id

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

    $current_page_theme

    индекс текущей страницы тем

    $current_page_message

    индекс текущей страницы сообщений

    $xslname

    имя xsl шаблона

    $error=''

    текст сообщения об ошибке

    $param

    массив параметров сообщения:
    $param['message_theme'] string тема собщения;
    $param['message_текст'] string текст сообщения

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $conference_id = 1;
    5.  $forums_id = 1;
    6.  $forums_theme_id = 5;
    7.  $forums_message_id = 8;
    8.  $xslname 'РедактированиеСообщения';
    9.  
    10.  $Forums->ShowEditMessage($conference_id$forums_id$forums_theme_id$forums_message_id$xslname);
    11.  ?>

    $conference_id

    $external_propertys

    [ Наверх ]


    Forums::ShowForumRss

    ShowForumRss( int $forums_id, [int $items_on_page = 10], [int $items_begin = 0], [array $property = array()] );

    Описание

    Отображение RSS ленты

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $items_on_page

    количество выводимых записей в ленте

    $items_begin

    параметр, определяющий с какой записи начинать вывод

    $property

    массив дополнительных параметров

    • $property['title'] string Заголовок канала
    • $property['description'] string Краткое описание RSS-канала
    • $property['link'] string Ссылка на сайт
    • $property['image'] Картинка для представления канала (необязательный элемент)
    • $property['image']['url'] string Ссылка на файл изображения
    • $property['image']['title'] string Заменяющий текст для изображения
    • $property['image']['link'] string Ссылка для перехода при щелчке по изображению
    • $property['yandex:full-text'] bool Вывод полного текста для Яндекс, по умолчанию false
    • $property['strip-tags'] bool Указывает на необходимость удаления тегов из содержания RSS, по умолчанию false
    • $property['show-image'] bool Разрешает передачу картинки для информационного элемента в теге enclosure

    [ Наверх ]


    Forums::ShowMessage

    ShowMessage( int $forums_conference_id, int $forums_id, int $forums_theme_id, string $xslname, [array $external_propertys = array()], [array $param = array()] );

    Описание

    Метод отображения сообщений форума

    Принимаемые параметры

    $forums_conference_id

    идентификатор конференции

    $forums_id

    идентификатор форума

    $forums_theme_id

    идентификатор темы

    $xslname

    наименование XSL-шаблона

    $external_propertys

    массив внешних параметров, передающихся в XML

    $param

    массив дополнительных параметров

    • $param['site_users_id'] - Идентификатор пользователя сайта, если не переда -- определяется автоматически
    • $param['current_page_theme'] - Номер текущей страницы тем
    • $param['current_page_message'] - Номер текущей страницы сообщений
    • $param['items_on_page'] - Число сообщений на страницу, если не передан, то определяется автоматически
    • $param['message_theme'] - Тема сообщения
    • $param['message_text'] - Текст сообщения
      1.  <?php
      2.  $Forums = new Forums();
      3.  
      4.  $forums_conference_id = 1;
      5.  $forums_id = 1;
      6.  $forums_theme_id = 4;
      7.  $xslname 'СообщенияТемы';
      8.  
      9.  $Forums->ShowMessage($forums_conference_id$forums_id$forums_theme_id$xslname);
      10.  ?>

    [ Наверх ]


    Forums::ShowSiteUserInfo

    ShowSiteUserInfo( int $conference_id, int $forums_id, int $theme_id, string $xslname, [array $external_propertys = array()], [array $param = array()] );

    Описание

    Отображение данных о пользователе форума

    Принимаемые параметры

    $conference_id

    идентификатор конференции

    $forums_id

    идентификатор форума

    $theme_id

    идентификатор темы

    $xslname

    имя xsl шаблона

    $external_propertys

    массив внешних данных, передаваемых в XML
    $external_propertys['current_page_message'] - идентификатор текущего сообщения
    $external_propertys['error'] - сообщение об ошибке

    $param

    массив дополнительных параметров $param['site_users_id'] - идентификатор пользователя сайта, если не передан - определяется автоматически

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $conference_id = 1;
    5.  $forums_id = 1;
    6.  $theme_id = 1;
    7.  $xslname 'АнкетныеДанные';
    8.  
    9.  $result $Forums->ShowSiteUserInfo($conference_id$forums_id$theme_id$xslname);
    10.  
    11.  // Распечатаем результат
    12.  echo $result;
    13.  ?>

    [ Наверх ]


    Forums::ShowThemes

    ShowThemes( int $conference_id, int $forums_id, string $xslname, [array $external_propertys = array()], [array $param = array()] );

    Описание

    Метод отображения тем форума

    Принимаемые параметры

    $conference_id

    идентификатор конференции

    $forums_id

    идентификатор форума

    $xslname

    имя XSL-шаблона для отображения тем форума

    $external_propertys

    массив внешних параметров, передающихся в XML

    $param

    массив дополнительных параметров

    • $param['site_users_id'] - идентификатор пользоватлея сайта, если не передан - определяется автоматически
    • $param['current_page_theme'] - номер текущей страницы, по умолчанию 0
    • $param['items_on_page'] - число тем на страницу, по умолчанию 10
      1.  <?php
      2.  $Forums = new Forums();
      3.  
      4.  $conference_id = 1;
      5.  $forums_id = 1;
      6.  $xslname 'ТемыФорума';
      7.  
      8.  $Forums->ShowThemes($conference_id$forums_id$xslname);
      9.  ?>

    see

    Forums::SelectFormThemes()

    [ Наверх ]


    Forums::ShowUserMessages

    ShowUserMessages( array $param, [array $external_propertys = array()] );

    Описание

    Показ сообщений пользователя

    Принимаемые параметры

    $param

    массив параметров

    • $param['site_users_id'] идентификатор пользователя сайтов
    • $param['forums_conference_id'] идентификатор конференции
    • $param['xsl_name'] имя XSL-шаблона отображения списка сообщений
    • $param['messages_on_page'] количество сообщений, отображаемых на странице
    • $param['messages_begin'] номер сообщения, с которого начинать отображение (по умолчанию равен 0)

    $external_propertys

    массив дополнительных свойств для включения в XML

    [ Наверх ]


    Forums::Smile2HTML

    Smile2HTML( string $text );

    Описание

    Метод замены смайликов на HTML

    Принимаемые параметры

    $text

    исходный текст

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $text ':-)';
    5.  
    6.  $result $Forums->Smile2HTML($text);
    7.  
    8.  // Распечатаем результат
    9.  echo $result;
    10.  ?>

    Возвращает

    текст после замены

    [ Наверх ]


    Forums::TypographText

    TypographText( str $text );

    Описание

    Типографирование текста с использованием модуля "Типограф"

    Принимаемые параметры

    $text

    текст

    Возвращает

    текст

    [ Наверх ]


    Forums::UserIsModerator

    UserIsModerator( int $forums_id, int $site_users_id );

    Описание

    Метод для определения, является ли данный пользователь модератором

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $site_users_id

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

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_id = 1;
    5.  
    6.  // Если есть модуль "Пользователи сайта", получим текущего пользователя
    7.  if (class_exists('SiteUsers'))
    8.  {
    9.      $SiteUsers singleton('SiteUsers');
    10.     $site_users_id $SiteUsers->GetCurrentSiteUser();
    11.  }
    12.  else
    13.  {
    14.      $site_users_id = 0;
    15.  }
    16.  
    17.  $result $Forums->UserIsModerator($forums_id$site_users_id);
    18.  
    19.  if ($result)
    20.  {
    21.      echo "Пользователь является модератором";
    22.  }
    23.  else
    24.  {
    25.      echo "Пользователь не является модератором";
    26.  }
    27.  ?>

    [ Наверх ]


    Forums::VisibleTheme

    VisibleTheme( int $forums_id, int $forums_theme_id, [int $site_users_id = false] );

    Описание

    Метод, устанавливающий видимость/невидимость темы

    Принимаемые параметры

    $forums_id

    идентификатор форума

    $forums_theme_id

    идентификатор темы

    $site_users_id

    идентификатор пользователя сайта, необзяталеьный параметр. по умолчанию равен false - определять автоматически.

    1.  <?php
    2.  $Forums = new Forums();
    3.  
    4.  $forums_id = 1;
    5.  $forums_theme_id = 1;
    6.  
    7.  $result $Forums->VisibleTheme($forums_id$forums_theme_id);
    8.  
    9.  //Распечатаем результат
    10.  echo $result;
    11.  ?>

    [ Наверх ]



Описания переменных

  • $CacheGetConference = array() [Строка 30]
  • Data type: array
  • Описание

    Кэш для метода GetConference()


  • $CacheGetThemeLastMessage = array() [Строка 37]
  • Data type: array
  • Описание

    Кэш для метода GetThemeLastMessage()


  • $iThemeId =  0 [Строка 44]
  • Data type: int
  • Описание

    Идентификатор вставленной темы


  • $iTmpId =  0 [Строка 60]
  • Data type: mixed


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