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

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

 _init ()
 
 getAuthVisibleFields ()
 
 getAuthRequireFields ()
 
 getAuthLoginFields ()
 
 getUserFieldName ($field)
 
 beforeWrite ($flag)
 
 getDoublesError ($with_empty=false)
 
 hasUnableLoginError ()
 
 getUserFieldsManager ()
 
 isEnabledTwoFactorAuthorization ($user)
 
 isPhoneAuth ()
 
 fieldIsLogin (string $field)
 
 fieldIsRequire (string $field)
 
 canShowField (string $field)
 
 isEnabledTwoFactorRegister ()
 
 getAuthorizationUrl ($additional_params=[], $absolute=false)
 
- Открытые члены унаследованные от ConfigObject
 _init ()
 
 beforeWrite ($flag)
 
 afterWrite ($flag)
 
 getPrimaryKeyProperty ()
 
 getStorageInstance ()
 
 _configInitDefaults ()
 
 load ($site_id=null)
 
 loadFromCache ($site_id=null)
 
 isLicenseUpdateExpired ()
 
 getLicenseData ()
 
 getModuleStorageDir ()
 
 isMultisiteConfig ()
 
 getModuleRightObject ()
 
 isActive ()
 
 getModuleId ()
 
- Открытые члены унаследованные от 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 getDefaultValues ()
 
static checkDuplicateUserByField ($field, $with_empty=true)
 
- Открытые статические члены унаследованные от ConfigObject
static getDefaultValues ()
 
- Открытые статические члены унаследованные от 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 TYPE_AUTH_STANDARD = 0
 
const TYPE_AUTH_2AUTH = 1
 
const TYPE_AUTH_PHONE = 2
 
const TWO_FACTOR_AUTH_NO = 0
 
const TWO_FACTOR_AUTH_SOME_USER = 1
 
const TWO_FACTOR_AUTH_ALWAYS = 2
 
const MIN_SMS_CODE_LENGTH = 4
 
const MAX_SMS_CODE_LENGTH = 8
 
- Поля данных унаследованные от ConfigObject
const CACHE_TAG = 'config_cache'
 
const ACCESS_BIT_READ = 0
 
const ACCESS_BIT_WRITE = 1
 
- Поля данных унаследованные от 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 = []
 

Статические открытые данные

static $access_system_version = 4
 
- Статические открытые данные унаследованные от ConfigObject
static $table = 'module_config'
 

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

- Защищенные члены унаследованные от AbstractObject
 initProperties ()
 
 _init ()
 
 _initDefaults ()
 
 afterInit ()
 
 getStorageInstance ()
 
 getTableEngine ()
 
 getPropertyHash ($is_multiedit, $switch=null)
 
- Защищенные статические члены унаследованные от AbstractObject
static _tableName ($with_quotes=true)
 
static _dbName ($with_quotes=true)
 
- Защищенные данные унаследованные от AbstractObject
 $_values = []
 
 $_self_class
 
 $_local_id
 
- Статические защищенные данные унаследованные от ConfigObject
static $init_default_method = '_configInitDefaults'
 
- Статические защищенные данные унаследованные от 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
 

Методы

_init ( )
beforeWrite (   $flag)

Обработчик события перед записью объекта

Аргументы
$flag
Возвращает
bool|false|void|null
canShowField ( string  $field)

Возвращает true, если можно показать поле $field

Аргументы
$field
Возвращает
bool
static checkDuplicateUserByField (   $field,
  $with_empty = true 
)
static

Проверка на дубли в полях авторизации

Аргументы
$field
bool$with_empty
Возвращает
array
fieldIsLogin ( string  $field)

Возвращает true, если можно авторизоваться по полю $field

Аргументы
$field
Возвращает
bool
fieldIsRequire ( string  $field)

Возвращает true, если поле $field является обязательным

Аргументы
string$field
Возвращает
bool
getAuthLoginFields ( )

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

Возвращает
string[]
getAuthorizationUrl (   $additional_params = [],
  $absolute = false 
)

Возвращает URL для авторизации с учетом параметров системы

Аргументы
array$additional_paramsДополнительные параметры, которые нужн одобавить к URL
bool$absolute
Возвращает
string
getAuthRequireFields ( )

Поля, заполнение которых обязательно при регистрации пользователя и в профиле

getAuthVisibleFields ( )

Поля, которые следует отображать при регистрации пользователя и в профиле

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

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

Возвращает
array
Исключения
RS
RS

Замещает ConfigInterface.

getDoublesError (   $with_empty = false)

Возвращает массив вида [alias_поля] => title_поля, в котором содержится информация о полях, которые у пользователей дублируются

Аргументы
bool$with_empty
Возвращает
array
getUserFieldName (   $field)

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

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

Возвращает объект, отвечающий за работу с пользовательскими полями.

Возвращает
hasUnableLoginError ( )

Возвращает массив вида [alias_поля] => title_поля, если при текущих настройках авторизации кто-то не сможет авторизоваться

Возвращает
bool
isEnabledTwoFactorAuthorization (   $user)

Возвращает true, если пользователю надо пройти второй этап авторизации

Аргументы
$user
Возвращает
bool
isEnabledTwoFactorRegister ( )

Возвращает true, если требуется подтверждение телефона при регистрации

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

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

Возвращает
bool

Поля

$access_system_version = 4
static
const MAX_SMS_CODE_LENGTH = 8
const MIN_SMS_CODE_LENGTH = 4
const TWO_FACTOR_AUTH_ALWAYS = 2
const TWO_FACTOR_AUTH_NO = 0
const TWO_FACTOR_AUTH_SOME_USER = 1
const TYPE_AUTH_2AUTH = 1
const TYPE_AUTH_PHONE = 2
const TYPE_AUTH_STANDARD = 0