getList(array $filter = []): array

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

Аргумент Описание
array $filter Фильтр для метода \CAgent::GetList
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $agentHelper = $helper->getAgentHelper();

    $agents = $agentHelper->getList(['MODULE_ID' => 'main']);

    $this->outDump($agents);

    return true;
}
        
    

 

exports(array $filter = []): array

Экспорт агентов по фильтру

Аргумент Описание
array $filter Фильтр для метода \CAgent::GetList
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $agentHelper = $helper->getAgentHelper();

    $agents = $agentHelper->exports(['MODULE_ID' => 'main']);

    $this->outDump($agents);

    return true;
}
        
    

 

export(string $moduleId, string $name = '')

Экспорт агента

Аргумент Описание
string $moduleId Идентификатор модуля
string $name Название агента (код вызова метода)
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $agentHelper = $helper->getAgentHelper();

    $this->outDump($agentHelper->export('main', 'CEvent::CleanUpAgent();'));

    return true;
}
        
    

 

exportById(int $id)

Экспорт агента по идентификатору

Аргумент Описание
int $id Идентификатор агента
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $agentHelper = $helper->getAgentHelper();

    $this->outDump($agentHelper->exportById(42));

    return true;
}
        
    

 

get(string $moduleId, string $name = '')

Получить агента

Аргумент Описание
string $moduleId Идентификатор модуля
string $name Название агента (код вызова метода)
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $agentHelper = $helper->getAgentHelper();

    $this->outDump($agentHelper->get('search', 'CSearchSuggest::CleanUpAgent();'));

    return true;
}
        
    

 

getIfExists(string $moduleId, string $name = ''): array

Возвращает агент, если он есть

Аргумент Описание
string $moduleId Идентификатор модуля
string $name Название агента (код вызова метода)
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $agentHelper = $helper->getAgentHelper();

    $this->outDump($agentHelper->getIfExists('search', 'CSearchSuggest::CleanUpAgent();'));

    return true;
}
        
    

 

getById(int $id)

Возвращает агента по идентификатору

Аргумент Описание
int $id Идентификатор агента
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $agentHelper = $helper->getAgentHelper();

    $this->outDump($agentHelper->getById(42));

    return true;
}
        
    

 

getByIdIfExists(int $id): array

Возвращает агента по идентификатору, если он есть

Аргумент Описание
int $id Идентификатор агента
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $agentHelper = $helper->getAgentHelper();

    $this->outDump($agentHelper->getByIdIfExists(47));

    return true;
}
        
    

 

delete(string $moduleId, string $name, bool $silent = false): bool

Удалить агент

Аргумент Описание
string $moduleId Идентификатор модуля
string $name Название агента (код вызова метода)
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $agentHelper = $helper->getAgentHelper();

    $this->outDump($agentHelper->delete('main', '\Foo::bar();'));

    return true;
}
        
    

 

deleteIfExists(string $moduleId, string $name, bool $silent = false): bool

Удалить агент, если он есть

Аргумент Описание
string $moduleId Идентификатор модуля
string $name Название агента (код вызова метода)
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $agentHelper = $helper->getAgentHelper();

    $this->outDump($agentHelper->deleteIfExists('main', '\Foo::bar();'));

    return true;
}
        
    

 

save(array $fields, bool $silent = false): int

Сохранить агент (если нет - добавить, если есть - обновить)

Аргумент Описание
array $fields Поля агента
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $agentHelper = $helper->getAgentHelper();

    $this->outDump($agentHelper->save([
        'MODULE_ID' => 'main',
        'NAME' => '\Foo::bar();',
    ]));

    return true;
}
        
    

 

update(array $fields, bool $silent = false): int

Обновить агент

Аргумент Описание
array $fields Поля агента
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $agentHelper = $helper->getAgentHelper();

    $this->outDump($agentHelper->update([
        'MODULE_ID' => 'main',
        'NAME' => '\Foo::bar();',
    ]));

    return true;
}
        
    

 

add(array $fields, bool $silent = false): int

Добавить агент

Аргумент Описание
array $fields Поля агента
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $agentHelper = $helper->getAgentHelper();

    $this->outDump($agentHelper->add([
        'MODULE_ID' => 'main',
        'NAME' => '\Foo::bar();',
    ]));

    return true;
}
        
    

 

addIfNotExists(array $fields, bool $silent = false): int

Добавить агент, если его нет

Аргумент Описание
array $fields Поля агента
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $agentHelper = $helper->getAgentHelper();

    $this->outDump($agentHelper->addIfNotExists([
        'MODULE_ID' => 'main',
        'NAME' => '\Foo::bar();',
    ]));

    return true;
}