Версия: 6.x
burger close
Класс Base
Граф наследования:Base:
AbstractPreset JoinedColumns Offer SimplePriceStockBase OrderItemsBase

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

Добавляет к экспорту колонки соответствующие свойствам ORM объекта. Самый простой набор колонок. В качестве названия колонок выступают названия свойств Orm объекта

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

 setReplaceMode ($bool)
 
 setExtraFields ($fields)
 
 setSavedRequest ($request)
 
 setIdFIeld ($field)
 
 setNullFields (array $fields)
 
 loadData ()
 
 getColumnsData ($n)
 
 importColumnsData ()
 
 getColumns ()
 
 setTitles (array $titles)
 
 setFields (array $fields)
 
 getExcludeFields ()
 
 setExcludeFields ($fields)
 
 getFields ()
 
 setLoadExpression ($expr)
 
 setMultisite ($bool)
 
 getMultisiteExpr ()
 
 setSearchFields (array $fields)
 
 getSearchExpr ()
 
 setOrmObject (AbstractObject $orm_object)
 
 getOrmObject ()
 
 loadObject ()
 
 getSelectRequest ()
 
 setSelectOrder ($order)
 
 setSelectRequest (OrmRequest $q)
 
 setCustomHtmlEncodedFields ($fields)
 
 getCustomHtmlEncodedFields ()
 
 getHtmlEncodedFields ()
 
- Открытые члены унаследованные от AbstractPreset
 __construct ($options)
 
 getColumnsData ($n)
 
 importColumnsData ()
 
 getColumns ()
 
 setSchema (AbstractSchema $schema)
 
 getSchema ()
 
 beforeRowImport ()
 
 beforeRowExport ($row_index)
 
 afterRowImport ()
 
 setBeforeRowImport ($callback)
 
 setAfterRowImport ($callback)
 
 setBeforeRowExportCallback ($callback)
 
 setId ($id)
 
 setFieldsMap (array $map)
 
 hasMap ($field)
 
 getMappedField ($field)
 
 loadData ()
 

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

 $fields = []
 
 $select_request
 
 $id_field = 'id'
 
 $saved_request = null
 
 $select_order
 
 $exclude_fields = []
 
 $extra_fields = []
 
 $titles = []
 
 $search_fields = []
 
 $load_expression
 
 $is_multisite = false
 
 $use_cache = true
 
 $cache = []
 
 $null_fields = []
 
 $replace_mode = false
 
 $use_temporary_id
 
 $uniq_fields
 
 $custom_html_encoded_field
 
 $orm_object
 
- Защищенные данные унаследованные от AbstractPreset
 $id
 
 $schema
 
 $fields_map
 
 $before_import_callback
 
 $after_import_callback
 
 $before_row_export_callback
 
 $option_prefixes = ['set', 'add']
 

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

- Поля данных унаследованные от AbstractPreset
 $rows
 
 $row
 

Методы

getColumns ( )

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

getColumnsData (   $n)

Возвращает данные для вывода в CSV

Аргументы
int$n- индекс строки
Возвращает
string[]
getCustomHtmlEncodedFields ( )

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

Возвращает
mixed
getExcludeFields ( )

Возвращает какие поля следует исключить из выгрузки

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

Возвращает поля, которые будут участвовать в выгрузке

getHtmlEncodedFields ( )

Если не заданы кодируемые поля, то вернет их по базовому алгоритму из ORM-объектов

Возвращает
mixed
getMultisiteExpr ( )

Возвращает условие для добавления к Where, если установлено свойство multisite => true

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

Возвращает объект, связанный с данным набором колонок

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

Возвращает массив c условиями для поиска

Возвращает
array | null
getSelectRequest ( )

Возвращает объект Orm для стартовой выборки элементов

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

Импортирует данные одной строки текущего пресета в базу

Возвращает
void
loadData ( )

Загружает данные перед экспортом

Возвращает
void
loadObject ( )

Загружает объект из базы по имеющимся данным в row или возвращает false

Возвращает
|bool
setCustomHtmlEncodedFields (   $fields)

Устанавливает кодируемые поля в пресете

Аргументы
$fields
setExcludeFields (   $fields)

Устанавливает какие поля следует исключить из выгрузки

Аргументы
array$fields
Возвращает
void
setExtraFields (   $fields)

Устнавливает поля объекта которые будут показываться несмотря на то, runtime они или не видимые

Аргументы
array$fields- массив экстра полей
setFields ( array  $fields)

Устанавливает свойства, которые должны появиться в экспорте

Аргументы
array$fields
setIdFIeld (   $field)

Указывает какое поле является уникальным идентификатором объекта

Аргументы
mixed$field
setLoadExpression (   $expr)

Устанавливает дополнительное условие для поиска уже имеющегося элемента в базе во время импорта.

Аргументы
array  |  string$expr
Возвращает
void
setMultisite (   $bool)

Добавляет дополнительное условие в виде site_id = ТЕКУЩИЙ САЙТ, если задано true

Аргументы
bool$bool
Возвращает
void
setNullFields ( array  $fields)

Устанавливает колонки, которые в случае пустоты будут записаны в базу как NULL

Аргументы
mixed$fields
setOrmObject ( AbstractObject  $orm_object)

Устанавливает объект, связанный с данным набором колонок

Аргументы
mixed$orm_object
setReplaceMode (   $bool)

Устанавливает использовать ли REPLACE вместо INSERT и UPDATE, при вставке в базу

Аргументы
bool$bool
Возвращает
void
setSavedRequest (   $request)

Устнавливает запрос, который был взят из сессии с установленными параметрами просмотра списка

Аргументы
\RS\Orm\Request | null$request- объект из сессии
setSearchFields ( array  $fields)

Поля для поиска

Аргументы
array$fields
Возвращает
void
setSelectOrder (   $order)

Устанавливает порядок сортировки выборки для выгрузки

Аргументы
string$order- сортировка выборки
Возвращает
AbstractPreset
setSelectRequest ( OrmRequest  $q)

Устанавливает объект запроса для стартовой выборки

Аргументы
\RS\Orm\Request$q
Возвращает
self
setTitles ( array  $titles)

Устанавливает пользовательские названия для колонок

Аргументы
array$titles
Возвращает
void

Поля

$cache = []
protected
$custom_html_encoded_field
protected
$exclude_fields = []
protected
$extra_fields = []
protected
$fields = []
protected
$id_field = 'id'
protected
$is_multisite = false
protected
$load_expression
protected
$null_fields = []
protected
$orm_object
protected
$replace_mode = false
protected
$saved_request = null
protected
$search_fields = []
protected
$select_order
protected
$select_request
protected
$titles = []
protected
$uniq_fields
protected
$use_cache = true
protected
$use_temporary_id
protected