Версия: 6.x
burger close
Класс Api
Граф наследования:Api:
BaseModel

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

 getBaseDir ()
 
 clearExchangeDirectory ($type= 'import')
 
 isExchangeDirectoryEmpty ()
 
 saveUploadedFile ($filename, $filedata, $type= 'import')
 
 catalogImport ($filename, $offset, $max_exec_time=0)
 
 saleImport ($filename, $offset=0, $max_exec_time=0)
 
 createSalesXML (array $statuses)
 
 orderToXml (Order $order=null)
 
 extractAllArchives ($type= 'import')
 
 extractArchive ($zip_filename, $dir_to)
 
 getDir ($type= 'import', $history_dir=false)
 
 updateBrandsFromProperties ()
 
- Открытые члены унаследованные от BaseModel
 addError ($message, $fieldname=null, $form=null)
 
 hasError ()
 
 getErrors ()
 
 cleanErrors ()
 
 getDisplayErrors ()
 
 getErrorsStr ()
 
 getFormErrors ($form, $separator= ', ')
 
 getNonFormErrors ($separator= ', ')
 
 exportErrors ()
 
 importErrors ($data)
 

Открытые статические члены

static getInstance ()
 
static isZipAvailable ()
 
static getLastExchangeDate ($site_id=null)
 
static setLastExchangeDate ($site_id)
 
static getUpdatableProductFields ($exclude_exceptions=false)
 
static getUpdatableOfferFields ($exclude_exceptions=false)
 
static getUpdatableGroupFields ($exclude_exceptions=false)
 
static getUpdatablePropFields ($exclude_exceptions=false)
 
static getSessionFileName ()
 
static getSessionId ()
 
static saveSessionIdIntoFile ()
 
static checkSessionFile ()
 
static removeSessionIdFile ()
 

Поля данных

const LAST_EXCHANGE_DATE_KEY = 'last_exchange_date'
 
- Поля данных унаследованные от BaseModel
 $form_fieldname = []
 
 $errors_by_form = []
 
 $errors_non_form = []
 
 $errors = []
 

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

static $session_file = "session.lock"
 

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

 $log
 
- Защищенные данные унаследованные от BaseModel
 $default_error_fieldname = 'Информация'
 

Методы

catalogImport (   $filename,
  $offset,
  $max_exec_time = 0 
)

Импортировать XML-файл каталога товаров (offers.xml или import.xml)

Аргументы
mixed$filenameИмя XML-файла
mixed$offsetСмещение в файле для импорта в xml-нодах
mixed$max_exec_timeМаксимальное время выполнения в секундах
Возвращает
boolean
Исключения
EventException
RSException
static checkSessionFile ( )
static

Проверяет наличие сессионного файла

clearExchangeDirectory (   $type = 'import')

Очистка папки для импорта/экспорта

Аргументы
string$type- тип файлов
Возвращает
void
createSalesXML ( array  $statuses)

Создать XML со списком заказов

Аргументы
mixed$statuses
Возвращает
string
Исключения
DbException
RSException
OrmException
extractAllArchives (   $type = 'import')

Распаковать все архивы в папке импорта

Возвращает
void
extractArchive (   $zip_filename,
  $dir_to 
)

Распаковать архив папке импорта. Возвращает список имен распакованных файлов

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

Получить корневую дерикторию модуля для хранения файлов

Возвращает
string
getDir (   $type = 'import',
  $history_dir = false 
)

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

Аргументы
string$type- тип файлов
bool$history_dir- вернуть ссылку на папку "истории"
Возвращает
string
static getInstance ( )
static
static getLastExchangeDate (   $site_id = null)
static

Получить дату последнего обмена данными

Аргументы
integer$site_idID сайта. Если null, То текущий
Возвращает
string
static getSessionFileName ( )
static

Получает имя текущего файла с сессионным id

static getSessionId ( )
static

Получает id текущей сессии из файла или из текущей сессии

static getUpdatableGroupFields (   $exclude_exceptions = false)
static

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

Аргументы
bool$exclude_exceptionsИсключая поля, указанные как "не обновлять" в настройках модуля
Возвращает
array
Исключения
RSException
static getUpdatableOfferFields (   $exclude_exceptions = false)
static

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

Аргументы
bool$exclude_exceptionsИсключая поля, указанные как "не обновлять" в настройках модуля
Возвращает
array
Исключения
RSException
static getUpdatableProductFields (   $exclude_exceptions = false)
static

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

Аргументы
bool$exclude_exceptionsИсключая поля, указанные как "не обновлять" в настройках модуля
Возвращает
array
Исключения
RSException
static getUpdatablePropFields (   $exclude_exceptions = false)
static

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

Аргументы
bool$exclude_exceptionsИсключая поля, указанные как "не обновлять" в настройках модуля
Возвращает
array
Исключения
RSException
isExchangeDirectoryEmpty ( )

Является ли папка для импорта пустой

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

Доступно ли сжатие ZIP в системе

Возвращает
bool
orderToXml ( Order  $order = null)

Преобразовать один заказ в XML. Возвращает SimpleXMLElement

Аргументы
Order$order
Возвращает
Исключения
DbException
RSException
OrmException
static removeSessionIdFile ( )
static

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

saleImport (   $filename,
  $offset = 0,
  $max_exec_time = 0 
)

Импортировать заказы

Аргументы
$filename
$offset
int$max_exec_time
Возвращает
boolean
Исключения
RSException
static saveSessionIdIntoFile ( )
static

Сохраняет идентификатор сессии в файл

saveUploadedFile (   $filename,
  $filedata,
  $type = 'import' 
)

Сохранить файл в папку для импорта

Аргументы
string$filenameИмя файла
string$filedataСодержимое файла
string$type- тип файлов
Возвращает
void
static setLastExchangeDate (   $site_id)
static

Установить дату последнего обмена данными

Аргументы
integer$site_idID текущего сайта
Возвращает
void
updateBrandsFromProperties ( )

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

Поля

$log
protected
$session_file = "session.lock"
static
const LAST_EXCHANGE_DATE_KEY = 'last_exchange_date'