Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс Agent

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

static start ($feedType, $exportId, $startPosition="", $once=false, $execNumber=1)
 
static add ($feedType, $exportId, $startPosition="", $interval, $once=false)
 
static update ($exportId, $feedType, $interval, $once=false)
 
static deleteAll ()
 
static deleteAgent ($agentId)
 
static getExistingOnceAgent ($feedType, $exportId)
 
static getRunningPereodicalAgents ($feedType, $exportId)
 

Защищенные статические члены

static createAgentNameForAdd ($feedType, $exportId, $startPosition, $once=false, $execNumber=1)
 
static createOnceAgentName ($feedType, $exportId)
 
static createRunningPereodicalAgentName ($feedType, $exportId)
 

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

См. определение в файле agent.php строка 19

Методы

◆ add()

static add ( $feedType,
$exportId,
$startPosition = "",
$interval,
$once = false )
static
Аргументы
$feedType- type of export. May be ALL - then after ending ALBUMS export will be created PRODUCTS agent
$exportId
string$startPosition- in first run must be ""
$interval- time of repeating
bool$once- if true - agent will be deleted after ending process
Возвращает
bool|int
Исключения
ArgumentNullException

Add new agent for export products, albums or all

См. определение в файле agent.php строка 155

◆ createAgentNameForAdd()

static createAgentNameForAdd ( $feedType,
$exportId,
$startPosition,
$once = false,
$execNumber = 1 )
staticprotected
Аргументы
$feedType- type of export. May be ALL - then after ending ALBUMS export will be created PRODUCTS agent
$exportId
$startPosition
bool$once- if true - agent will be deleted after ending process
int$execNumber
Возвращает
string

Create name for creating new agent

См. определение в файле agent.php строка 201

◆ createOnceAgentName()

static createOnceAgentName ( $feedType,
$exportId )
staticprotected

Create name for vk-export agents which running onced.

Аргументы
$feedType
$exportId
Возвращает
string

См. определение в файле agent.php строка 340

◆ createRunningPereodicalAgentName()

static createRunningPereodicalAgentName ( $feedType,
$exportId )
staticprotected

Create name for vk-export agents which was running but not finished (have not null start position)

Аргументы
$feedType
$exportId
Возвращает
string

См. определение в файле agent.php строка 353

◆ deleteAgent()

static deleteAgent ( $agentId)
static

Delete agent by ID

См. определение в файле agent.php строка 279

◆ deleteAll()

static deleteAll ( )
static

Remove all agents, saving in VK settings

См. определение в файле agent.php строка 264

◆ getExistingOnceAgent()

static getExistingOnceAgent ( $feedType,
$exportId )
static

Find vk-export agents which running once. Return array of IDs.

Аргументы
$feedType- type of export. May be ALL - then after ending ALBUMS export will be created PRODUCTS agent
$exportId
Возвращает
array - IDs of existing agents

См. определение в файле agent.php строка 293

◆ getRunningPereodicalAgents()

static getRunningPereodicalAgents ( $feedType,
$exportId )
static

Find vk-export agents which was running but not finished (have not null start position) Return array of IDs.

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

См. определение в файле agent.php строка 318

◆ start()

static start ( $feedType,
$exportId,
$startPosition = "",
$once = false,
$execNumber = 1 )
static

Starting agents from start position. Need for multisteps.

Аргументы
$feedType- type of export. May be ALL - then after ending ALBUMS export will be created PRODUCTS agent
$exportId
string$startPosition- in first run must be ""
bool$once- if true - agent will be deleted after ending process
int$execNumber- number of repeated running without changing position. Need for alert of slow agent.
Возвращает
string
Исключения
ArgumentNullException
ArgumentOutOfRangeException

Bitrix\Main\SystemException

См. определение в файле agent.php строка 34

◆ update()

static update ( $exportId,
$feedType,
$interval,
$once = false )
static

Update params for existing agent. If agent if not exist - create new

Аргументы
$exportId
$feedType- type of export. May be ALL - then after ending ALBUMS export will be created PRODUCTS agent
$interval- time of repeating
bool$once- if true - agent will be deleted after ending process
Возвращает
bool|int
Исключения
ArgumentNullException

См. определение в файле agent.php строка 217