Размещен: /Forums/Forums.class.php
Описание
Класс модуля "Форумы"
$CacheGetConference
= array()
$CacheGetThemeLastMessage
= array()
$iThemeId
= 0
$iTmpId
= 0
Forums Forums()
void AddBbCode()
int:
AddEditTheme()
void ApplyTextFunctionWithoutCodeSection()
string BBcode2HTML()
void CheckUsersAccessToForum()
boolean CloseForum()
boolean CloseTheme()
mixed CopyForum()
mixed CopyForumsConference()
mixed CopyForumsGroup()
boolean DeleteConference()
boolean DeleteForum()
boolean DeleteThemeUserSubscribe()
boolean DelForumsGroup()
boolean DelMessage()
boolean DelTheme()
boolean GenAddEditThemeXML()
boolean GenEditMessageXML()
boolean GenMessageXML()
string GenSmilesXML()
boolean GenUserInfoXML()
string GenXml4InsertEditLetters()
string GenXML4Message()
string GenXml4Theme()
resource GetAllConferences()
resource GetAllForums()
resource GetAllForumsGroup()
array GetAllMessages()
array GetConference()
mixed GetConferencePath()
int GetCountMessageTheme()
mixed GetForum()
array GetForumAccess()
array GetForumAndItemIdFromPath()
mixed GetForumsGroup()
mixed GetForumsUsersGroupList()
mixed GetForumView()
int GetLastPageTheme()
array GetMessage()
mixed GetTheme()
int GetThemeId()
mixed GetThemeLastMessage()
mixed GetThemeView()
void GetTmpId()
boolean IncCountMessage()
array IndexationForums()
array IndexationForumsMessages()
mixed InsertConference()
boolean InsertEditMessage()
int InsertForum()
int InsertForumsGroup()
boolean InsertForumView()
mixed InsertTheme()
boolean InsertThemeUserSubscribe()
boolean InsertUsersGroup()
boolean IssetForumAccess()
boolean IssetThemeUserSubscribe()
boolean MessageIsTheme()
boolean NoticeTheme()
boolean OrderForums()
boolean OrderForumsGroup()
array SearchIndexing()
resource SelectFormThemes()
mixed:
SelectForumsGroup()
mixed:
SelectMessage()
resource SelectThemeSubscribers()
resource SelectUserSubscriptions()
boolean SetModerator()
void SetThemeId()
boolean ShowAddEditTheme()
boolean ShowConference()
boolean ShowEditMessage()
void ShowForumRss()
boolean ShowMessage()
boolean ShowSiteUserInfo()
void ShowThemes()
void ShowUserMessages()
string Smile2HTML()
оттипографированный TypographText()
bool UserIsModerator()
boolean VisibleTheme()
Forums( );
[ Наверх ]
AddBbCode( mixed $BBpattern, mixed $BBreplace );
Описание
Добавление правила BB-кодов
Принимаемые параметры
$BBpattern
регулярное выражение шаблона
$BBreplace
регулярное выражение замены
[ Наверх ]
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
массив дополнительных параметров:
<?php $Forums = new Forums(); $conference_id = 1; $forums_id = 1; $theme_id = 0; $theme_title = 'Новая тема'; $theme_close = 1; $theme_notice = 0; $theme_visible = 1; $first_message = 'Текст первого сообщения'; $current_time = date('Y-m-d H:i:s'); // Если есть модуль "Пользователи сайта", получим текущего пользователя if (class_exists('SiteUsers')) { $SiteUsers = & singleton('SiteUsers'); $site_users_id = $SiteUsers->GetCurrentSiteUser(); } else { $site_users_id = 0; } $newid = $Forums->AddEditTheme($conference_id, $forums_id, $theme_id, $theme_title, $theme_close, $theme_notice, $theme_visible, $first_message, $site_users_id, $current_time); // Распечатаем результат echo $newid; ?>
$conference_id
Возвращает
-2 -- сработала защита от флуда,
-1 -- неверное значение CAPTCHA,
[ Наверх ]
ApplyTextFunctionWithoutCodeSection( str $text, str $function_name );
Описание
Применение функции к фрагментам текста, содержащихся во вне блоков [code]...[/code]
Принимаемые параметры
$text
текст
$function_name
имя метода класса
[ Наверх ]
BBcode2HTML( string $text, [bool $use_typograph = true] );
Описание
Замена BBcode на HTML.
С версии 5.1.7 осуществляет типографирование текста, если модуль "Типограф" активен. Запрет на типографирование передается параметром или объявлением константы DENY_FORUM_TYPOGRAPH со значенем true
Принимаемые параметры
$text
исходный текст
$use_typograph
указывает на необходимость типографирования текста. Необязательный параметр, по умолчанию true
Возвращает
текст после замены
[ Наверх ]
CheckUsersAccessToForum( $param );
Принимаемые параметры
$param
[ Наверх ]
CloseForum( int $forums_id );
Описание
Метод, закрывающий/открывающий форум
Принимаемые параметры
$forums_id
идентификатор форума
<?php $Forums = new Forums(); $forums_id = 1; $result = $Forums->CloseForum($forums_id); //Распечатаем результат echo $result; ?>
[ Наверх ]
CloseTheme( int $forums_id, int $forums_theme_id, [int $site_users_id = false] );
Описание
Открытие/закрытие темы для доступа
Принимаемые параметры
$forums_id
идентификатор форума
$forums_theme_id
идентификатор темы
$site_users_id
идентификатор пользователя сайта
<?php $Forums = new Forums(); $forums_id = 1; $forums_theme_id = 1; $result = $Forums->CloseTheme($forums_id, $forums_theme_id); //Распечатаем результат echo $result; ?>
[ Наверх ]
CopyForum( int $forums_id, [int $forums_group_id = false] );
Описание
Копирование информации о форуме
Принимаемые параметры
$forums_id
идентификатор форума
$forums_group_id
идентификатор группы форумов, куда следует скопировать данный форум, если не передан, используется текущая группа
Возвращает
Идентификатор скопированной записи, или False
[ Наверх ]
CopyForumsConference( int $forums_conference_id, [int $site_id = false], [int $structure_id = false] );
Описание
Копирование конференции, групп форумов, а так же форумов, входящих в данную конференцию
Принимаемые параметры
$forums_conference_id
идентификатор конференции
$site_id
идентификатор сайта на который следует поместить копию конференции, если не передан, используется текущий
$structure_id
идентификатор структуры, с которой следует связать копию конференции, если не передан, используется текущая
Возвращает
идентификатор скопированной записи, либо False
[ Наверх ]
CopyForumsGroup( int $forums_group_id, [int $forums_conference_id = false] );
Описание
Копирование информации о группе форумов
Принимаемые параметры
$forums_group_id
идентификатор группы форумов
$forums_conference_id
идентификатор конференции, в которую следует перенести скопированную группу форумов
Возвращает
идентфикатор скопированной записи, либо False
[ Наверх ]
DeleteConference( int $forums_conference_id );
Описание
Метод удаления конференции вместе с принадлежащими ей группами форумов и т.п.
Принимаемые параметры
$forums_conference_id
идентификатор конференции
<?php $Forums = new Forums(); $forums_conference_id = 2; $result = $Forums->DeleteConference($forums_conference_id); if ($result) { echo "Удаление выполнено успешно"; } else { echo "Ошибка удаления"; } ?>
Возвращает
результат выполнения запроса
[ Наверх ]
DeleteForum( int $forums_id );
Описание
Метод удаления форума
Принимаемые параметры
$forums_id
идентификатор форума
<?php $Forums = new Forums(); $forums_id = 5; $result = $Forums->DeleteForum($forums_id); if ($result) { echo "Удаление выполнено успешно"; } else { echo "Ошибка удаления"; } ?>
[ Наверх ]
DeleteThemeUserSubscribe( array $param );
Описание
Удаление подписки пользователя сайта на тему форума
Принимаемые параметры
$param
массив параметров
[ Наверх ]
DelForumsGroup( int $forums_group_id );
Описание
Метод удаления группы форумов
Принимаемые параметры
$forums_group_id
идентификатор группы форумов
<?php $Forums = new Forums(); $forums_group_id = 3; $result = $Forums->DelForumsGroup($forums_group_id); if ($result) { echo "Удаление выполнено успешно"; } else { echo "Ошибка удаления"; } ?>
Возвращает
результат выполнения запроса
[ Наверх ]
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
<?php $Forums = new Forums(); $forums_id = 1; $forums_theme_id = 4; $forums_message_id = 7; // Если есть модуль "Пользователи сайта", получим текущего пользователя if (class_exists('SiteUsers')) { $SiteUsers = & singleton('SiteUsers'); $site_users_id = $SiteUsers->GetCurrentSiteUser(); } else { $site_users_id = 0; } $result = $Forums->DelMessage($forums_id, $forums_theme_id, $forums_message_id, $site_users_id); if ($result) { echo "Удаление выполнено успешно"; } else { echo "Ошибка удаления"; } ?>
[ Наверх ]
DelTheme( $conference_id, int $forums_id, int $forums_theme_id, [int $site_users_id = false] );
Описание
Удаление темы форума
Принимаемые параметры
$forums_id
идентификатор форума
$forums_theme_id
идентификатор темы
$site_users_id
идентификатор пользователя сайта
$conference_id
[ Наверх ]
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
[ Наверх ]
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
[ Наверх ]
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
массив дополнительных параметров
[ Наверх ]
GenSmilesXML( );
Описание
Метод возвращает XML для смайликов
<?php $Forums = new Forums(); $newxml = $Forums->GenSmilesXML(); // Распечатаем результат echo htmlspecialchars($newxml); ?>
Возвращает
XML
[ Наверх ]
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
[ Наверх ]
GenXml4InsertEditLetters( array $param, [array $external_propertys = array()] );
Описание
Генерация XML для письма о вставке/редактировании
Принимаемые параметры
$param
параметры
$external_propertys
массив дополнительных свойств для включения в XML
[ Наверх ]
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
[ Наверх ]
GenXml4Theme( int $forums_theme_id, [ $site_users_id = false], [ $row = false], [ $param = array()] );
Описание
Формирование XML для темы форума
Принимаемые параметры
$forums_theme_id
идентификатор темы форума
$site_users_id
$row
$param
Возвращает
XMl с данными о теме форума
[ Наверх ]
GetAllConferences( [int $site_id = false] );
Описание
Получение информации о всех конференциях сайт.
Принимаемые параметры
$site_id
- идентификатор сайта, если false, то метод вернёт информацию обо всех конференциях всех сайтов.
<?php $Forums = new Forums(); $site_id = CURRENT_SITE; $resource = $Forums->GetAllConferences($site_id); // Распечатаем результат while($row = mysql_fetch_assoc($resource)) { print_r($row); } ?>
Возвращает
Информация о конференциях.
[ Наверх ]
GetAllForums( [int $forums_group_id = false] );
Описание
Метод для получения всех форумов
Принимаемые параметры
$forums_group_id
идентификатор группы форумов, если false - получаем форумы всех групп
<?php $Forums = new Forums(); $forums_group_id = 1; $resource = $Forums->GetAllForums($forums_group_id); // Распечатаем результат while($row = mysql_fetch_assoc($resource)) { print_r($row); } ?>
Возвращает
результат выборки
[ Наверх ]
GetAllForumsGroup( [int $forums_conference_id = false] );
Описание
Метод для получения списка всех групп
Принимаемые параметры
$forums_conference_id
идентификатор конференции, если false - метод возвращает список всех конференций
<?php $Forums = new Forums(); $forums_conference_id = 1; $resource = $Forums->GetAllForumsGroup($forums_conference_id); // Распечатаем результат while($row = mysql_fetch_assoc($resource)) { print_r($row); } ?>
Возвращает
результат выборки
[ Наверх ]
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
массив дополнительных атрибутов
<?php $Forums = new Forums(); $row = $Forums->GetAllMessages(); // Распечатаем результат print_r ($row); ?>
Возвращает
с результатом выборки или false
[ Наверх ]
GetConference( int $forums_conference_id );
Описание
Метод для получения информации о конференции.
Принимаемые параметры
$forums_conference_id
идентификатор конференции.
<?php $Forums = new Forums(); $forums_conference_id = 1; $row = $Forums->GetConference($forums_conference_id); // Распечатаем результат print_r ($row); ?>
Возвращает
возвращает ассоциативный массив с информацией о конференции.
[ Наверх ]
GetConferencePath( int $forums_conference_id );
Описание
Получение пути к конференции по ее идентификатору
Принимаемые параметры
$forums_conference_id
идентификатор конференции
<?php $Forums = new Forums(); $forums_conference_id = 1; $path = $Forums->GetConferencePath($forums_conference_id); // Распечатаем результат echo $path; ?>
Возвращает
путь к конференции или false, если конференция не найдена
[ Наверх ]
GetCountMessageTheme( int $forums_theme_id );
Описание
Получение количества сообщений в теме
Принимаемые параметры
$forums_theme_id
идентификатор темы
<?php $Forums = new Forums(); $forums_theme_id = 1; $count = $Forums->GetCountMessageTheme($forums_theme_id); // Распечатаем результат echo $count; ?>
Возвращает
количество сообщений
[ Наверх ]
GetForum( int $forums_id );
Описание
Получение информации о форуме
Принимаемые параметры
$forums_id
идентификатор форума
Возвращает
массив с данными о форуме или ложь, если форум не найден
[ Наверх ]
GetForumAccess( int $forums_id );
Описание
Метод, возвращающий список групп пользователей имеющих права доступа к указанному форуму
Принимаемые параметры
$forums_id
идентификатор форума
<?php $Forums = new Forums(); $forums_id = 1; $row = $Forums->GetForumAccess($forums_id); // Распечатаем результат print_r ($row); ?>
Возвращает
массив идентификаторов групп пользователей сайта
[ Наверх ]
GetForumAndItemIdFromPath( int $forums_conference_id, [array $path_array = array()] );
Описание
Получение данных об идентификаторе форума и темы по переданному массиву с элементами пути
Принимаемые параметры
$forums_conference_id
идентификатор конференции
$path_array
массив с элементами пути, если не передан, используется $GLOBALS['URL_ARRAY']
<?php $Forums = new Forums(); $forums_conference_id = 1; $path_array = $GLOBALS['URL_ARRAY']; $row = $Forums->GetForumAndItemIdFromPath($forums_conference_id, $path_array); // Распечатаем результат print_r ($row); ?>
Возвращает
$result['forum'] - идентификатор форума или false
$result['theme'] - идентификатор темы или false
[ Наверх ]
GetForumsGroup( int $forums_group_id );
Описание
Метод возвращает информацию о группе форумов
Принимаемые параметры
$forums_group_id
<?php $Forums = new Forums(); $forums_group_id = 1; $row = $Forums->GetForumsGroup($forums_group_id); // Распечатаем результат print_r ($row); ?>
Возвращает
ассоциативный массив с ифнормацией о группе форумов или false, если группа с указанным идентификатором отсутствует
[ Наверх ]
GetForumsUsersGroupList( int $forums_users_group_list_id );
Описание
Получение данных о связи группы пользователей с форумом
Принимаемые параметры
$forums_users_group_list_id
Идентификатор связи
<?php $Forums = new Forums(); $forums_users_group_list_id = 1; $row = $Forums->GetForumsUsersGroupList($forums_users_group_list_id); // Распечатаем результат print_r ($row); ?>
Возвращает
массив данных, либо False
[ Наверх ]
GetForumView( $site_users_id $site_users_id, $forums_id $forums_id );
Описание
Получение информации о дате последнего просмотра форума пользователем
Принимаемые параметры
$site_users_id
идентификатор пользователя сайта
$forums_id
идентификатор форума
Возвращает
массив или false
[ Наверх ]
GetLastPageTheme( int $forums_theme_id );
Описание
Получение номера последней страницы темы
Принимаемые параметры
$forums_theme_id
идентификатор темы
<?php $Forums = new Forums(); $forums_theme_id = 1; $page = $Forums->GetLastPageTheme($forums_theme_id); // Распечатаем результат echo $page; ?>
Возвращает
номер последней страницы темы
[ Наверх ]
GetMessage( int $forums_message_id );
Описание
Получение информации о сообщении
Принимаемые параметры
$forums_message_id
идентификатор сообщения
<?php $Forums = new Forums(); $forums_message_id = 1; $row = $Forums->GetMessage($forums_message_id); // Распечатаем результат print_r ($row); ?>
Возвращает
возвращает ассоциативный массив с информацией о сообщении
[ Наверх ]
GetTheme( int $forums_theme_id );
Описание
Метод возвращает информацию о теме форума
Принимаемые параметры
$forums_theme_id
идентификатор темы
Возвращает
ассоциативный массив с данными или ложь, если тема не найдена
[ Наверх ]
GetThemeId( );
Описание
Получение идентификатора добавленнной темы форума
Возвращает
идентификатор добавленной темы форума
[ Наверх ]
GetThemeLastMessage( $forums_theme_id $forums_theme_id );
Описание
Получение последнего сообщения темы
Принимаемые параметры
$forums_theme_id
идентификатор темы
Возвращает
массив или false
[ Наверх ]
GetThemeView( $site_users_id $site_users_id, $forums_theme_id $forums_theme_id );
Описание
Получение информации о дате последнего просмотра темы форума пользователем
Принимаемые параметры
$site_users_id
идентификатор пользователя сайта
$forums_theme_id
идентификатор темы форума
Возвращает
массив или false
[ Наверх ]
GetTmpId( );
[ Наверх ]
IncCountMessage( int $site_users_id );
Описание
Метод наращивания счётчика количества сообщений для пользователя
Принимаемые параметры
$site_users_id
идентификатор пользователя сайта
<?php $Forums = new Forums(); // Если есть модуль "Пользователи сайта", получим текущего пользователя if (class_exists('SiteUsers')) { $SiteUsers = & singleton('SiteUsers'); $site_users_id = $SiteUsers->GetCurrentSiteUser(); } else { $site_users_id = 0; } $result = $Forums->IncCountMessage($site_users_id); // Распечатаем результат echo $result; ?>
[ Наверх ]
IndexationForums( int $limit, int $on_step, [array $parameters = array()] );
Описание
Метод индексации форумов
Принимаемые параметры
$limit
сколько записей проиндексировано
$on_step
сколько индексировать
$parameters
массив дополнительных параметров
<?php $Forums = new Forums(); $limit = 0; $on_step = 10; $row = $Forums->IndexationForums($limit, $on_step); // Распечатаем результат print_r ($row); ?>
Возвращает
массив данных для индексации:
$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 дата создания страницы
[ Наверх ]
IndexationForumsMessages( int $limit, int $on_step, [array $parameters = array()] );
Описание
Метод индексации сообщений тем форумов
Принимаемые параметры
$limit
сколько записей проиндексировано
$on_step
сколько индексировать
$parameters
массив дополнительных параметров
<?php $Forums = new Forums(); $limit = 0; $on_step = 10; $row = $Forums->IndexationForumsMessages($limit, $on_step); // Распечатаем результат print_r ($row); ?>
Возвращает
массив данных для индексации:
$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 дата создания страницы
[ Наверх ]
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'] время, в течение которого можно удалять свои сообщений
<?php $Forums = new Forums(); $param['forums_conference_name'] = 'Новая конференция'; $param['forums_conference_description'] = 'Описание конференции'; $param['structure_id'] = 36; $param['forums_conference_on_page_theme'] = 10; $param['forums_conference_on_page_message'] = 10; $param['forums_conference_flude_protection'] = 5; $param['forums_conference_edit_time'] = 60; $param['forums_conference_del_time'] = 60; $newid = $Forums->InsertConference($param); // Распечатаем результат echo $newid; ?>
Возвращает
идентификатор вставленной конференции ( false при неудачной вставке)
[ Наверх ]
InsertEditMessage( array $param, [array $external_propertys = array()] );
Описание
Добавление/редактирование сообщения
Принимаемые параметры
$param
- $param['forums_conference_id'] идентификатор конференции
$external_propertys
массив дополнительных свойств для включения в XML
<?php $Forums = new Forums(); $param['forums_conference_id'] = 1; $param['forums_id'] = 1; $param['forums_theme_id'] = 1; $param['forums_theme_title'] = 'Тема_1'; $param['forums_message_text'] = 'Текст Тема_1'; $param['xsl_name_add_user'] = 'ПисьмоДобавленияСообщенияПользователю'; $param['xsl_name_add_curator'] = 'ПисьмоОДобавленииСообщения'; $param['xsl_name_edit_user'] = 'ПисьмоРедактированияСообщенияПользователю'; $param['xsl_name_edit_curator'] = 'ПисьмоРедактированияСообщенияКуратору'; // Если есть модуль "Пользователи сайта", получим текущего пользователя if (class_exists('SiteUsers')) { $SiteUsers = & singleton('SiteUsers'); $site_users_id = $SiteUsers->GetCurrentSiteUser(); } else { $site_users_id = 0; } $param['site_users_id'] = $site_users_id; $result = $Forums->InsertEditMessage($param); // Распечатаем результат echo $result; ?>
[ Наверх ]
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 - берется текущий пользователь.
<?php $Forums = new Forums(); $param['forums_id'] = 0; $param['forums_group_id'] = 1; $param['forums_name'] = 'Новый форум'; $param['forums_description'] = 'Описание форума'; $param['forums_curator_email'] = 'admin@site.ru'; $param['forums_postmoderation'] = 0; $param['visible4all'] = 0; $param['forums_captcha_used'] = 0; $param['forums_allow_guest'] = 0; $newid = $Forums->InsertForum($param); // Распечатаем результат echo $newid; ?>
Возвращает
идентификатор вставленной/обновленной записи
[ Наверх ]
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 - берется текущий пользователь.
<?php $Forums = new Forums(); $forums_group_id = 0; $forums_group_name = 'Group1'; $forums_group_comment = 'Коментарий к группе форумов'; $forums_conference_id = 1; $newid = $Forums->InsertForumsGroup($forums_group_id, $forums_group_name, $forums_group_comment, $forums_conference_id); // Распечатаем результат echo $newid; ?>
Возвращает
идентификатор вставленной/обновленной записи
[ Наверх ]
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 - устанавливется текущее дата-время. Необязательное поле.
[ Наверх ]
InsertTheme( array $param );
Описание
Вставка/обновление информации о теме
Принимаемые параметры
$param
дополнительные праметры
<?php $Forums = new Forums(); $param['forums_id'] = 1; $param['forums_theme_visible'] = 1; $param['forums_theme_notice'] = 0; $param['forums_theme_close'] = 0; $newid = $Forums->InsertTheme($param); // Распечатаем результат echo $newid; ?>
Возвращает
результат вставки
[ Наверх ]
InsertThemeUserSubscribe( array $param );
Описание
Подписка пользователя сайта на тему форума
Принимаемые параметры
$param
массив параметров
[ Наверх ]
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
идентификатор пользователя центра администрирования, добавившего запись
<?php $Forums = new Forums(); $forums_id = 1; $site_users_group_id = 7; $moderator = 1; $result = $Forums->InsertUsersGroup($forums_id, $site_users_group_id, $moderator); if ($result) { echo "Доступ разрешен"; } else { echo "Ошибка получения доступа"; } ?>
[ Наверх ]
IssetForumAccess( $forums_id $forums_id, [$site_users_id $site_users_id = false], [$is_moderator $is_moderator = true] );
Описание
Определение доступа пользователя к форуму
Принимаемые параметры
$forums_id
идентификатор форума
$site_users_id
идентификатор пользователя сайта
$is_moderator
проверять на принадлежность пользователя группе модераторов
[ Наверх ]
IssetThemeUserSubscribe( array $param );
Описание
Проверка подписки пользователя сайта на тему форума
Принимаемые параметры
$param
массив параметров
[ Наверх ]
MessageIsTheme( int $forum_theme_id, int $forum_message_id );
Описание
Проверка сообщения на то, что является ли оно темой
Принимаемые параметры
$forum_theme_id
идентификатор темы
$forum_message_id
идентификатор сообщения
[ Наверх ]
NoticeTheme( int $forums_id, int $forums_theme_id, [int $site_users_id = false] );
Описание
Метод делающий тему объявлением или наоборот
Принимаемые параметры
$forums_id
идентификатор форума
$forums_theme_id
идентификатор темы
$site_users_id
<?php $Forums = new Forums(); $forums_id = 1; $forums_theme_id = 1; $result = $Forums->NoticeTheme($forums_id, $forums_theme_id); //Распечатаем результат echo $result; ?>
[ Наверх ]
OrderForums( int $forums_group_id, array $mas_orders );
Описание
Метод изменения порядка сортировки форумов в группе
Принимаемые параметры
$forums_group_id
идентификатор группы форумов
$mas_orders
массив коэффициентов вида $mas_orders['order<идентификатор форума>']
<?php $Forums = new Forums(); $forums_group_id = 1; $mas_orders['order1'] = 20; $mas_orders['order2'] = 10; $result = $Forums->OrderForums($forums_group_id, $mas_orders); // Распечатаем результат echo $result; ?>
[ Наверх ]
OrderForumsGroup( array $mas_orders );
Описание
Метод изменения порядка сортировки групп форумов
Принимаемые параметры
$mas_orders
массив коэффициентов вида $mas_orders['order<идентификатор группы форумов>']
<?php $Forums = new Forums(); $mas_orders['order1'] = 20; $mas_orders['order2'] = 10; $result = $Forums->OrderForumsGroup($mas_orders); // Распечатаем результат echo $result; ?>
[ Наверх ]
SearchIndexing( $limit $limit, $on_step $on_step );
Описание
Функция обратного вызова для поисковой индексации данных модуля
Принимаемые параметры
$limit
текущая позиция
$on_step
шаг
[ Наверх ]
SelectFormThemes( mixed $forums_id, int $item_begin, int $items_count, [array $param = array()] );
Описание
Получение результата запроса на выборку тем форума
Принимаемые параметры
$forums_id
идентификатор или массив идентификаторов форума
$item_begin
номер записи, с которой надо начать выборку
$items_count
число записей в выборке
$param
массив дополнительных параметров
<?php $Forums = new Forums(); $forums_id = 1; $item_begin = 0; $items_count = 5; $resource = $Forums->SelectFormThemes($forums_id, $item_begin, $items_count); // Распечатаем результат while($row = mysql_fetch_assoc($resource)) { print_r($row); } ?>
Возвращает
в случае успешного выполнения, false - в противном случае
[ Наверх ]
SelectForumsGroup( int $forums_group_id );
Описание
Устарвший метод, возвращающий информацию о группе форумов
Принимаемые параметры
$forums_group_id
идентификатор группы форумов (-1 выбрать все)
Возвращает
resource при успешном выполнении операции,
boolean false в противном случае
[ Наверх ]
SelectMessage( int $forums_message_id );
Описание
Метод возвращающий информацию о сообщении
Принимаемые параметры
$forums_message_id
идентификатор сообщения
<?php $Forums = new Forums(); $forums_message_id = 1; $resource = $Forums->SelectMessage($forums_message_id); // Распечатаем результат while($row = mysql_fetch_assoc($resource)) { print_r($row); } ?>
Возвращает
resource при успешном выполнении операции,
boolean false в противном случае
[ Наверх ]
SelectThemeSubscribers( int $theme_id );
Описание
Получение списка подписчиков на тему форума
Принимаемые параметры
$theme_id
идентификатор темы форума
[ Наверх ]
SelectUserSubscriptions( int $site_users_id );
Описание
Получение списка подписанных тем форума
Принимаемые параметры
$site_users_id
идентификатор пользователя сайта
[ Наверх ]
SetModerator( int $forums_users_group_list_id );
Описание
Метод установления/снятия прав модератора текущего форума для группы пользователей
Принимаемые параметры
$forums_users_group_list_id
идентификатор в таблице связи форумов и групп пользователей
<?php $Forums = new Forums(); $forums_users_group_list_id = 1; $result = $Forums->SetModerator($forums_users_group_list_id); if ($result) { echo "Права установлены"; } else { echo "Ошибка установки прав"; } ?>
[ Наверх ]
SetThemeId( int $theme_id );
Описание
Установка значения идентификатора добавленной темы форума
Принимаемые параметры
$theme_id
идентификатор добавленной темы форума
[ Наверх ]
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 индекс текущей страницы
<?php $Forums = new Forums(); $conference_id = 1; $forums_id = 1; $theme_id = 1; $xslname = 'СозданиеТемы'; $Forums->ShowAddEditTheme($conference_id, $forums_id, $theme_id, $xslname); ?>
$conference_id
$external_propertys
[ Наверх ]
ShowConference( int $conference_id, string $xslname, [array $external_propertys = array()], [array $param = array()] );
Описание
Метод отображения конференции
Принимаемые параметры
$conference_id
идентификатор конференции
$xslname
имя XSL-шаблона для отображения
$external_propertys
массив внешних параметров, передающихся в XML
$param
массив дополнительных параметров
<?php $Forums = new Forums(); $conference_id = 1; $xslname = 'Форумы'; $Forums->ShowConference($conference_id, $xslname); ?>
Возвращает
-1 -- Конференция с указанным кодом не найдена
[ Наверх ]
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 текст сообщения
<?php $Forums = new Forums(); $conference_id = 1; $forums_id = 1; $forums_theme_id = 5; $forums_message_id = 8; $xslname = 'РедактированиеСообщения'; $Forums->ShowEditMessage($conference_id, $forums_id, $forums_theme_id, $forums_message_id, $xslname); ?>
$conference_id
$external_propertys
[ Наверх ]
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
массив дополнительных параметров
[ Наверх ]
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
массив дополнительных параметров
<?php $Forums = new Forums(); $forums_conference_id = 1; $forums_id = 1; $forums_theme_id = 4; $xslname = 'СообщенияТемы'; $Forums->ShowMessage($forums_conference_id, $forums_id, $forums_theme_id, $xslname); ?>
[ Наверх ]
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'] - идентификатор пользователя сайта, если не передан - определяется автоматически
<?php $Forums = new Forums(); $conference_id = 1; $forums_id = 1; $theme_id = 1; $xslname = 'АнкетныеДанные'; $result = $Forums->ShowSiteUserInfo($conference_id, $forums_id, $theme_id, $xslname); // Распечатаем результат echo $result; ?>
[ Наверх ]
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
массив дополнительных параметров
<?php $Forums = new Forums(); $conference_id = 1; $forums_id = 1; $xslname = 'ТемыФорума'; $Forums->ShowThemes($conference_id, $forums_id, $xslname); ?>
see
[ Наверх ]
ShowUserMessages( array $param, [array $external_propertys = array()] );
Описание
Показ сообщений пользователя
Принимаемые параметры
$param
массив параметров
$external_propertys
массив дополнительных свойств для включения в XML
[ Наверх ]
Smile2HTML( string $text );
Описание
Метод замены смайликов на HTML
Принимаемые параметры
$text
исходный текст
<?php $Forums = new Forums(); $text = ':-)'; $result = $Forums->Smile2HTML($text); // Распечатаем результат echo $result; ?>
Возвращает
текст после замены
[ Наверх ]
TypographText( str $text );
Описание
Типографирование текста с использованием модуля "Типограф"
Принимаемые параметры
$text
текст
Возвращает
текст
[ Наверх ]
UserIsModerator( int $forums_id, int $site_users_id );
Описание
Метод для определения, является ли данный пользователь модератором
Принимаемые параметры
$forums_id
идентификатор форума
$site_users_id
идентификатор пользователя сайта
<?php $Forums = new Forums(); $forums_id = 1; // Если есть модуль "Пользователи сайта", получим текущего пользователя if (class_exists('SiteUsers')) { $SiteUsers = & singleton('SiteUsers'); $site_users_id = $SiteUsers->GetCurrentSiteUser(); } else { $site_users_id = 0; } $result = $Forums->UserIsModerator($forums_id, $site_users_id); if ($result) { echo "Пользователь является модератором"; } else { echo "Пользователь не является модератором"; } ?>
[ Наверх ]
VisibleTheme( int $forums_id, int $forums_theme_id, [int $site_users_id = false] );
Описание
Метод, устанавливающий видимость/невидимость темы
Принимаемые параметры
$forums_id
идентификатор форума
$forums_theme_id
идентификатор темы
$site_users_id
идентификатор пользователя сайта, необзяталеьный параметр. по умолчанию равен false - определять автоматически.
<?php $Forums = new Forums(); $forums_id = 1; $forums_theme_id = 1; $result = $Forums->VisibleTheme($forums_id, $forums_theme_id); //Распечатаем результат echo $result; ?>
[ Наверх ]
array()
[Строка 30]array
Описание
Кэш для метода GetConference()
array()
[Строка 37]array
Описание
Кэш для метода GetThemeLastMessage()
0
[Строка 44]int
Описание
Идентификатор вставленной темы
0
[Строка 60]mixed