getList(array $filter = []): array

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

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

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->getList(['STRING_ID' => 'admins',]));

    return true;
}
        
    

 

get(string $code)

Возвращает группу с кодом

Аргумент Описание
string $code Символьный код группы пользователей
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->get('admins'));

    return true;
}
        
    

 

getIfExists(string $code): array

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

Аргумент Описание
string $code Символьный код группы пользователей
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->getIfExists('admins'));

    return true;
}
        
    

 

getById(int $id)

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

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

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->getById(1));

    return true;
}
        
    

 

getByIdIfExists(int $id): array

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

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

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->getByIdIfExists(1));

    return true;
}
        
    

 

export(string $code)

Экспорт группы

Аргумент Описание
string $code Символьный код группы пользователей
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->export('mail_users'));

    return true;
}
        
    

 

exports(array $filter = []): array

Экспорт по фильтру. Экспортируются только группы, у которых есть символьный идентификатор ("STRING_ID")

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

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->exports(['STRING_ID' => 'mail_users',]));

    return true;
}
        
    

 

getCode(int $id)

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

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

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->getCode(1));

    return true;
}
        
    

 

getCodeIfExists(int $id): string

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

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

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->getCodeIfExists(1));

    return true;
}
        
    

 

getId(string $code)

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

Аргумент Описание
string $code Символьный код группы пользователей
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->getId('admins'));

    return true;
}
        
    

 

getIdIfExists(string $code): int

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

Аргумент Описание
string $code Символьный код группы пользователей
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->getIdIfExists('admins'));

    return true;
}
        
    

 

add(string $code, array $fields = [], bool $silent = false): int

Добавить группу

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

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->add(
        'partners',
        [
            'NAME' => 'Партнеры',
        ]
    ));

    return true;
}
        
    

 

addIfNotExists(string $code, array $fields = [], bool $silent = false): int

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

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

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->addIfNotExists(
        'partners',
        [
            'NAME' => 'Партнеры',
        ]
    ));

    return true;
}
        
    

 

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

Обновить группу

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

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->update(
        9,
        [
            'NAME' => 'Наши партнеры',
        ]
    ));

    return true;
}
        
    

 

updateIfExists(string $code, array $fields = [], bool $silent = false)

Обновить группу, если она есть

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

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->updateIfExists(
        'partners',
        [
            'NAME' => 'Партнеры',
        ]
    ));

    return true;
}
        
    

 

save(string $code, array $fields = [], bool $silent = false): int

Сохраняет группу

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

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->save(
        'partners',
        [
            'NAME' => 'Партнеры',
        ]
    ));

    return true;
}
        
    

 

delete(string $code, bool $silent = false): bool

Удалить группу

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

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->delete('partners'));

    return true;
}
        
    

 

deleteIfExists(string $code, bool $silent = false): bool

Удаляет группу пользователей, если она есть

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

    $userGroupHelper = $helper->getUserGroupHelper();

    $this->outDump($userGroupHelper->deleteIfExists('partners'));

    return true;
}