Версия: 6.x
burger close
Класс AbstractPreset
Граф наследования:AbstractPreset:
Cost DirProperty DirPropertyList DirUrl Files MultiOffers OfferPhotos OfferStock ProductUrl Property PropertyId StockCost ObjectColumns CustomFields Links LinksReverse Base Catalog PhotoBlock Property GeoPoint LangPhrase Base LinkedTable ManyToMany ManyTreeParent PhotoBlock ProductsSerialized SerializedArray SinglePhoto Tags TreeParent OrderProducts OrderWeight Cost Groups Purchases

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

Абстрактный класс набора колонок(preset'а). Во время экспорта данных пресеты получают управление по очереди, описываемой в схеме, слева-направо. Каждый пресет формирует массив с колонками для одной строки данных. Во время импорта данных пресеты получают управление в обратном порядке - справа-налево, выполняя определенное действие по импорту или подготовке для импорта сведений. У каждого пресета всегад присутствует ссылка на общую CSV схему (AbstractSchema $schema), благодаря чему пресеты могут обращаться к другим пресетам.

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

 __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 ()
 

Поля данных

 $rows
 
 $row
 

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

 $id
 
 $schema
 
 $fields_map
 
 $before_import_callback
 
 $after_import_callback
 
 $before_row_export_callback
 
 $option_prefixes = ['set', 'add']
 

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

__construct (   $options)

Методы

afterRowImport ( )

Данный метод вызывается после того, как строка импортирована

beforeRowExport (   $row_index)

Данный метод вызывается перед тем, как строка будет экспортирована

Аргументы
int$row_index- индекс строки
Возвращает
void
beforeRowImport ( )

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

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

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

Возвращает
array
getColumnsData (   $n)
abstract

Возвращает ассоциативный массив с одной строкой данных, где ключ - это id колонки, а значение - это содержимое ячейки

Аргументы
integer$n- индекс в наборе строк $this->rows
Возвращает
array
getMappedField (   $field)

Возвращает имя поля с учетом его переназначения

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

Возвращает текущую схему

Возвращает
hasMap (   $field)

Возвращает true, если существуют правила для переназначения свойств для поля $field

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

Импортирует одну строку данных

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

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

Возвращает
void
setAfterRowImport (   $callback)

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

Аргументы
callback$callback
Возвращает
static
setBeforeRowExportCallback (   $callback)

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

Аргументы
callback$callback
Возвращает
static
setBeforeRowImport (   $callback)

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

Аргументы
callback$callback
Возвращает
static
setFieldsMap ( array  $map)

Устанавливает переназначение свойств для импорта данных

Аргументы
array$mapмассив, где ключ - это имя поля из выборки, а значение - это реальное имя колонки у текущего объекта пресета
Возвращает
static
setId (   $id)

Устанавливает внутренний ID для пресета

Аргументы
int$id- номер пресета
Возвращает
AbstractPreset
setSchema ( AbstractSchema  $schema)

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

Аргументы
\RS\Csv\AbstractSchema$schema
Возвращает
AbstractPreset

Поля

$after_import_callback
protected
$before_import_callback
protected
$before_row_export_callback
protected
$fields_map
protected
$id
protected
$option_prefixes = ['set', 'add']
protected
$row
$rows
$schema
protected