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

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

Экспорт товаров в ВКонтакте

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

 _init ()
 
 getTitle ()
 
 getDescription ()
 
 getShortName ()
 
 export ()
 
 getToken ()
 
 getExchangeCacheFilepath ($profile_id)
 
 getLogFilename (ExportProfile $profile)
 
 doExchange ()
 
 getProductDescription (Product $product)
 
 getAppClientId ()
 
 getAppSecretKey ()
 
 getOauthUrl ($profile_id)
 
 getExportActionCellTemplate ()
 
 validateDataForExchangeByApi ()
 
 canSaveLog ()
 
 getLogContent ()
 
 clearLog ()
 
 isRunning ()
 
 stopExchange ()
 
- Открытые члены унаследованные от AbstractType
 __construct (array $options=null)
 
 processOptions ($options)
 
 beforesave ()
 
 getCheckboxParam ($key=null)
 
 set ($value)
 
 setListenPost ($boolean)
 
 isListenPost ()
 
 get ()
 
 getHint ()
 
 setHint ($text)
 
 setEscapeType ($escape_type)
 
 getEscapeType ()
 
 unsetvalue ()
 
 validate ($value)
 
 setChecker ($callmethod, $errortxt= '')
 
 removeAllCheckers ()
 
 getCheckers ()
 
 setVisible ($bool, $switch=null)
 
 isVisible ($switch=null, $use_default_visible=true)
 
 isMeVisible ($switch=null, $use_default_visible=true)
 
 setMeVisible ($bool)
 
 getTreeList ()
 
 setTree ($tree_function,...$params)
 
 getListFunc ()
 
 setList ($listfunc,...$params)
 
 setListFromArray (array $list)
 
 setChangeSizeForList ($bool)
 
 getList ()
 
 setCheckboxView ($onValue, $offValue)
 
 setCheckboxListView ($bool)
 
 setRadioListView ($bool, $inline=false)
 
 isRadioListInline ()
 
 selfSave ()
 
 normalizePost ()
 
 addClass (string $class)
 
 setAttr (array $view_attr)
 
 getAttr ()
 
 getAttrArray ()
 
 getAttrByKey ($key)
 
 isHaveAttrKey ($key)
 
 textView ()
 
 formView ($view_options=null, $orm_object=null)
 
 setName ($name)
 
 getName ()
 
 setArrayWrap ($array_wrap_name)
 
 setFormName ($form_name)
 
 getFormName ()
 
 setMaxLength ($length)
 
 getMaxLength ()
 
 isAlwaysModify ()
 
 setAlwaysModify ($bool)
 
 setReadOnly ($readonly=true)
 
 setErrors (array $errors)
 
 getErrors ()
 
 hasErrors ()
 
 getDescription ()
 
 setDescription ($description)
 
 setUseToSave ($bool)
 
 isUseToSave ()
 
 isRuntime ()
 
 setRuntime ($bool)
 
 isAutoincrement ()
 
 setAutoincrement ($bool)
 
 hasLength ()
 
 setAllowEmpty ($bool)
 
 isAllowEmpty ()
 
 getSQLNotation ()
 
 getSQLTypeParameter ()
 
 setDecimal ($decimal)
 
 getDecimal ()
 
 setPrimaryKey ($bool)
 
 isPrimaryKey ()
 
 setUnique ($bool)
 
 isUnique ()
 
 setIndex ($bool)
 
 isIndex ()
 
 setDefault ($default, $is_func=false)
 
 getDefault ($db_format=false)
 
 isDefaultFunc ()
 
 getPhpType ()
 
 setPhpType ($type)
 
 setTemplate ($template)
 
 setMeTemplate ($template)
 
 getOriginalTemplate ()
 
 getRenderTemplate ($multiedit=false)
 
 getTitle ()
 
 setHidden ($bool)
 
 isHidden ()
 
 escape ($value)
 
 checkDefaultRequestValue ($value)
 
 setRequestType ($var_type)
 
 getFromRequest (array $src)
 
 callPropertyFunction ($property_name,...$params)
 
 setTrimString ($bool)
 
 getTrimString ()
 
 isHtmlEncodedField ()
 
 __set ($name, $value)
 
 __get ($name)
 
 __isset ($name)
 
 __unset ($name)
 

Поля данных

const ERROR_ITEM_NOT_FOUND = 1403
 
const EDIT_ERROR_DELETED_BY_VK = 0
 
const LOG_LEVEL_NO = 0
 
const LOG_LEVEL_ACTION = 1
 
const LOG_LEVEL_QUERY = 2
 
 $log_filename = '/export_api_profile-%ID%.log'
 
- Поля данных унаследованные от AbstractType
const ESCAPE_TYPE_NONE = false
 
const ESCAPE_TYPE_ENTITY = 'entity'
 
const ESCAPE_TYPE_HTML = 'html'
 
 $name
 
 $description
 
 $formtype = "input"
 

Защищенные члены

 getOfferTypesClasses ()
 

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

- Защищенные данные унаследованные от AbstractType
 $listfunc
 
 $listfunc_param = []
 
 $tree_function
 
 $tree_function_params = []
 
 $list
 
 $parent_object
 
 $value
 
 $hidden = false
 
 $requesttype
 
 $checkers = []
 
 $use_to_save = true
 
 $read_only = false
 
 $array_wrap_name = false
 
 $form_template = '%system%/coreobject/type/form/string.tpl'
 
 $template
 
 $me_template
 
 $change_size_for_list = true
 
 $always_modify = false
 
 $errors = []
 
 $listen_post = true
 
 $hint = ''
 
 $checkbox_param = []
 
 $checkbox_list = false
 
 $radio_list = false
 
 $radio_list_inline = false
 
 $vis_form = true
 
 $me_visible
 
 $view_attr = []
 
 $php_type = ''
 
 $escape_type = self::ESCAPE_TYPE_ENTITY
 
 $runtime = false
 
 $sql_notation = ''
 
 $autoincrement = false
 
 $allowempty = true
 
 $primary_key = false
 
 $default = null
 
 $is_default_func
 
 $unique = false
 
 $index = false
 
 $has_len = true
 
 $max_len
 
 $decimal
 
 $form_name
 
 $trim_string = false
 
 $options = []
 

Методы

_init ( )
canSaveLog ( )

Возвращает ссылку на лог-файл, если таковой есть

Возвращает
string | null

Замещает ExchangableInterface.

clearLog ( )

Очищает лог файл

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

Замещает ExchangableInterface.

doExchange ( )

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

Возвращает
bool|int
Исключения
Exception
\RS\Db\Exception
\RS\Event\Exception
\RS\Orm\Exception

Замещает ExchangableInterface.

export ( )

Заглушка для метода. Экспорт в виде XML не поддерживается

Возвращает
string|void
Исключения
Exception
getAppClientId ( )

Возвращает client_id приложения ВК

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

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

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

Возвращает описание типа экспорта для администратора. Возможен HTML

Возвращает
string
getExchangeCacheFilepath (   $profile_id)

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

Аргументы
integer$profile_id- ID профиля
Возвращает
string
getExportActionCellTemplate ( )

Возвращает путь к шаблону для рендеринга ячейки с действиями.

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

Возвращает содержимое лог-файла

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

Замещает ExchangableInterface.

getLogFilename ( ExportProfile  $profile)

Возвращает путь к файлу лога

Аргументы
ExportProfile$profile
Возвращает
string
getOauthUrl (   $profile_id)

Получаем uri для Open Authorization в VK

Аргументы
integer$profile_idID профиля экспорта
Возвращает
string
getOfferTypesClasses ( )
protected

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

Возвращает
[]
getProductDescription ( Product  $product)

Возвращает описание товара

Аргументы
Product$product
Возвращает
mixed||string
getShortName ( )

Возвращает идентификатор данного типа экспорта. (только англ. буквы)

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

Возвращает название типа экспорта

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

Возвращает access token для доступа к API ВКонтакте

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

Возвращает true, если в настоящее время идет или запланирован обмен по API

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

Замещает ExchangableInterface.

stopExchange ( )

Останавливает омен по API, сбрасывает планировщик, очищает файл очереди, снимает флаг необходимости

Возвращает
bool
Исключения
Exception
\RS\Event\Exception

Замещает ExchangableInterface.

validateDataForExchangeByApi ( )

Возвращает true, если профиль готов к экспорту по API, все необходимые данные заполнены.

Возвращает
bool

Замещает ExchangableInterface.

Поля

$log_filename = '/export_api_profile-%ID%.log'
const EDIT_ERROR_DELETED_BY_VK = 0
const ERROR_ITEM_NOT_FOUND = 1403
const LOG_LEVEL_ACTION = 1
const LOG_LEVEL_NO = 0
const LOG_LEVEL_QUERY = 2