Размещен: /Maillist/Maillist.class.php
Описание
Класс модуля "Почтовые рассылки"
string ApplyMailTemplate()
boolean CopyFascicle()
mixed CopyMaillist()
mixed CopyMaillistUsers()
mixed CopyMaillistUsersGroup()
boolean DeleteFascicleFiles()
resource DeleteUsers()
resource DeleteUsersFascicle()
boolean DeleteUsersGroupFromMaillist()
результат DelFascicle()
результат DelMaillist()
mixed GetAllFascicle()
resource GetAllFascicleFiles()
mixed GetAllMaillistsForSite()
mixed GetAllMaillistUsers()
mixed GetAllMaillistUsersGroup()
array GetFascicle()
array GetFascicleFiles()
array GetMaillist()
выводит GetMaillistXML()
string GetXML4Maillist()
str HtmlToText()
mixed InsertFascicle()
int InsertFascicleFiles()
результат InsertMaillist()
boolean InsertUsers()
boolean InsertUsersGroup()
boolean RenewMaillist()
void ReplaceMacro()
resource SelectFascicle()
resource SelectMaillist()
mixed SelectUser()
mixed SendFascicle()
void ShowMaillist()
ApplyMailTemplate( string $source_string, array $site_user_row );
Описание
Метод осуществляющий шаблонную подстановку в текст письма информации о пользоваетеле сайта
Принимаемые параметры
$source_string
исходная строка
$site_user_row
информация о пользователе сайта
Возвращает
результат
[ Наверх ]
CopyFascicle( int $fascicle_id, [array $param = array ()] );
Описание
Метод копирования выпуска рассылки
Принимаемые параметры
$fascicle_id
идентификатор выпуска рассылки
$param
Массив дополнительных параметров
<?php $Maillist = new Maillist(); $fascicle_id = 1; $result = $Maillist->CopyFascicle($fascicle_id); if ($result) { echo "Копирование выполнено успешно"; } else { echo "Ошибка копирования"; } ?>
Возвращает
результат выполнения запроса на добавление
[ Наверх ]
CopyMaillist( int $maillist_id, [int $new_site_id = false] );
Описание
Копирование почтовой рассылки
Принимаемые параметры
$maillist_id
Идентификатор копируемой рассылки
$new_site_id
Идентификатор сайта, на который следует переместить скопированную почтовую рассылку
Возвращает
Идентификатор скопированной рассылки, или false
[ Наверх ]
CopyMaillistUsers( int $maillist_users_id, [array $param = array ()] );
Описание
Копирование связи пользователя с почтовой рассылкой
Принимаемые параметры
$maillist_users_id
Идентификатор связи пользователя с почтовой рассылкой
$param
Массив дополнительных параметров
Возвращает
Идентификатор скопированной связи, или false
[ Наверх ]
CopyMaillistUsersGroup( int $maillist_users_group_id, [array $param = array ()] );
Описание
Копирование связи почтовой рассылки с группой пользователей
Принимаемые параметры
$maillist_users_group_id
Идентификатор связи группы пользователей с почтовой рассылкой
$param
Массив дополнительных параметров
Возвращает
Идентификатор скопированной связи, или false
[ Наверх ]
DeleteFascicleFiles( int $maillist_fascicle_files_id );
Описание
Метод, осуществляющий удаление файла выпуска рассылки
Принимаемые параметры
$maillist_fascicle_files_id
идентификатор файла выпуска рассылки
Возвращает
логическое значение, TRUE в случае успешного удаления и FALSE в случае ошибки
[ Наверх ]
DeleteUsers( int $user_id, int $maillist_id );
Описание
Метод снятия подписки с подписчика по его идентификатору пользователя сайта (УСТАРЕВШИЙ МЕТОД!)
Принимаемые параметры
$user_id
идентификатор пользователя сайта
$maillist_id
идентификатор
[ Наверх ]
DeleteUsersFascicle( int $user_id, int $maillist_id );
Описание
Метод снятия подписки с подписчика по его идентификатору подписчика
Принимаемые параметры
$user_id
идентификатор подписчика
$maillist_id
идентификатор
<?php $Maillist = new Maillist(); $maillist_id = 1; $result = $Maillist->DeleteUsersFascicle($user_id, $maillist_id); if ($result) { echo "Подписка пользователя удалена"; } else { echo "Ошибка удаления подписки пользователя на рассылку"; } ?>
[ Наверх ]
DeleteUsersGroupFromMaillist( integer $maillist_users_group_id );
Описание
Метод закрывающий доступ к рассылке определенной группе пользователей
Принимаемые параметры
$maillist_users_group_id
идентификатор группы пользователей
<?php $Maillist = new Maillist(); $maillist_users_group_id = 7; $result = $Maillist->DeleteUsersGroupFromMaillist($maillist_users_group_id); if ($result) { echo "Доступ закрыт"; } else { echo "Ошибка выполнения запроса"; } ?>
Возвращает
результат выполнения запросов на удаление
[ Наверх ]
DelFascicle( int $maillist_fascicle_id );
Описание
Удаление выпуска рассылки
Принимаемые параметры
$maillist_fascicle_id
идентификатор выпуска рассылки
<?php $Maillist = new Maillist(); $maillist_fascicle_id = 2; $result = $Maillist->DelFascicle($maillist_fascicle_id); if ($result) { echo "Удаление выполнено успешно"; } else { echo "Ошибка удаления"; } ?>
Возвращает
выполнения запроса на удаление
[ Наверх ]
DelMaillist( int $maillist_id );
Описание
Удаление рассылки
Принимаемые параметры
$maillist_id
идентификатор рассылки
<?php $Maillist = new Maillist(); $maillist_id = 3; $result = $Maillist->DelMaillist($maillist_id); if ($result) { echo "Удалене выполнено успешно"; } else { echo "Ошибка удаления"; } ?>
Возвращает
выполнения запросов на удаление
[ Наверх ]
GetAllFascicle( int $maillist_id );
Описание
Получение списка всех выпусков рассылки
Принимаемые параметры
$maillist_id
Идентификатор почтовой рассылки
Возвращает
resource в случае успешного выполнения, или false
[ Наверх ]
GetAllFascicleFiles( int $maillist_fascicle_id );
Описание
Метод, осуществляющий вставку информацию о файле для выпуса почтовой рассылки
Принимаемые параметры
$maillist_fascicle_id
идентификатор выпуска почтовой рассылки
Возвращает
ответ базы
[ Наверх ]
GetAllMaillistsForSite( int $site_id );
Описание
Получение списка почтовых рассылок заданного сайта
Принимаемые параметры
$site_id
идентификатор сайта
Возвращает
resource или False
[ Наверх ]
GetAllMaillistUsers( int $maillist_id );
Описание
Получение списка связей пользователей с рассылкой
Принимаемые параметры
$maillist_id
Идентификатор почтовой рассылки
Возвращает
resource в случае успешного выполнения, или false
[ Наверх ]
GetAllMaillistUsersGroup( int $maillist_id );
Описание
Получение списка групп пользователей, подписанных на рассылку
Принимаемые параметры
$maillist_id
Идентификатор почтовой рассылки
Возвращает
resource в случае успешного выполнения, или false
[ Наверх ]
GetFascicle( int $maillist_fascicle_id );
Описание
Метод возвращает информацию о почтовой рассылке
Принимаемые параметры
$maillist_fascicle_id
идентификатор рассылки
<?php $Maillist = new Maillist(); $maillist_fascicle_id = 1; $row = $Maillist->GetFascicle($maillist_fascicle_id); // Распечатаем результат print_r ($row); ?>
Возвращает
с информацией о рассылке или false
[ Наверх ]
GetFascicleFiles( int $maillist_fascicle_files_id );
Описание
Метод возвращает информацию о файле выпуска почтовой рассылки
Принимаемые параметры
$maillist_fascicle_files_id
идентификатор файла почтовой рассылки
Возвращает
с информацией о файле или false
[ Наверх ]
GetMaillist( int $maillist_id );
Описание
Метод возвращает ассоциативный массив с информацией о списке рассылок
Принимаемые параметры
$maillist_id
идентификатор списка рассылок
<?php $Maillist = new Maillist(); $maillist_id = 1; $row = $Maillist->GetMaillist($maillist_id); // Распечатаем результат print_r ($row); ?>
Возвращает
с результатом выборки или false
[ Наверх ]
GetMaillistXML( int $site_user_id, string $xslname, [array $param = array ()], [array $external_propertys = array ()] );
Описание
Устаревший метод генерирующий XML для состояния подписки конкретного пользователя сайта
Принимаемые параметры
$site_user_id
идентификатор пользователя сайта
$xslname
имя XSL шаблона
$param
массив дополнительных параметров
$external_propertys
внешние параметры, передаваемы в XML
Возвращает
на экран HTML код
[ Наверх ]
GetXML4Maillist( int $site_user_id, [int $external_propertys = array ()], [array $param = array ()] );
Описание
Генерация XML для почтовой рассылки
Принимаемые параметры
$site_user_id
идентификатор пользователя сайта
$external_propertys
массив дополнительных параметров
$param
массив дополнительных параметров
<?php $Maillist = new Maillist(); // Если есть модуль "Пользователи сайта", получим текущего пользователя if (class_exists('SiteUsers')) { $SiteUsers = & singleton('SiteUsers'); $site_users_id = $SiteUsers->GetCurrentSiteUser(); } else { $site_users_id = 0; } $xml = $Maillist->GetXML4Maillist($site_users_id); echo htmlspecialchars($xml); ?>
[ Наверх ]
HtmlToText( str $str_html );
Описание
Преобразование html в текст
Принимаемые параметры
$str_html
html текст
Возвращает
строка в текстовом формате
[ Наверх ]
InsertFascicle( int $maillist_id, int $maillist_fascicle_id, int $maillist_htmltotext, string $maillist_fascicle_theme, string $maillist_fascicle_text, string $maillist_fascicle_html, int $maillist_fascicle_edited, [int $users_id = false] );
Описание
Добавление/редактирование выпуска рассылки
Принимаемые параметры
$maillist_id
идентификатор рассылки
$maillist_fascicle_id
идентификатор выпуска рассылки, если вставка, то 0
$maillist_htmltotext
строить ли текстовую версию на основе HTML
$maillist_fascicle_theme
тема выпуска
$maillist_fascicle_text
текстовая версия выпуска
$maillist_fascicle_html
HTML версия выпуска
$maillist_fascicle_edited
рассылка отредактирована
$users_id
идентификатор пользователя, если false - берется текущий пользователь.
<?php $Maillist = new Maillist(); $maillist_id = 2; $maillist_fascicle_id = 1; $maillist_htmltotext = 0; $maillist_fascicle_theme = 'Тема рассылки'; $maillist_fascicle_text = 'HTML-текст рассылки'; $maillist_fascicle_html = 'Текстовая версия рассылки'; $maillist_fascicle_html = 'Текстовая версия рассылки'; $maillist_fascicle_edited = 0; $newid = $Maillist->InsertFascicle($maillist_id, $maillist_fascicle_id, $maillist_htmltotext, $maillist_fascicle_theme, $maillist_fascicle_text, $maillist_fascicle_html, $maillist_fascicle_edited); // Распечатаем результат if ($newid) { echo 'Выпуск рассылки изменен'; } else { echo 'Ошибка! Выпуск рассылки не изменен!'; } ?>
Возвращает
результат выполнение запроса:
int идентификатор добавленного выпуска;
boolean результат выполнения запроса на обновление
[ Наверх ]
InsertFascicleFiles( array $param );
Описание
Метод, осуществляющий вставку информацию о файле для выпуса почтовой рассылки
Принимаемые параметры
$param
ассоциативный массив параметров
Возвращает
идентификатор вставленного товара в заказ
[ Наверх ]
InsertMaillist( $param $param );
Описание
Добавление/редактирование информации о рассылке
Принимаемые параметры
$param
массив парметров
<?php $Maillist = new Maillist(); $param['maillist_name'] = 'Новая рассылка'; $param['maillist_description'] = 'Описание рассылки'; $param['$maillist_sender_email'] = 'admin@site.ru'; $param['maillist_order'] = 10; $result = $Maillist->InsertMaillist($param); if ($result) { echo "Рассылка создана"; } else { echo "Ошибка создания рассылки"; } ?>
Возвращает
выполнения запроса
[ Наверх ]
InsertUsers( int $maillist_id, int $site_user_id, int $value );
Описание
Метод добавления/редактирования информации о подписчике
Принимаемые параметры
$maillist_id
идентификатор рассылки
$site_user_id
идентификатор пользователя сайта
$value
тип подписки (0 - текст, 1 - HTML)
<?php $Maillist = new Maillist(); $maillist_id = 1; $site_user_id = ''; $value = 0; // Если есть модуль "Пользователи сайта", получим текущего пользователя if (class_exists('SiteUsers')) { $SiteUsers = & singleton('SiteUsers'); $site_users_id = $SiteUsers->GetCurrentSiteUser(); } else { $site_users_id = 0; } $result = $Maillist->InsertUsers($maillist_id, $site_user_id, $value); if ($result) { echo "Запрос выполнен успешно"; } else { echo "Ошибка выполнения запроса"; } ?>
Возвращает
результат выполнения запроса на добавление/редактирование
[ Наверх ]
InsertUsersGroup( int $maillist_id, int $site_users_group_id );
Описание
Метод, открывающий доступ группе пользователей сайта к рассылке
Принимаемые параметры
$maillist_id
идентификатор рассылки
$site_users_group_id
идентификатор группы пользователей
<?php $Maillist = new Maillist(); $maillist_id = 1; $site_users_group_id = 7; $result = $Maillist->InsertUsersGroup($maillist_id, $site_users_group_id); if ($result) { echo "Доступ открыт"; } else { echo "Ошибка выполнения запроса"; } ?>
Возвращает
результат выполнения запроса на вставку
[ Наверх ]
RenewMaillist( int $site_users_id, array $array );
Описание
Метод обновления информации о подписке для конкретного подписчика
Принимаемые параметры
$site_users_id
идентификатор пользователя сайта
$array
массив значений состояния подписки:
$array['value'.$maillist_id] int тип подписки (0 - текст, 1 - HTML)
Возвращает
результат обновления состояния подписки
[ Наверх ]
ReplaceMacro( str $template_text, [array $param = array()] );
Описание
Производит замену макроподстановки %TEXT в $template_text на переданный текст в $param['text']
Принимаемые параметры
$template_text
шаблон
$param
массив замен
[ Наверх ]
SelectFascicle( int $maillist_fascicle_id );
Описание
Получение данных о выпуске рассылки
Принимаемые параметры
$maillist_fascicle_id
идентификатор выпуска рассылки
<?php $Maillist = new Maillist(); $maillist_fascicle_id = 1; $resource = $Maillist->SelectFascicle($maillist_fascicle_id); // Распечатаем результат while($row = mysql_fetch_assoc($resource)) { print_r($row); } ?>
Возвращает
результат выполнения запроса на выборку
[ Наверх ]
SelectMaillist( int $maillist_id, [array $param = array()] );
Описание
Получение данных о рассылке
Принимаемые параметры
$maillist_id
идентификатор рассылки (-1 или false - выбрать все рассылки)
$param
массив дополнительных параметров
<?php $Maillist = new Maillist(); $maillist_id = 1; $resource = $Maillist->SelectMaillist($maillist_id); // Распечатаем результат $row = mysql_fetch_assoc($resource); print_r($row); ?>
Возвращает
результат выполнения запроса на выборку
[ Наверх ]
SelectUser( int $site_users_id, int $maillist_id );
Описание
Получение информации о состоянии подписки подписчика на рассылку
Принимаемые параметры
$site_users_id
идентификатор пользователя сайта
$maillist_id
идентификатор рассылки
<?php $Maillist = new Maillist(); $maillist_id = 1; // Если есть модуль "Пользователи сайта", получим текущего пользователя if (class_exists('SiteUsers')) { $SiteUsers = & singleton('SiteUsers'); $site_users_id = $SiteUsers->GetCurrentSiteUser(); } else { $site_users_id = 0; } $row = $Maillist->SelectUser($site_users_id, $maillist_id); // Распечатаем результат print_r ($row); ?>
Возвращает
результат запроса на выборку:
array массив данных о состоянии подписки $result[0] Ф.И.О подписчика $result[1] тип подписки (0 - текст, 1 - HTML) $result[2] логин пользователя boolean false если информация не найдена
[ Наверх ]
SendFascicle( int $fascicle_id, [array $param = array ()] );
Описание
Метод отправки выпуска всем подписчикам рассылки
Принимаемые параметры
$fascicle_id
идентификатор выпуска рассылки
$param
массив с доп. параметрами
<?php $Maillist = new Maillist(); $fascicle_id = 1; $row = $Maillist->SendFascicle($fascicle_id); // Распечатаем результат print_r ($row); ?>
Возвращает
результат отправки писем
array результат успешной отправки: $result[0] количество подписчиков;
$result[1] количество успешных отправок boolean false результат неудачной отправки
[ Наверх ]
ShowMaillist( string $xslname, [int $site_user_id = false], [array $external_propertys = array ()], [array $param = array ()] );
Описание
Метод отображения списка почтовых расслок пользователя
Принимаемые параметры
$xslname
имя XSL-шаблона
$site_user_id
идентификатор пользователя сайта, по умолчанию false - определяется вручную
$external_propertys
внешние параметры, передаваемы в XML
$param
- $param['site_id'] идентификатор сайта, для которого выбираюттся рассылки. Если не указан - выбираются с текущего сайта.
[ Наверх ]