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

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

 __construct ()
 
 printExportedData (ExportProfile $profile)
 
 getTypes ()
 
 getObjectByAliasAndType ($class, $alias, $site_id)
 
 setFilterExchangableByApi ()
 
 planExchange (ExportProfile $profile)
 
 isPlannedExchange (ExportProfile $profile)
 
 endPlane ($profile)
 
 markAllToExport ()
 
- Открытые члены унаследованные от EntityList
 __construct (AbstractObject $orm_element, array $options=[])
 
 setDefaultOrder ($order)
 
 getNameField ()
 
 setNameField ($field)
 
 setAliasField ($field)
 
 setSortField ($field)
 
 setIdField ($field)
 
 getIdField ()
 
 getSiteIdField ()
 
 setLoadOnDelete ($bool)
 
 setSiteContext ($site_id=null)
 
 getSiteContext ()
 
 setMultisite ($bool)
 
 isMultisite ()
 
 resetQueryObject ()
 
 getCleanQueryObject ()
 
 queryObj ()
 
 setQueryObj (\RS\Orm\Request $q)
 
 defAlias ()
 
 setFilter ($key, $value=null, $type= '=', $prefix= 'AND', array $options=[])
 
 clearFilter ()
 
 getList ($page=null, $page_size=null, $order=null)
 
 getListAsArray ($page=0, $page_size=0, $order= '')
 
 getListAsResource ($page=0, $page_size=0, $order= '')
 
 getPagedList ($page_size)
 
 loadAssocList ($key_field, $value=null)
 
 getAssocList ($key_field, $value=null)
 
 setOrder ($order=null, array $values=null)
 
 setGroup ($group=null)
 
 getListCount ()
 
 getFirst ()
 
 getOneItem ($id)
 
 getById ($id, $request=null)
 
 getElement ()
 
 setElement ($object)
 
 getElementClass ()
 
 getNewElement ()
 
 save ($id=null, array $user_post=[])
 
 addFilterControl (\RS\Html\Filter\Control $filter_control)
 
 addTableControl (\RS\Html\Table\Control $table_control)
 
 del (array $ids)
 
 multiDelete ($ids)
 
 getSelectList ($first=[])
 
 multieditFormView ($tpl_path, $formfile, array $addparam=[])
 
 multiUpdate (array $data, $ids=[])
 
 moveElement ($from, $to, $flag,\RS\Orm\Request $extra_expr=null)
 
 noWriteRights ($right=DefaultModuleRights::RIGHT_UPDATE)
 
 getIdByAlias ($alias_or_id, $alias_field=null)
 
 saveRequest ($key)
 
 getIdsByRequest (\RS\Orm\Request $request)
 
- Открытые члены унаследованные от BaseModel
 addError ($message, $fieldname=null, $form=null)
 
 hasError ()
 
 getErrors ()
 
 cleanErrors ()
 
 getDisplayErrors ()
 
 getErrorsStr ()
 
 getFormErrors ($form, $separator= ', ')
 
 getNonFormErrors ($separator= ', ')
 
 exportErrors ()
 
 importErrors ($data)
 

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

static getTypesAssoc ()
 
static getTypeByShortName ($name)
 
static highlightLogData ($text)
 
- Открытые статические члены унаследованные от EntityList
static getInstance ($key= 'default')
 
static staticSelectList ($first=[])
 
static getSavedRequest ($key, $default=null)
 

Поля данных

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

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

static $types
 

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

- Защищенные члены унаследованные от EntityList
 parseArrayFilter ($filters)
 
 filterLike ($key, $value, $type, $prefix, $options)
 
 filterIs ($key, $value, $type, $prefix, $options)
 
 filterFullText ($key, $value, $type, $prefix, $options)
 
 filterIn ($key, $value, $type, $prefix, $options)
 
 filterNotin ($key, $value, $type, $prefix, $options)
 
 filterDefault ($key, $value, $type, $prefix, $options)
 
 setPage ($page, $pageSize)
 
 moveArrayUp ($arr)
 
 moveArrayDown ($arr)
 
- Защищенные данные унаследованные от EntityList
 $default_order
 
 $load_on_delete = false
 
 $id_field = 'id'
 
 $alias_field
 
 $sort_field
 
 $name_field
 
 $site_id_field = 'site_id'
 
 $is_multisite = false
 
 $site_context
 
 $def_table_alias = 'A'
 
 $obj
 
 $obj_instance
 
 $filter_active = false
 
 $multiedit_template = '%system%/coreobject/multiedit_form.tpl'
 
 $assocPlainList = []
 
 $parsePrefixes = ['&' => 'AND'
 
 $q
 
- Защищенные данные унаследованные от BaseModel
 $default_error_fieldname = 'Информация'
 
- Статические защищенные данные унаследованные от EntityList
static $instance = []
 

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

__construct ( )

Методы

endPlane (   $profile)

Удаляет профиль экспорта с очереди на экспорт

Аргументы
$profile_id
null$site_id
getObjectByAliasAndType (   $class,
  $alias,
  $site_id 
)

Возвращает объект экспорта по типа класса и идентификатору

Аргументы
string$class- класс типа объекта
string$alias- идентификатор или alias
integer$site_id- id сайта
Возвращает
ExportProfile|false
Исключения
OrmException
static getTypeByShortName (   $name)
static

Возвращает объект экспорта доставки по идентификатору

Аргументы
string$name- имя типа
Возвращает
AbstractExportType|null
Исключения
Exception
getTypes ( )

Возвращает объекты типов экспорта

Возвращает
AbstractExportType[]
Исключения
EventException
Exception
static getTypesAssoc ( )
static

Возвращает массив ключ => название типа

Возвращает
array
Исключения
Exception
static highlightLogData (   $text)
static
Аргументы
$text
isPlannedExchange ( ExportProfile  $profile)

Проверяет, нужно ли экспортировать товары этого профиля

Аргументы
$profile_id
null$site_id
Возвращает
string
markAllToExport ( )

Отмечает все ранее выгруженные товары для обновления

Возвращает
integer
planExchange ( ExportProfile  $profile)

Отправляет в хеш-стор отметку о том, что нужно начать экспорт по API

Аргументы
integer$profile_id
null$site_id
Возвращает
bool
printExportedData ( ExportProfile  $profile)

Получить экспортированные данные для данного профиля Кеширует результат в файле

Аргументы
ExportProfile$profile
Возвращает
void
Исключения
\Exception
setFilterExchangableByApi ( )

Устанавливает фильтр, в результате которого будут выбраны только те профили, которые поддерживают обмен по API

Возвращает
void

Поля

$types
static
const PLAIN_EXPORT_EXCHANGE = 'PLAIN_EXPORT_EXCHANGE'