Версия: 6.x
burger close
Класс VerificationSession
Граф наследования:VerificationSession:
AbstractObject AcceptBehavior AcceptBehaviorInterface

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

 __construct ()
 
 getCreatorUser ()
 
 isResolved ()
 
 isExpired ()
 
 getActionData ()
 
 getAction ()
 
 setActionData (array $data)
 
 getPrimaryKeyProperty ()
 
 getToken ()
 
 getRefreshCodeDelay ()
 
 generateCode ()
 
 setNewCode ($code)
 
 getCodeHash ($code)
 
 canEnterCode ()
 
 getMaxCodeEnterLimit ()
 
 getMaxSendLimit ()
 
 isIpSessionLimit ()
 
 sendVerificationCode ()
 
 checkCodeAndResolve ($code)
 
 checkVerificationCode ($code)
 
 formatSecond ($second)
 
 getPhoneMask ()
 
 getSendTryRemain ()
 
 getCodeLength ()
 
 getState ()
 
 reset ()
 
- Открытые члены унаследованные от 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)
 

Поля данных

const STATE_INITIALIZED = 'initialized'
 
const STATE_CODE_ENTER = 'codeEnter'
 
const STATE_RESOLVED = 'resolved'
 
- Поля данных унаследованные от 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 ()
 
- Защищенные члены унаследованные от AbstractObject
 initProperties ()
 
 _init ()
 
 _initDefaults ()
 
 afterInit ()
 
 getStorageInstance ()
 
 getTableEngine ()
 
 getPropertyHash ($is_multiedit, $switch=null)
 

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

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

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

static $table = 'users_verification_session'
 
- Статические защищенные данные унаследованные от 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
 

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

- Открытые статические члены унаследованные от 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)
 
- Защищенные статические члены унаследованные от AbstractObject
static _tableName ($with_quotes=true)
 
static _dbName ($with_quotes=true)
 

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

__construct ( )

Методы

_init ( )
protected

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

canEnterCode ( )

Возвращает true, если еще не истекло время ввода кода

Возвращает
bool
checkCodeAndResolve (   $code)

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

Аргументы
$code
Возвращает
bool(false) | mixed
checkVerificationCode (   $code)

Возвращает true, если проверка кода прошла успешно

Аргументы
string$codeкод верификации
Возвращает
bool
formatSecond (   $second)

Форматирует количество секунд

Аргументы
integer$second
Возвращает
string
generateCode ( )

Генерирует новый код верификации для отправки

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

Возвращает объект действия, которое будет вызвано, в случае успешной верификации кода

Аргументы
bool$cache
Возвращает
AbstractVerifyAction
Исключения
VerificationException
getActionData ( )

Устанавливает данные для действия

Возвращает
array
getCodeHash (   $code)

Возвращает хэш от кода

Аргументы
string$code
Возвращает
string
getCodeLength ( )

Возвращает длину кода верификации

Возвращает
integer
getCreatorUser ( )

Возвращает объект пользователя

Возвращает
User
getMaxCodeEnterLimit ( )

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

Возвращает
integer
getMaxSendLimit ( )

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

Возвращает
integer
getPhoneMask ( )

Возвращает номер телефона с пропусками в виде звездочек

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

Возвращает первичный ключ объекта

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

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

Возвращает
integer
getSendTryRemain ( )

Возвращает количество оставшихся попыток отправки кода

Возвращает
integer
getState ( )

Возвращает текущий статус верификации.

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

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

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

Возвращает true, если сессия верификации была инициализирована слишком давно и уже протухла

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

Возвращает true, если превышен лимит на количество созданных, не верифицированных сессий с одного IP

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

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

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

Сбрасывает флаг подтверждения у сессии

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

Отправляет код верификации

Возвращает
bool
Исключения
Exception
setActionData ( array  $data)

Возвращает данные для действия

Аргументы
array$data
setNewCode (   $code)

Устанавливает новый код верификации

Аргументы
$code

Поля

$config
protected
$table = 'users_verification_session'
staticprotected
const STATE_CODE_ENTER = 'codeEnter'
const STATE_INITIALIZED = 'initialized'
const STATE_RESOLVED = 'resolved'