Граф наследования:User:

Открытые члены
	__construct ($id=null, $cache=true)

	beforeWrite ($flag)

	afterWrite ($flag)

	afterObjectLoad ()

	getUserGroups ($returnAliases=true)

	setIgnoreClientSideGroups ($value=true)

	getClientSideGroups ()

	inGroup ($group_alias)

	isAdmin ()

	linkGroup (array $groups)

	addGroup ($groupid)

	unlinkGroup ($group_id=null)

	getModuleAccess ()

	getRight ($module)

	checkModuleRight ($module, $right)

	getMenuAccess ()

	getAdminMenuAccess ()

	delete ()

	create ()

	checkCreateData ()

	getUserFields ()

	getFio ()

	getShortFio ()

	updateHash ($commit=true)

	isSupervisor ()

	checkSiteRights ($site_id)

	getAllowSites ()

	getBalance ($use_currency=false, $format=false)

	checkBalanceSign ()

	getDefaultGroup ()

	getAuthorizedGroup ()

	saveVisitDate ()

	getFormattedPhoneNumber ()

	enableOpenPassConfirm ()

	enableRegistrationCheckers ()

	addLinkToAuthInError ($bool)

	refreshChangeDatePassword ()

	getRemoteAuthorizationKey ()

Открытые члены унаследованные от OrmObject
	__construct ($id=null, $cache=true)

	getPrimaryKeyProperty ()

	saveInCache ($id)

	loadFromCache ($id)

Открытые члены унаследованные от AbstractObject
static	__construct ()

	__destruct ()

	fillDefaults ()

	getClassParameter ($key=null)

	setClassParameter ($key, $value=null)

	issetClassParameter ($key=null)

	setLocalParameter ($key, $value=null)

	getLocalParameter ($key, $default=null)

	getParameter ($key, $default=null)

	setPropertyIterator (PropertyIterator $iterator)

	checkRights ($bool)

	clear ()

	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	__set ($offset, $value)

	__get ($offset)

	offsetUnset ($offset)

	getShortAlias ()

	load ($primaryKeyValue=null)

	insert ($ignore=false, $on_duplicate_update_keys=[], $on_duplicate_uniq_fields=[])

	update ($primaryKey=null)

	replace ()

	delete ()

	exists ($primaryKeyValue)

	getFromArray (array $data, $remove_prefix=null, $mark_modify=true, $call_afterload_event=false)

	getValues ()

	isModified ($property)

	getPropertyIterator ()

	appendProperty (array $properties)

	_getTableArray ()

	getPrimaryKeyProperty ()

	getProperties ()

	getProp ($offset)

	save ($primaryKeyValue=null, $user_post=[], $post_var=null, $files_var=null)

	replaceOn ($bool)

	setWriteBit ($n)

	usePostKeys (array $keys)

	excludePostKeys (array $keys)

	checkData ($user_post=[], $post_var=null, $files_var=null, $usekeys=null, $exclude=null, $flag=self::UPDATE_FLAG)

	fillFromPost ($user_post=[], $post_var=null, $files_var=null, $usekeys=null, $exclude=null)

	validateData ($flag=self::UPDATE_FLAG)

	validate ()

	setCheckFields (array $fields)

	escapeFields (array $escape_fields)

	escapeAll ($bool)

	checkField ($property)

	addError ($string, $form=null)

	addErrors ($array, $form=null)

	getLastError ()

	getErrors ()

	getErrorsStr ()

	hasError ()

	getFormError ()

	getErrorsByForm ($key=null, $sep=null)

	getDisplayErrors ()

	noWriteRights ($right=DefaultModuleRights::RIGHT_UPDATE)

	getNonFormErrors ()

	clearErrors ()

	setTemporaryId ()

	setFormTemplate ($template)

	dbUpdate ()

	addIndex ($fields, $type=self::INDEX_KEY, $name=null, $using=null)

	getIndexes ()

	getForm (array $tpl_vars=null, $switch=null, $is_multiedit=false, $template=null, $tpl_maker=null, $tpl_folder=null)

	getPropertyView ($key, $attributes=[], $view_params=[])

	getHiddenKeyVal ()

	addHiddenFields ($keys, $value=null)

	addDebugActions (array $actions, $local=false)

	addDebugAction (\RS\Debug\Action\AbstractAction $action, $local=false)

	getDebugAttributes ()

	beforeWrite ($save_flag)

	afterWrite ($save_flag)

	afterObjectLoad ()

	getDebugActions ()

	dropTable ()

	exportErrors ()

	current ()

	key ()

	next ()

	rewind ()

	valid ()

	__sleep ()

	__wakeup ()

	__clone ()

	__isset ($offset)

	getRightRead ()

	getRightCreate ()

	getRightUpdate ()

	getRightDelete ()

	getHtmlEncodedFields ()

Открытые члены унаследованные от AcceptBehavior
	attachInstanceBehavior (BehaviorAbstract $behavior_class)

	detachInstanceBehavior (BehaviorAbstract $behavior_class=null)

	getAttachedBehaviors ()

	behaviorMethodExists ($method_name)

	__call ($method_name, $arguments)

Открытые члены унаследованные от AcceptBehaviorInterface
	attachInstanceBehavior (\RS\Behavior\BehaviorAbstract $behavior_class)

	detachInstanceBehavior (\RS\Behavior\BehaviorAbstract $behavior_class=null)

Открытые статические члены
static	checkOpenPassword ($_this, $value)

static	checkCustomUserFields ($_this, $value)

static	checkCanSetUserToGroups ($_this, $groups)

static	explodeFio ($value)

static	cryptPass ($password, $user=null)

static	checkPassword ($password)

Открытые статические члены унаследованные от OrmObject
static	loadSingle ($id)

Открытые статические члены унаследованные от AbstractObject
static	loadByWhere ($expr, array $values=null, $prefix= 'AND', $in_prefix= 'AND')

static	_getTable ()

static	chkDepend ($coreobj, $value, $real_errtext, $real_chk, array $conditions, $real_params=[])

static	destroyClass ()

Открытые статические члены унаследованные от AcceptBehavior
static	attachClassBehavior (BehaviorAbstract $behavior_class)

static	detachClassBehavior (BehaviorAbstract $behavior_class=null)

Открытые статические члены унаследованные от AcceptBehaviorInterface
static	attachClassBehavior (\RS\Behavior\BehaviorAbstract $behavior_class)

static	detachClassBehavior (\RS\Behavior\BehaviorAbstract $behavior_class=null)

Поля данных
const	SESSION_LAST_VISIT_VAR = 'last_visit'

const	PASSWORD_LEN = 4

const	SUPERVISOR_GROUP = 'supervisor'

Поля данных унаследованные от AbstractObject
const	INSERT_FLAG = 'insert'

const	UPDATE_FLAG = 'update'

const	REPLACE_FLAG = 'replace'

const	INDEX_PRIMARY = 'primary key'

const	INDEX_UNIQUE = 'unique'

const	INDEX_KEY = 'index'

const	INDEX_FULLTEXT = 'fulltext'

Поля данных унаследованные от AcceptBehavior
	$class_behaviors = []

	$cache_behavior_instances = []

	$instance_behaviors = []

Защищенные члены
	_init ()

Защищенные члены унаследованные от OrmObject
	_init ()

Защищенные члены унаследованные от AbstractObject
	initProperties ()

	_init ()

	_initDefaults ()

	afterInit ()

	getStorageInstance ()

	getTableEngine ()

	getPropertyHash ($is_multiedit, $switch=null)

Защищенные данные
	$default_group = 'guest'

	$authorized_user_group = 'clients'

	$access_menu_table

	$access_module_table

	$cache_mod_access

	$cache_menu_access

	$cache_admin_menu_access

	$cache_allow_sites

	$groups = []

	$ignore_client_side_groups

	$link_to_auth_in_error

Защищенные данные унаследованные от AbstractObject
	$_values = []

	$_self_class

	$_local_id

Статические защищенные данные
static	$table = "users"

Статические защищенные данные унаследованные от OrmObject
static	$self_singleton_cache = []

Статические защищенные данные унаследованные от AbstractObject
static	$db = DB_NAME

static	$table = null

static	$iterator = 0

static	$init_default_method = '_initDefaults'

static	$local = []

static	$default_local_parameters

static static	$class = []

static	$default_class_parameters

Дополнительные унаследованные члены
Статические открытые данные унаследованные от OrmObject
static	$self_cache = []

Защищенные статические члены унаследованные от OrmObject
static	getIdHash ($id)

Защищенные статические члены унаследованные от AbstractObject
static	_tableName ($with_quotes=true)

static	_dbName ($with_quotes=true)

Конструктор(ы)

__construct	(	$id = `null`,
		$cache = `true`
	)

Методы

_init ( )

protected

addGroup ( $groupid )

Добавляет группу к уже существующим и пользователя группам

Аргументы

string $groupid - алиас группы

Возвращает: void

addLinkToAuthInError ( $bool )

Устанавливает, включать ли в текст ошибки о том, что email, телефон или логин занят, ссылку на авторизацию

Аргументы

bool $bool

Возвращает: void

afterObjectLoad ( )

Действия после того как подгружен объект

Возвращает: void

afterWrite ( $flag )

Действия после записи объекта

Аргументы

string $flag - insert или update

beforeWrite ( $flag )

Действия перед записью объекта

Аргументы

string $flag - insert или update

Возвращает: bool

checkBalanceSign ( )

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

Возвращает: bool

static checkCanSetUserToGroups	(	$_this,
		$groups
	)

static

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

Аргументы

$_this
$groups

Возвращает: string|true

Исключения

RSException

checkCreateData ( )

Проверяет, можно ли создать пользователя с текущими данными. (проверяется уникальность логина, уникальность e-mail'а)

Возвращает: bool

static checkCustomUserFields	(	$_this,
		$value
	)

static

Проверяет на корректность произвольные поля пользователя, заданные в настройках модуля Users Возвращает true, в случае отсутствия ошибок

Аргументы

self	$_this
array	$value

Возвращает: bool(true) | null

checkModuleRight	(	$module,
		$right
	)

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

Аргументы

string	$module	- имя модуля
string	$right	- идентификатор права

Возвращает: bool

Исключения

DbException
OrmException
RSException

static checkOpenPassword	(	$_this,
		$value
	)

static

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

Аргументы

User	$_this	- проверяемый ORM - объект
mixed	$value	- проверяемое значение

Возвращает: bool(true) | string возвращает true в случае успеха, иначе текст ошибки

static checkPassword ( $password )

static

Возвращает true, если пароль соответствует требованиям, иначе текст ошибки

Аргументы

string $password - пароль

Возвращает: bool(true) | string

checkSiteRights ( $site_id )

Возвращает true, если у пользователя есть права на данный сайт

Аргументы

integer $site_id - ID сайта

Возвращает: bool

create ( )

Вернет true, если пользователь будет создан, В случае ошибки - false. Вызовите $this->getLastError(), чтобы увидеть текст ошибки Объект должен быть заполнен даными перед вызовом данного метода

Возвращает: bool

static cryptPass	(	$password,
		$user = `null`
	)

static

Возвращает хэш от пароля.

Аргументы

string	$password	- пароль в открытом виде
User	$user	- объект пользователя

Возвращает: string

delete ( )

Удаляет пользователя

Возвращает: bool

enableOpenPassConfirm ( )

Добавляет поле openpass_confirm, которое должно совпадать с openpass Используется при регистрации нового пользователя или в профиле, при смене пароля

enableRegistrationCheckers ( )

Включает необходимые валидаторы для режима регистрации нового пользователя с учетом текущих настроек системы

static explodeFio ( $value )

static

Разделяет ФИО на фамилию, имя и отчество Всегда возвращает данные в порядке: фамилия, имя, отчество. Если чего-то из этого нет, то будет пустая строка

Аргументы

string $value - строка с ФИО

Возвращает: string[]

getAdminMenuAccess ( )

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

Возвращает: array

getAllowSites ( )

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

Возвращает: Site[]

getAuthorizedGroup ( )

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

Возвращает: string

getBalance	(	$use_currency = `false`,
		$format = `false`
	)

Возвращает текущий остаток на лицевом счете пользователя

Аргументы

bool	$use_currency	- если true, то значение будет возвращено в текущей валюте, иначе в базовой
bool	$format	- если true, то форматировать возвращаемое значение, приписывать символ валюты

Возвращает: string

getClientSideGroups ( )

Возвращает системные группы пользователей, к которым пользователь автоматически причисляется при нахождении в клиенской части: Гость - присваивается всем пользователям, Клиент - присваивается всем авторизованным пользователям,

return UserGroup[]

getDefaultGroup ( )

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

Возвращает: string

getFio ( )

Возвращает Фамилию, имя, отчество в одну строку

Возвращает: string

getFormattedPhoneNumber ( )

Возвращает форматированный мобильный номер телефона пользователя. Если знаков в номере 10, то добавляет в начало номера стандартный код страны, который задаётся в настройках модуля

Возвращает: string

getMenuAccess ( )

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

Возвращает: array

getModuleAccess ( )

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

Возвращает: array

getRemoteAuthorizationKey ( )

Возвращает объект, описывающий ключ для удаленной авторизации. Используется для создания QR-кода

Возвращает: AuthorizationKey Объект авторизационного ключа

getRight ( $module )

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

Аргументы

string $module - название модуля

Возвращает: int 0 - нет прав, 255 - полный права

getShortFio ( )

Возращает фамилию и инициалы

Возвращает: string

getUserFields ( )

Возвращает массив с данными пользовательских полей

Возвращает: array

getUserGroups ( $returnAliases = true )

Возвращает группы, в которых состоит пользователь В ReadyScript предусмотрены системные группы пользователей, к которым пользователь автоматически причисляется при следующих условиях: Гость - присваивается всем пользователям, находящимся в клиентской части Клиент - присваивается всем авторизованным пользователям, находящимся в клиентской части

Аргументы

boolean $returnAliases - Если true, то возвращает массив с alias'ами групп, иначе array

Возвращает: string[]|UserGroup[]

inGroup ( $group_alias )

Проверяет состоит ли пользователь в группе

Аргументы

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

Возвращает: bool

isAdmin ( )

Возвращает True, если пользователь состоит в группе с отметкой "Администратор" Пользователи такой группы могут входить в административную панель.

Возвращает: bool

isSupervisor ( )

Возвращает true, если пользователь является супервизором

Возвращает: bool

linkGroup ( array $groups )

Помещает пользователя в группу

Аргументы

array $groups - массив групп в которые нужно добавить

Возвращает: void

refreshChangeDatePassword ( )

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

Возвращает: bool

saveVisitDate ( )

Обновляет дату последнего посещения в БД не чаще, чем 1 раз в 4 часа

Возвращает: void

setIgnoreClientSideGroups ( $value = true )

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

Аргументы

bool $value - значение

Возвращает: void

unlinkGroup ( $group_id = null )

Удаляет пользователя из группы $group_id или из всех групп

Аргументы

$group_id - ID группы

Возвращает: void

updateHash ( $commit = true )

Обновляет секретный хэш пользователя. Хэш используется для восстановления пароля

Аргументы

bool $commit - если true, то изменения будут сразу сохранены в базе.

Возвращает: void

Поля

$access_menu_table

protected

$access_module_table

protected

$authorized_user_group = 'clients'

protected

$cache_admin_menu_access

protected

$cache_allow_sites

protected

$cache_menu_access

protected

$cache_mod_access

protected

$default_group = 'guest'

protected

$groups = []

protected

$ignore_client_side_groups

protected

$link_to_auth_in_error

protected

$table = "users"

staticprotected

const PASSWORD_LEN = 4

const SESSION_LAST_VISIT_VAR = 'last_visit'

const SUPERVISOR_GROUP = 'supervisor'

Открытые члены

Открытые статические члены

Поля данных

Защищенные члены

Защищенные данные

Статические защищенные данные

Дополнительные унаследованные члены

Конструктор(ы)

Методы

Поля