Версия: 3.x
Класс User
Граф наследования:User:
OrmObject AbstractObject AcceptBehavior AcceptBehaviorInterface

Подробное описание

Объект - пользователь системы.

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

 __construct ($id=null, $cache=true)
 
 beforeWrite ($flag)
 
 afterWrite ($flag)
 
 afterObjectLoad ()
 
 getUserGroups ($returnAliases=true)
 
 inGroup ($groupAlias)
 
 isAdmin ()
 
 linkGroup (array $groups)
 
 addGroup ($groupid)
 
 unlinkGroup ($group_id=null)
 
 getModuleAccess ()
 
 getRight ($module)
 
 checkModuleRight ($module, $bit)
 
 getMenuAccess ()
 
 getAdminMenuAccess ()
 
 delete ()
 
 create ()
 
 checkCreateData ()
 
 getUserFields ()
 
 getUserFieldsManager ()
 
 getFio ()
 
 updateHash ($commit=true)
 
 isSupervisor ()
 
 checkSiteRights ($site_id)
 
 getAllowSites ()
 
 getBalance ($use_currency=false, $format=false)
 
 checkBalanceSign ()
 
 getDefaultGroup ()
 
 getAuthorizedGroup ()
 
 saveVisitDate ()
 
- Открытые члены унаследованные от OrmObject
 __construct ($id=null, $cache=true)
 
 getPrimaryKeyProperty ()
 
 saveInCache ($id)
 
 loadFromCache ($id)
 
- Открытые члены унаследованные от AbstractObject
 __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=array(), $on_duplicate_uniq_fields=array())
 
 update ($primaryKey=null)
 
 replace ()
 
 delete ()
 
 exists ($primaryKeyValue)
 
 getFromArray (array $data, $remove_prefix=null, $mark_modify=true)
 
 getValues ()
 
 isModified ($property)
 
 getPropertyIterator ()
 
 appendProperty (array $properties)
 
 _getTable ()
 
 _getTableArray ()
 
 getPrimaryKeyProperty ()
 
 getProperties ()
 
 getProp ($offset)
 
 save ($primaryKeyValue=null, $user_post=array(), $post_var=null, $files_var=null)
 
 replaceOn ($bool)
 
 setWriteBit ($n)
 
 usePostKeys (array $keys)
 
 excludePostKeys (array $keys)
 
 checkData ($user_post=array(), $post_var=null, $files_var=null, $usekeys=null, $exclude=null)
 
 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 ()
 
 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=array(), $view_params=array())
 
 getHiddenKeyVal ()
 
 addHiddenFields ($keys, $value=null)
 
 addDebugActions (array $actions, $local=false)
 
 addDebugAction (\RS\Debug\Action\AbstractAction $action, $local=false)
 
 getDebugAttributes ()
 
 cloneSelf ()
 
 beforeWrite ($save_flag)
 
 afterWrite ($save_flag)
 
 afterObjectLoad ()
 
 getDebugActions ()
 
 dropTable ()
 
 exportErrors ()
 
 current ()
 
 key ()
 
 next ()
 
 rewind ()
 
 valid ()
 
 __sleep ()
 
 __wakeup ()
 
 __clone ()
 
- Открытые члены унаследованные от 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, $error)
 
static cryptPass ($password)
 
static checkPassword ($password)
 
- Открытые статические члены унаследованные от OrmObject
static loadSingle ($id)
 
- Открытые статические члены унаследованные от AbstractObject
static loadByWhere ($expr, array $values=null, $prefix= 'AND', $in_prefix= 'AND')
 
static chkDepend ($coreobj, $value, $real_errtext, $real_chk, array $conditions, $real_params=array())
 
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'
 
 $authorized_user_group = 'clients'
 
 $access_menu_table
 
 $access_module_table
 
 $cache_cost_id
 
 $cache_mod_access
 
 $cache_menu_access
 
 $cache_admin_menu_access
 
 $cache_allow_sites
 
- Поля данных унаследованные от 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'
 
 $_self_class
 
 $_local_id
 
- Поля данных унаследованные от AcceptBehavior
 $class_behaviors = array()
 
 $cache_behavior_instances = array()
 
 $instance_behaviors = array()
 

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

 _init ()
 
- Защищенные члены унаследованные от OrmObject
 _init ()
 
- Защищенные члены унаследованные от AbstractObject
 initProperties ()
 
 _init ()
 
 _initDefaults ()
 
 afterInit ()
 
 getStorageInstance ()
 
 _tableName ($with_quotes=true)
 
 getPropertyHash ($is_multiedit, $switch=null)
 

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

 $default_group = 'guest'
 
 $groups
 
- Защищенные данные унаследованные от AbstractObject
 $_values = array()
 

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

static $table = "users"
 
- Статические защищенные данные унаследованные от OrmObject
static $self_singleton_cache = array()
 
- Статические защищенные данные унаследованные от AbstractObject
static $db = DB_NAME
 

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

- Статические открытые данные унаследованные от OrmObject
static $self_cache = array()
 
- Статические открытые данные унаследованные от AbstractObject
static $table = null
 
static $iterator = 0
 
static $init_default_method = '_initDefaults'
 
static $local = array()
 
static $default_local_parameters
 
static $class = array()
 
static $default_class_parameters
 
- Защищенные статические члены унаследованные от OrmObject
static getIdHash ($id)
 

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

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

Методы

_init ( )
protected
addGroup (   $groupid)

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

Аргументы
string$groupid- алиас группы
Возвращает
void
afterObjectLoad ( )

После того как подгружен объект

afterWrite (   $flag)

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

Аргументы
string$flag- insert или update
beforeWrite (   $flag)

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

Аргументы
string$flag- insert или update
checkBalanceSign ( )

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

Возвращает
bool
checkCreateData ( )

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

checkModuleRight (   $module,
  $bit 
)

Проверяет, включен ли нужный бит в правах доступа к модулю.

Аргументы
integer$bit- от 0 до 7.
Возвращает
bool;
static checkOpenPassword (   $_this,
  $value,
  $error 
)
static

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

Аргументы
User$_this- проверяемый ORM - объект
mixed$value- проверяемое значение
string$error- текст ошибки
Возвращает
bool(true) | string возвращает true в случае успеха, иначе текст ошибки
static checkPassword (   $password)
static

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

Возвращает
bool(true) | string
checkSiteRights (   $site_id)

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

Аргументы
integer$site_id- ID сайта
Возвращает
bool
create ( )

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

static cryptPass (   $password)
static

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

Аргументы
string$password- пароль в открытом виде
Возвращает
string
delete ( )

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

Возвращает
bool
getAdminMenuAccess ( )

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

Возвращает
array
getAllowSites ( )

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

Возвращает
array of
getAuthorizedGroup ( )

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

Возвращает
string
getBalance (   $use_currency = false,
  $format = false 
)

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

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

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

Возвращает
string
getFio ( )

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

Возвращает
string
getMenuAccess ( )

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

Возвращает
array
getModuleAccess ( )

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

Возвращает
array
getRight (   $module)

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

Аргументы
string$module- название модуля
Возвращает
int 0 - нет прав, 255 - полный права
getUserFields ( )

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

Возвращает
array
getUserFieldsManager ( )

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

Возвращает
getUserGroups (   $returnAliases = true)

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

Аргументы
boolean$returnAliases- Если true, то возвращает массив с alias'ами групп, иначе array
Возвращает
array
inGroup (   $groupAlias)

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

Возвращает
bool
isAdmin ( )

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

Возвращает
bool
isSupervisor ( )

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

Возвращает
bool
linkGroup ( array  $groups)

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

Аргументы
array$groups- массив групп в которые нужно добавить
Возвращает
void
saveVisitDate ( )

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

Возвращает
bool
unlinkGroup (   $group_id = null)

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

Аргументы
$group_id- ID группы
Возвращает
void
updateHash (   $commit = true)

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

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

Поля

$access_menu_table
$access_module_table
$authorized_user_group = 'clients'
$cache_admin_menu_access
$cache_allow_sites
$cache_cost_id
$cache_menu_access
$cache_mod_access
$default_group = 'guest'
protected
$groups
protected
$table = "users"
staticprotected
const PASSWORD_LEN = 4
const SESSION_LAST_VISIT_VAR = 'last_visit'
const SUPERVISOR_GROUP = 'supervisor'