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

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

Базовый core объект для конфигурационных файлов модулей

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

 _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 ()
 
 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 ()
 
- Открытые статические члены унаследованные от 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 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 $table = 'module_config'
 

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

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
 

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

- Защищенные члены унаследованные от AbstractObject
 initProperties ()
 
 _init ()
 
 _initDefaults ()
 
 afterInit ()
 
 getStorageInstance ()
 
 getPropertyHash ($is_multiedit, $switch=null)
 
- Защищенные статические члены унаследованные от AbstractObject
static _tableName ($with_quotes=true)
 
static _dbName ($with_quotes=true)
 
- Защищенные данные унаследованные от AbstractObject
 $_values = []
 
 $_self_class
 
 $_local_id
 

Методы

_configInitDefaults ( )

Метод инициализирует значения по умолчанию

Возвращает
void
Исключения
ModuleException
_init ( )

Объявляет стандартные поля у объектов

Возвращает
PropertyIterator

core_version Например: '0.1.0.0' (одна версия) или '0.1.0.0 - 0.2.0.0' (Диапазон версий) или '>=0.1.0.156' или '<=0.1.0.200' (для всех версий младше или старше требуемой) Можно указать смешанно, через запятую так: '<=0.1.0.200, 0.2.0.0 - 0.3.0.0, 1.0.0.0, 1.1.0.0'

afterWrite (   $flag)
beforeWrite (   $flag)
static getDefaultValues ( )
static

Загружает значения свойств по-умолчанию из файла module.xml При перегрузке данного метода, обязательно вызывайте родительский метод

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

Замещает ConfigInterface.

getLicenseData ( )

Возвращает сохранённые данные по лицензии на модуль

Возвращает
array|null
Исключения
DbException
RSException
EventException
getModuleId ( )

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

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

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

Возвращает
AbstractModuleRights
getModuleStorageDir ( )

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

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

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

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

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

Возвращает
Storage|StorageSerialized
isActive ( )

Возвращает активен ли модуль

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

Возвращает true если у лицензии на данный модуль истёк период обновлений

Возвращает
bool
Исключения
DbException
RSException
EventException
isMultisiteConfig ( )

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

Возвращает
bool
load (   $site_id = null)

Загружает объект из базы данных

Аргументы
integer$site_idID сайта
Возвращает
bool
loadFromCache (   $site_id = null)

Загружает объект из кэша, если не удается, то из БД

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

Поля

$init_default_method = '_configInitDefaults'
staticprotected
$table = 'module_config'
static
const ACCESS_BIT_READ = 0
const ACCESS_BIT_WRITE = 1
const CACHE_TAG = 'config_cache'