Class SiteUsers

[Строка 31]

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

Описание

Класс модуля "Пользователи сайта"

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

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

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

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

Методы

void AdminMainPage()
Функция обратного вызова для отображения блока на основной странице центра администрирования.
boolean CopyExtraProperty()
Метод копирования дополнительного параметра
true DeleteExternalPropertyValue()
Метод удаления значения доплнительного параметра пользователя сайта
boolean DeleteExtraProperty()
Удаление дополнительного параматра
boolean DeleteSiteUser()
Метод удаления пользователя из системы
boolean DelGroupUser()
Удаление пользователя из группы
boolean DelUserGroup()
Удаление группы пользователей заданной идентификатором
resource GetAllUsers()
Получение информации о всех пользователях сайта
int GetCurrentSiteUser()
Метод определения идентификатора текущего пользователя сайта.
mixed: GetDefaultGroup()
Получение id группы используемой по умолчанию
array GetExtraProperties()
Получение дополнительных свойств по их идентификатору
mixed GetExtraProperty()
Получение значения свойств дополнительного параметра
array GetGroupsForUser()
Определение идентификаторов групп, в которые входит пользователь
array GetListExtraProperties()
Метод возвращает список дополнительных параметров для пользователя с указанным идентификатором
mixed GetListPrimaryProperties()
УСТАРЕВШИЙ Получение основных данных о пользователе
mixed GetSiteUser()
Получение информации о пользователе сайта
mixed GetSiteUserByLogin()
Получение информации о пользователе сайта по его логину
mixed GetSiteUsersGroup()
Получение информации о группе пользователей сайта
mixed GetSiteUsersGroupList()
Получение данных соответствия, пользователя группе пользователей, по идентификатору соответствия
string GetSiteUsersGroupsXml()
Формирование XML для группы пользователей
string GetSiteUserXml()
Метод формирования XML с данными о пользователе
string GetUserDir()
Метод возвращает абсолютный путь к директории пользователя сайта
array GetUserGroups()
УСТАРЕВШИЙ Метод определения идентификаторов всех групп, в которые входит пользователь.
string GetUsersDir()
Метод возвращает абсолютный путь к директории для хранения файлов пользователей
mixed: GetValueExtraProperty()
Получение значения дополнительного параметра пользователя по идентификатору пользователя и имени параметра
array IndexationUser()
Метод индексации пользователей сайта
int InsertExtraProperty()
Добавление/редактирование дополнительного параметра
int InsertSiteUser()
Добавление/обновление информации о пользователе сайта
int InsertUserGroup()
Вставки/обновление информации о группе пользователей
boolean InsertUsers()
Добавление пользователя в группу
boolean OrderExtraProperty()
Метод обновления коэффициентов порядка сортировки
void PrivateOfficeXML()
УСТАРЕВШИЙ (новый метод - ShowUserOffice). Метод формирования XML для кабинета пользователя и отображение его на экране согласно xsl шаблону.
array SearchIndexing()
Функция обратного вызова для поисковой индексации данных модуля
resource SelectExtraProperties()
Получение всех дополнительных свойств
resource SelectSiteUsersGroups()
Получение данных о всех группах пользователей сайта
resource SelectUserType()
Метод возвращает параметры группы пользователя
boolean SendNewPassword()
Метод отправки нового пароля на почтовый ящик пользователю
boolean SendRegistInf()
Метод отправки пользователю регистрационной информации
mixed SetConfirmation()
Установки подтверждения регистрации пользователя определяемого по индексу(для клиентской части)
bool SetConfirmationID()
Метод установки/снятия подтверждения регистрации пользователя определяемого по идентификатору
void SetCurrentSiteUser()
Метод авторизации пользователя сайта, необходимо вызывать до начала вывода данных в поток
boolean SetDefaultGroup()
Установка группы пользователей по умолчанию
boolean SetValueExtraProperty()
Установка значения дополнительного параметра пользователя
void ShowSiteUserRegistartion()
Вывод формы регистрации для пользователя сайта
void ShowUserOffice()
Метод отображения кабинета пользователя
boolean Unregistration()
Метод удаления пользователя, определяемого по индексу (для клиентского раздела). Удаляет только не активированного пользователя
void UnsetCurrentSiteUser()
Метод отменяет авторизацию текущего пользователя сайта, используется при "выходе" из
mixed: UpdateSiteUser()
Обновление анкетных данных пользователя. Рекомендуется использовать InsertSiteUser().
ValidUser()
Метод возвращает идентификатор пользователя по его логину и паролю
string _CallbackSearch()
Функция обратного вызова, используется модулем поисковой системы при выводе результатов поиска

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

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

SiteUsers::AdminMainPage

AdminMainPage( );

Описание

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

[ Наверх ]

SiteUsers::CopyExtraProperty

CopyExtraProperty( int $extraproperty_id );

Описание

Метод копирования дополнительного параметра

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

$extraproperty_id

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $extraproperty_id = 15;
 
 $result = $SiteUsers->CopyExtraProperty($extraproperty_id);
 
 if ($result)
 {
     echo "Копирование выполнено успешно";
 }
 else
 {
     echo "Ошибка копирования";
 }
 ?>

[ Наверх ]

SiteUsers::DeleteExternalPropertyValue

DeleteExternalPropertyValue( int $external_property_value_id );

Описание

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

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

$external_property_value_id

 <?php
 $SiteUsers = new SiteUsers();
 
 $external_property_value_id = 15;
 
 $result = $SiteUsers->DeleteExternalPropertyValue($external_property_value_id);
 
 if ($result)
 {
     echo "Удаление значения свойства выполнено успешно";
 }
 else
 {
     echo "Ошибка удаления значения свойства";
 }
 ?>

Возвращает

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

[ Наверх ]

SiteUsers::DeleteExtraProperty

DeleteExtraProperty( int $extraproperty_id );

Описание

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

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

$extraproperty_id

идентификатор дополнительного параметра

 <?php
 $SiteUsers = new SiteUsers();
 
 $extraproperty_id = 14;
 
 $result = $SiteUsers->DeleteExtraProperty($extraproperty_id);
 
 if ($result)
 {
     echo "Удаление свойства выполнено успешно";
 }
 else
 {
    echo "Ошибка удаления свойства";
 }
 ?>

[ Наверх ]

SiteUsers::DeleteSiteUser

DeleteSiteUser( int $site_users_id );

Описание

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

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

$site_users_id

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_id = 4;
 
 $result = $SiteUsers->DeleteSiteUser($site_users_id);
 
 if ($result)
 {
     echo "Удаление выполнено успешно";
 }
 else
 {
     echo "Ошибка удаления";
 }
 ?>

[ Наверх ]

SiteUsers::DelGroupUser

DelGroupUser( int $site_users_id, [int $site_users_group_id = -1], [ $information_groups_id = 0] );

Описание

Удаление пользователя из группы

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

$site_users_id

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

$site_users_group_id

= -1 идентификатор группы пользователей сайта(-1 исключаем пользователя из всех групп)

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_id = 1;
 $site_users_group_id = 6;
 
 $result = $SiteUsers->DelGroupUser($site_users_id, $site_users_group_id);
 
 if ($result)
 {
     echo "Удаление пользователя из группы выполнено успешно";
 }
 else
 {
     echo "Ошибка удаления пользователя";
 }
 ?>

$information_groups_id

[ Наверх ]

SiteUsers::DelUserGroup

DelUserGroup( int $site_users_group_id );

Описание

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

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

$site_users_group_id

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_group_id = 14;
 
 $result = $SiteUsers->DelUserGroup($site_users_group_id);
 
 if ($result)
 {
     echo "Удаление выполнено успешно";
 }
 else
 {
     echo "Ошибка удаления";
 }
 ?>

[ Наверх ]

SiteUsers::GetAllUsers

GetAllUsers( [array $param = array()] );

Описание

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

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

$param

массив дополнительных ограничений для выборки

$param['site_users_group_id'] int идентификатор группы пользователей
$param['site_id'] int идентификатор сайта, если не передан - используется текущий, если false - все сайты

$param['information_groups_id'] int идентификатор информационной группы

 <?php
 $SiteUsers = new SiteUsers();
 
 $resource = $SiteUsers->GetAllUsers();
 
 // Распечатаем результат
 while($row = mysql_fetch_assoc($resource))
 {
     print_r($row);
 }
 ?>

Возвращает

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

[ Наверх ]

SiteUsers::GetCurrentSiteUser

GetCurrentSiteUser( );

Описание

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_user_id = $SiteUsers->GetCurrentSiteUser();
 
 // Распечатаем результат
 echo $site_user_id;
 ?>

Возвращает

идентификатор текущего пользователя сайта (пользователь не задан - 0)

[ Наверх ]

SiteUsers::GetDefaultGroup

GetDefaultGroup( [int $site_id = CURRENT_SITE] );

Описание

Получение id группы используемой по умолчанию

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

$site_id

идентификатор сайта. По умолчанию равен идентификатору текущего сайта

 <?php
 $SiteUsers = new SiteUsers();
 
 $result = $SiteUsers->GetDefaultGroup();
 
 echo $result;
 ?>

Возвращает

int идентификатор группы используемой по умолчанию,
boolean false если запись не найдена

[ Наверх ]

SiteUsers::GetExtraProperties

GetExtraProperties( int $site_users_extra_property_id );

Описание

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

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

$site_users_extra_property_id

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_extra_property_id = 15;
 
 $row = $SiteUsers->GetExtraProperties($site_users_extra_property_id);
 
 // Распечатаем результат
 print_r($row);
 ?>

Возвращает

ассоциативный массив данных

[ Наверх ]

SiteUsers::GetExtraProperty

GetExtraProperty( string $site_users_extra_property_name, [int $site_id = false] );

Описание

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

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

$site_users_extra_property_name

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

$site_id

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_extra_property_name = 'property1';
 
 $row = $SiteUsers->GetExtraProperty($site_users_extra_property_name);
 
 // Распечатаем результат
 print_r ($row);
 ?>

Возвращает

данные о свойстве

[ Наверх ]

SiteUsers::GetGroupsForUser

GetGroupsForUser( int $site_users_id, [array $param = array()] );

Описание

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

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

$site_users_id

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

$param

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

int $param['information_groups_id'] идентификатор информационной группы

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_id = 5;
 
 $row = $SiteUsers->GetGroupsForUser($site_users_id);
 
 // Распечатаем результат
 print_r ($row);
 ?>

Возвращает

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

[ Наверх ]

SiteUsers::GetListExtraProperties

GetListExtraProperties( int $site_users_id, [int $site_id = CURRENT_SITE] );

Описание

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

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

$site_users_id

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

$site_id

идентификатор сайта (по умолчанию принимает идентификатор текущего сайта )

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_id = 1;
 
 $row = $SiteUsers->GetListExtraProperties($site_users_id);
 
 // Распечатаем результат
 print_r ($row);
 ?>

Возвращает

массив характеристик дополнительных параметров:
$result[$i]['site_users_extra_property_id'] int идентификатор;
$result[$i]['site_users_extra_property_name'] string имя;
$result[$i]['site_users_extra_property_title'] string название;
$result[$i]['site_users_extra_property_type'] string тип;
$result[$i]['site_users_extra_property_size'] int размер значения;
$result[$i]['site_users_extra_property_rows'] int количество строк;
$result[$i]['site_users_extra_property_cols'] int количество столбцов;
$result[$i]['site_users_extra_property_checked'] int выбран(1) или нет(0);
$result[$i]['site_users_extra_property_default_value'] mixed значение по умолчанию;
$result[$i]['site_users_extra_property_order'] int порядок сортировки;
$result[$i]['site_users_extra_property_comment'] string коментарий;
$result[$i]['lists_id'] int идентификатор списка;
$result[$i]['site_users_property_value'] mixed значение

[ Наверх ]

SiteUsers::GetListPrimaryProperties

GetListPrimaryProperties( int $site_users_id );

Описание

УСТАРЕВШИЙ Получение основных данных о пользователе

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

$site_users_id

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

Возвращает

ассоциативный массив с данными или false если пользователь не найден

[ Наверх ]

SiteUsers::GetSiteUser

GetSiteUser( int $site_users_id, [array $param = array()] );

Описание

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

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

$site_users_id

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

$param

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

bool $param['cache_off'] - если параметр установлен - данные не кэшируются

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_id = 5;
 
 $row = $SiteUsers->GetSiteUser($site_users_id);
 
 // Распечатаем результат
 print_r ($row);
 ?>

Возвращает

информация о пользователе, если пользователь есть в базе, иначе - ложь

[ Наверх ]

SiteUsers::GetSiteUserByLogin

GetSiteUserByLogin( str $site_user_login, [int $site_id = false] );

Описание

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

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

$site_user_login

логин пользователя

$site_id

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_user_login = 'admin';
 
 $row = $SiteUsers->GetSiteUserByLogin($site_user_login);
 
 // Распечатаем результат
 print_r ($row);
 ?>

Возвращает

информация о пользователе, если пользователь есть в базе, иначе - ложь

[ Наверх ]

SiteUsers::GetSiteUsersGroup

GetSiteUsersGroup( int $site_users_group_id, [array $param = array()] );

Описание

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

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

$site_users_group_id

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

$param

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

bool $param['cache_off'] - если параметр установлен - данные не кэшируются

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_group_id = 6;
 
 $row = $SiteUsers->GetSiteUsersGroup($site_users_group_id);
 
 // Распечатаем результат
 print_r($row);
 ?>

Возвращает

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

[ Наверх ]

SiteUsers::GetSiteUsersGroupList

GetSiteUsersGroupList( int $site_users_group_list_id );

Описание

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

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

$site_users_group_list_id

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_group_list_id = 1;
 
 $row = $SiteUsers->GetSiteUsersGroupList($site_users_group_list_id);
 
 // Распечатаем результат
 print_r($row);
 ?>

Возвращает

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

[ Наверх ]

SiteUsers::GetSiteUsersGroupsXml

GetSiteUsersGroupsXml( array $param );

Описание

Формирование XML для группы пользователей

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

$param

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

array $param['array_site_users_groups_id'] массив идентификаторов групп пользователей
bool $param['show_site_users'] параметр, определяющий добавление информации о пользователях. По умолчанию равен true - информация о пользователях добавляется
int $param['information_groups_id'] идентификатор информационной группы
bool $param['xml_show_external_property'] - разрешает передачу в XML информации о дополнительных свойствах пользователя, по умолчанию true Парметры, применяемые в социальных сетях
int $param['change_access_action_site_user_id'] идентификатор пользователя сайта, для которого проверяем право изменения доступа к действию группам пользователей из $param['array_site_users_groups_id']
int $param['information_items_id'] идентификатор информационного элемента
bool $param['show_access_actions'] параметр, определяющий добавление информации о действиях социальной сети, доступных для группы пользователей. По умолчанию false - не добавляем информацию о доступных действиях
int $param['sns_id'] идентификатор социальной сети
mixed $param['sns_type_id'] массив идентификаторов типов социальной сети. По умолчанию равен false - не учитывается тип блога
mixed $param['social_network_service_action_parent_id'] идентификатор родительского действия. По умолчанию равен false - получаем все действия блогосистемы.
mixed $param['show_children_actions'] параметр, определяющий построение XML для дочерних действий всех подуровней. По умолчанию false - не строим XML для дочерних действий

Возвращает

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

[ Наверх ]

SiteUsers::GetSiteUserXml

GetSiteUserXml( int $site_users_id, [array $external_property = array()], [array $default_property = array()], [array $param = array()] );

Описание

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

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

$site_users_id

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

$external_property

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

$default_property

введенные значения

$param

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

bool $param['cache_off'] - если параметр установлен, то данные не кэшируются

bool $param['xml_show_external_property'] разрешает передачу в XML информации о дополнительных свойствах пользователя, по умолчанию true

 <?php
 $SiteUsers = new SiteUsers();
 
 // Если есть модуль "Пользователи сайта", получим текущего пользователя
 if (class_exists('SiteUsers'))
 {
     $SiteUsers = & singleton('SiteUsers');
     $site_users_id = $SiteUsers->GetCurrentSiteUser();
 }
 else
 {
     $site_users_id = 0;
 }
 
 $newxml = $SiteUsers->GetSiteUserXml($site_users_id);
 
 // Распечатаем результат
 echo $newxml;
 ?>

Возвращает

сформированный xml для регистрации

[ Наверх ]

SiteUsers::GetUserDir

GetUserDir( int $site_users_id );

Описание

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

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

$site_users_id

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_id = 5;
 
 $path = $SiteUsers->GetUserDir($site_users_id);
 
 // Распечатаем результат
 echo $path;
 ?>

[ Наверх ]

SiteUsers::GetUserGroups

GetUserGroups( int $site_users_id );

Описание

УСТАРЕВШИЙ Метод определения идентификаторов всех групп, в которые входит пользователь.

Вместо него рекомендуется использовать GetGroupsForUser($site_users_id)

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

$site_users_id

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

Возвращает

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

see

SiteUsers::GetGroupsForUser()

[ Наверх ]

SiteUsers::GetUsersDir

GetUsersDir( );

Описание

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $path = $SiteUsers->GetUsersDir();
 
 // Распечатаем результат
 echo $path;
 ?>

[ Наверх ]

SiteUsers::GetValueExtraProperty

GetValueExtraProperty( int $site_users_id, string $name_extra_property, [int $site_id = false] );

Описание

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

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

$site_users_id

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

$name_extra_property

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

$site_id

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_id = 1;
 $name_extra_property = 'param';
 
 $result = $SiteUsers->GetValueExtraProperty($site_users_id, $name_extra_property);
 
 // Распечатаем результат
 echo $result;
 ?>

Возвращает

string значение дополнительного параметра,
boolean false если операция не выполнена

[ Наверх ]

SiteUsers::IndexationUser

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

Описание

Метод индексации пользователей сайта

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

$limit

ограничение(по сколько элементов индексировать)

$on_step

шаг для индексации

$parameters

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

$parameters['site_users_id'] - идентификатор индексируемого пользователя сайта при событийной индексации

 <?php
 $SiteUsers = new SiteUsers();
 
 $limit = 5;
 $on_step = 10;
 
 $row = $SiteUsers->IndexationUser($limit, $on_step);
 
 // Распечатаем результат
 print_r($row);
 ?>

Возвращает

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

[ Наверх ]

SiteUsers::InsertExtraProperty

InsertExtraProperty( int $site_users_extra_property_id, string $property_name, string $property_type, string $property_title, int $property_size, int $property_rows, int $property_cols, int $property_checked, string $property_default_value, int $property_order, string $property_comment, int $lists_id, [int $users_id = false], [int $site_id = CURRENT_SITE] );

Описание

Добавление/редактирование дополнительного параметра

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

$site_users_extra_property_id

идентификатор дополнительного параметра

$property_name

имя

$property_type

тип

$property_title

название

$property_size

размер

$property_rows

кол-во строк (для большого текстового поля)

$property_cols

ширина (для большого текстового поля)

$property_checked

значение свойства 'selected' тега элемента формы

$property_default_value

значение по умолчанию

$property_order

порядок сортировки

$property_comment

комментарий

$lists_id

id списка

$users_id

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

$site_id

идентификатор сайта (по умолчанию принимает значение идентификатора текущего сайта)

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_extra_property_id = 0;
 $property_name = 'param';
 $property_type = 1;
 $property_title = 'param_title';
 $property_size = '';
 $property_rows = '';
 $property_cols = '';
 $property_checked = '';
 $property_default_value = '';
 $property_order = '';
 $property_comment = '';
 $lists_id = '';
 
 $newid = $SiteUsers->InsertExtraProperty($site_users_extra_property_id, $property_name, $property_type, $property_title, $property_size, $property_rows, $property_cols, $property_checked, $property_default_value, $property_order, $property_comment, $lists_id);
 
 // Распечатаем результат
 echo $newid;
 ?>

Возвращает

результат выполнения:
-1 - если неверно задано имя параметра или оно дублируется,

- произошла ошибка выполнения запроса,
- функция выполнена успешно

[ Наверх ]

SiteUsers::InsertSiteUser

InsertSiteUser( array $param );

Описание

Добавление/обновление информации о пользователе сайта

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

$param

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

$param['site_id'] идентификатор сайта
$param['site_users_group_id'] группа пользователей, необязательный параметр
$param['site_users_login'] логин
$param['site_users_password'] пароль
$param['site_users_email'] эл.почта
$param['site_users_name'] имя
$param['site_users_surname'] фамилия
$param['site_users_patronymic'] отчество
$param['site_users_company'] название компании
$param['site_users_phone'] телефон
$param['site_users_fax'] факс
$param['site_users_site'] сайт
$param['site_users_icq'] ICQ
$param['site_users_country'] страна
$param['site_users_postcode'] почтовый индекс
$param['site_users_city'] город
$param['site_users_date_registration'] дата регистрации, необязательное поле
$param['site_users_ip'] IP адрес, необязательное поле
$param['site_users_confirmation'] параметр, подтверждающий регистрацию пользователя (0 - не подтверждать регистрацию (по умолчанию), 1- подтверждить регистрацию)
$param['allow_access'] bool авторизировать пользователя сразу после регистрации;
$param['location'] string путь к странице, на которую перейдет пользователь при подтверждении регистрации
$param['not_send_mail_confirm'] bool флаг, указывающий на то, что письмо с подтверждением отправлять не надо
$param['xslname'] string XSL шаблон для отправки сообщения о регистрации
$param['users_id'] int идентификатор пользователя, если false - берется текущий пользователь.

$param['subject'] string тема письма с подтверждением регистрации.

 <?php
 $SiteUsers = new SiteUsers();
 
 $param['site_users_name'] = 'Вася';
 $param['site_users_surname'] = 'Пупкин';
 $param['site_users_login'] = 'newlogin';
 $param['site_users_password'] = '123456';
 $param['site_users_email'] = 'admin@site.ru';
 $param['users_id'] = false;
 
 $newid = $SiteUsers->InsertSiteUser($param);
 
 // Распечатаем результат
 echo $newid;
 ?>

Возвращает

идентификатор вставленной записи. Возможные коды ошибок:
-4 - Не задан логин или пароль
-3 - Дублирующийся логин
-2 - Дублирующийся e-mail
-1 - Некорректный e-mail

[ Наверх ]

SiteUsers::InsertUserGroup

InsertUserGroup( int $site_users_group_id, string $site_users_group_name, string $site_users_group_comment, [int $users_id = false], [ $site_users_group_default = 0], [ $site_id = false] );

Описание

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

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

$site_users_group_id

идентификатор группы (если 0, то добавление, в противном случае - редактирование)

$site_users_group_name

имя группы

$site_users_group_comment

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

$users_id

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_group_id = 0;
 $site_users_group_name = 'Группа пользователей';
 $site_users_group_comment = 'коментарий к группе';
 
 $newid = $SiteUsers->InsertUserGroup($site_users_group_id, $site_users_group_name, $site_users_group_comment);
 
 // Распечатаем результат
 echo $newid;
 ?>

$site_users_group_default

$site_id

Возвращает

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

[ Наверх ]

SiteUsers::InsertUsers

InsertUsers( int $site_users_group_id, int $site_users_id, [int $information_groups_id = 0] );

Описание

Добавление пользователя в группу

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

$site_users_group_id

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

$site_users_id

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

$information_groups_id

идентификатор информационной группы, по умолчанию 0

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_group_id = 7;
 $site_users_id = 5;
 
 $result = $SiteUsers->InsertUsers($site_users_group_id, $site_users_id);
 
 if ($result)
 {
     echo "Добавление пользователя выполнено успешно";
 }
 else
 {
     echo "Ошибка добавления пользователя";
 }
 ?>

[ Наверх ]

SiteUsers::OrderExtraProperty

OrderExtraProperty( array $mas_orders );

Описание

Метод обновления коэффициентов порядка сортировки

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

$mas_orders

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

[ Наверх ]

SiteUsers::PrivateOfficeXML

PrivateOfficeXML( string $title, array $links, string $xslname, [int $sire_users_id = false] );

Описание

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

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

$title

заголовок

$links

массив с информацией о ссылке:
$link[$i][0] string текст ссылки,
$link[$i][1] string адрес ссылки

$xslname

наименование xsl шаблона

$sire_users_id

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

[ Наверх ]

SiteUsers::SearchIndexing

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

Описание

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

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

$limit

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

$on_step

шаг

[ Наверх ]

SiteUsers::SelectExtraProperties

SelectExtraProperties( [ $site_id = CURRENT_SITE] );

Описание

Получение всех дополнительных свойств

 <?php
 $SiteUsers = new SiteUsers();
 
 $resource = $SiteUsers->SelectExtraProperties();
 
 // Распечатаем результат
 while($row = mysql_fetch_assoc($resource))
 {
     print_r($row);
 }
 ?>

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

$site_id

Возвращает

результат запроса к базе данных

[ Наверх ]

SiteUsers::SelectSiteUsersGroups

SelectSiteUsersGroups( [$param $param = array()] );

Описание

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

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

$param

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

$param['site_id'] int идентификатор сайта, если не передан - используется текущий, если false - все сайты
$param['order_field'] поле сортировки (по умолчанию сортировка по названию группы)

$param['order_direction'] направление сортировки (asc (по умолчанию) по возрастанию, desc - по убыванию)

 <?php
 $SiteUsers = new SiteUsers();
 
 $resource = $SiteUsers->SelectSiteUsersGroups();
 
 // Распечатаем результат
 while($row = mysql_fetch_assoc($resource))
 {
     print_r($row);
 }
 ?>

Возвращает

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

[ Наверх ]

SiteUsers::SelectUserType

SelectUserType( int $site_users_group_id );

Описание

Метод возвращает параметры группы пользователя

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

$site_users_group_id

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_group_id = 7;
 
 $resource = $SiteUsers->SelectUserType($site_users_group_id);
 
 // Распечатаем результат
 while($row = mysql_fetch_assoc($resource))
 {
     print_r($row);
 }
 ?>

Возвращает

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

[ Наверх ]

SiteUsers::SendNewPassword

SendNewPassword( string $login, string $email, [ $xslname = ''], [array $param = array()], string $xslname='' );

Описание

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

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

$login

логин пользователя

$email

e-mail пользователя

$xslname=''

xsl-шаблон для письма

$param

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

$param['site_id'] идентификатор сайта, если не передан - используется текущий
$param['subject'] тема письма, по умолчанию 'Восстановление пароля'

$param['mail_type'] тип письма, по умолчанию 'text/plain'

 <?php
 $SiteUsers = new SiteUsers();
 
 $login = 'tygra';
 $email = 'tygra@localhost.ru';
 $xslname = 'ПисьмоВосстановлениеПароля';
 
 $result = $SiteUsers->SendNewPassword($login, $email, $xslname);
 
 if ($result)
 {
     echo "Отправка пароля выполнена успешно";
 }
 else
 {
     echo "Ошибка отправки";
 }
 ?>

$xslname

[ Наверх ]

SiteUsers::SendRegistInf

SendRegistInf( array $param );

Описание

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

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

$param

массив параметров, содержит следующие элементы:

$param['site_user_id'] int идентификатор пользователя,
$param
$param['xslname'] string шаблон письма пользователю,
$param
$param['site_users_password'] string пароль пользователя, передается

$param['subject'] string тема письма
$param['mail_type'] тип письма - текст или HTML (по умолчанию - text/plain)
$param ['location'] string указатель на страницу перехода после

 <?php
 $SiteUsers = new SiteUsers();
 
 $param['site_user_id'] = 3;
 $param['site_users_password'] = 'tygra';
 $param['mail_type'] = 'text/plain';
 $param['subject'] = '';
 $param['location'] = '';
 $param['xslname'] = 'ПисьмоПодтверждениеРегистрации';
 
 $result = $SiteUsers->SendRegistInf($param);
 
 if ($result)
 {
     echo "Отправка данных выполнена успешно";
 }
 else
 {
     echo "Ошибка отправки";
 }
 ?>

[ Наверх ]

SiteUsers::SetConfirmation

SetConfirmation( string $site_user_index );

Описание

Установки подтверждения регистрации пользователя определяемого по индексу(для клиентской части)

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

$site_user_index

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

Возвращает

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

[ Наверх ]

SiteUsers::SetConfirmationID

SetConfirmationID( int $site_users_id );

Описание

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

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

$site_users_id

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_id = 6;
 
 $result = $SiteUsers->SetConfirmationID($site_users_id);
 
 if ($result)
 {
     echo "Регистрация подтверждена";
 }
 else
 {
    echo "Ошибка регистрации";
 }
 ?>

[ Наверх ]

SiteUsers::SetCurrentSiteUser

SetCurrentSiteUser( int $site_users_id, [int $expires = 2678400] );

Описание

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

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

$site_users_id

идентификатор пользователя, должен быть больше 0

$expires

время в секундах, в течении которого авторизация пользователя активна. по умолчанию = 2678400 (месяц)

[ Наверх ]

SiteUsers::SetDefaultGroup

SetDefaultGroup( int $site_users_group_id, [int $site_id = false] );

Описание

Установка группы пользователей по умолчанию

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

$site_users_group_id

идентификатор группы по умолчанию

$site_id

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_group_id = 6;
 
 $result = $SiteUsers->SetDefaultGroup($site_users_group_id);
 
 if ($result)
 {
     echo "Группа установлена по умолчанию";
 }
 else
 {
     echo "Ошибка выполнения операции";
 }
 ?>

[ Наверх ]

SiteUsers::SetValueExtraProperty

SetValueExtraProperty( int $site_users_id, mixed $extra_property_value, array $param );

Описание

Установка значения дополнительного параметра пользователя

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

$site_users_id

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

$extra_property_value

значение дополнительнго параметра

$param

массив дополнительных параметров, позволяющий задать дополнительное свойство как идентификатором array('id' => 1), так и именем array('name' => 'myname')

$param['id'] идентификатор свойства (site_users_extra_property_id)
$param['property_max_width'] максимальная ширина загружаемого изображения
$param['property_max_height'] максимальная высота загружаемого изображения
$param['avatar_max_width'] максимальная ширина аватара пользователя сайта

$param['avatar_max_height'] максимальная высота аватара пользователя сайта

 <?php
 $SiteUsers = new SiteUsers();
 
 $param = array();
 $param['id'] = 123;
 $site_users_id = 1;
 $extra_property_value = 'value';
 
 $result = $SiteUsers->SetValueExtraProperty($site_users_id, $extra_property_value, $param);
 
 // Распечатаем результат
 echo $result;
 ?>

[ Наверх ]

SiteUsers::ShowSiteUserRegistartion

ShowSiteUserRegistartion( int $site_users_id, string $xslname, [array $external_property = array()], [array $default_property = array()], [array $param = array()] );

Описание

Вывод формы регистрации для пользователя сайта

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

$site_users_id

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

$xslname

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

$external_property

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

$default_property

массив дополнительных значений (заменяет введенные значения для полей пользователя)

$param

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_users_id = 0;
 $xslname = 'РегистрацияПользователя';
 
 $newxml = $SiteUsers->ShowSiteUserRegistartion($site_users_id, $xslname);
 ?>

[ Наверх ]

SiteUsers::ShowUserOffice

ShowUserOffice( string $xslname, $external_propertys, [int $sire_users_id = false], array $external_property );

Описание

Метод отображения кабинета пользователя

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

$xslname

$external_property

массив внешних параметров, формат:

$external_property[0]['xml_name'] = 'xml_name';
$external_property[0]['value'] = 'value';

$sire_users_id

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $xslname = 'ЛичныйКабинетПользователя';
 
 $SiteUsers->ShowUserOffice($xslname);
 ?>

$external_propertys

[ Наверх ]

SiteUsers::Unregistration

Unregistration( string $site_user_index );

Описание

Метод удаления пользователя, определяемого по индексу (для клиентского раздела). Удаляет только не активированного пользователя

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

$site_user_index

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $site_user_index = '0c5379c156ce38088351810374204d19';
 
 $result = $SiteUsers->Unregistration($site_user_index);
 
 if ($result)
 {
     echo "Удаление выполнено успешно";
 }
 else
 {
 echo "Ошибка удаления";
 }
 ?>

[ Наверх ]

SiteUsers::UnsetCurrentSiteUser

UnsetCurrentSiteUser( );

Описание

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

кабинета пользователя

[ Наверх ]

SiteUsers::UpdateSiteUser

UpdateSiteUser( int $site_users_id, array $param );

Описание

Обновление анкетных данных пользователя. Рекомендуется использовать InsertSiteUser().

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

$site_users_id

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

$param

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

$param['site_id'] идентификатор сайта (по умолчанию принимает значение идентификатора текущего сайта)
$param['site_user_login'] логин
$param['site_user_password'] пароль
$param['site_user_email'] e-mail
$param['site_users_name'] имя
$param['site_users_surname'] фамилия
$param['site_users_patronymic'] отчество
$param['site_users_company'] компания
$param['site_users_phone'] телефон
$param['site_users_fax'] факс
$param['site_users_site'] сайт
$param['site_users_icq'] аська
$param['site_users_country'] страна
$param['site_users_postcode'] почтовый индекс
$param['site_users_city'] город
$param['site_users_address'] адрес
$param['site_users_date_registration'] дата регистрации (не обязательное)
$param['site_users_ip'] IP (не обязательное)
$param['users_id'] идентификатор пользователя, если false - берется текущий пользователь.
$param['site_users_confirmation'] параметр, подтверждающий регистрацию пользователя (0 - не подтверждать регистрацию (по умолчанию), 1- подтверждить регистрацию)

Возвращает

boolean true при успешном обновлении,
int 0, -1, -2, -3 - в случае возникновения раличного рода ошибок
(0 - ошибка выполнения запроса, -1 - некорректный e-mail, -2 - дублирующийся e-mail, -3 - дублирующийся логин)

see

SiteUsers::InsertSiteUser()

[ Наверх ]

SiteUsers::ValidUser

ValidUser( string $login, string $password, [int $site_id = false] );

Описание

Метод возвращает идентификатор пользователя по его логину и паролю

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

$login

логин пользователя

$password

пароль пользователя

$site_id

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

 <?php
 $SiteUsers = new SiteUsers();
 
 $login = 'admin';
 $password = 'admin';
 
 $result = $SiteUsers->ValidUser($login, $password);
 
 // Распечатаем результат
 echo $result;
 ?>

Возвращает

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

- пользователь не зарегистрирован,

[ Наверх ]

SiteUsers::_CallbackSearch

_CallbackSearch( array $row );

Описание

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

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

$row

массив с информацией о странице

Возвращает

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

[ Наверх ]

Class SiteUsers

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

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

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

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

Методы

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

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

SiteUsers::AdminMainPage

SiteUsers::CopyExtraProperty

SiteUsers::DeleteExternalPropertyValue

SiteUsers::DeleteExtraProperty

SiteUsers::DeleteSiteUser

SiteUsers::DelGroupUser

SiteUsers::DelUserGroup

SiteUsers::GetAllUsers

SiteUsers::GetCurrentSiteUser

SiteUsers::GetDefaultGroup

SiteUsers::GetExtraProperties

SiteUsers::GetExtraProperty

SiteUsers::GetGroupsForUser

SiteUsers::GetListExtraProperties

SiteUsers::GetListPrimaryProperties

SiteUsers::GetSiteUser

SiteUsers::GetSiteUserByLogin

SiteUsers::GetSiteUsersGroup

SiteUsers::GetSiteUsersGroupList

SiteUsers::GetSiteUsersGroupsXml

SiteUsers::GetSiteUserXml

SiteUsers::GetUserDir

SiteUsers::GetUserGroups

SiteUsers::GetUsersDir

SiteUsers::GetValueExtraProperty

SiteUsers::IndexationUser

SiteUsers::InsertExtraProperty

SiteUsers::InsertSiteUser

SiteUsers::InsertUserGroup

SiteUsers::InsertUsers

SiteUsers::OrderExtraProperty

SiteUsers::PrivateOfficeXML

SiteUsers::SearchIndexing

SiteUsers::SelectExtraProperties

SiteUsers::SelectSiteUsersGroups

SiteUsers::SelectUserType

SiteUsers::SendNewPassword

SiteUsers::SendRegistInf

SiteUsers::SetConfirmation

SiteUsers::SetConfirmationID

SiteUsers::SetCurrentSiteUser

SiteUsers::SetDefaultGroup

SiteUsers::SetValueExtraProperty

SiteUsers::ShowSiteUserRegistartion

SiteUsers::ShowUserOffice

SiteUsers::Unregistration

SiteUsers::UnsetCurrentSiteUser

SiteUsers::UpdateSiteUser

SiteUsers::ValidUser

SiteUsers::_CallbackSearch

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

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