Корректировка и дополнение документации метода socialnetwork.api.workgroup.get

[jabir-sabitov]

Корректировка и дополнение документации к методу socialnetwork.api.workgroup.get.

Чек-лист выполненного:

• Описать параметр params, указать groupId не как отдельный параметр, а как параметр параметра params.
• Описать параметр select параметра params.
• Описать параметр mode параметра params.
• Описать все возвращаемые поля отдельной таблицей.
• Добавить примеры использования с помощью curl и crest.
  Описать параметр filter параметра params.

Метод реализован контроллером и для полноты картины прилагаю кусок метода Bitrix\Socialnetwork\Controller\Workgroup::getAction:

public function getAction(array $params = []): ?array
        {
                $groupId = (int)($params['groupId'] ?? 0);

                if ($groupId <= 0)
                {
                        $this->addEmptyGroupIdError();
                        return null;
                }

                $select = ($params['select'] ?? []);
                $filter = ($params['filter'] ?? []);
                $filter['ID'] = $groupId;
...

[serg-vostrikov-bitrix]

вообще здесь нужен тип object, поскольку array мы используем для наборов однотипных элементов https://apidocs.bitrix24.ru/api-reference/data-types.html

[serg-vostrikov-bitrix]

сюда, в идеале, добавляем "Значение для поля может быть получено методом sonet_group.get

[serg-vostrikov-bitrix]

а вообще, огонь! очень рады видеть первый pull-request! :)

[jabir-sabitov]

Параметр filter не имеет смысла, т.к. получение группы происходит по идентификатору.

[jabir-sabitov]

Метод Bitrix\Socialnetwork\Controller\Workgroup::getAction, 223-226 строка:

    if (
                                isset($params['mode'])
                                && $params['mode'] === 'mobile'
                        )
                        {
                                $additionalData = Helper\Workgroup::getAdditionalData([
                                        'ids' => [ $groupId ],
                                        'features' => ($params['features'] ?? []),
                                        'mandatoryFeatures' => ($params['mandatoryFeatures'] ?? []),
                                        'currentUserId' => (int)$this->getCurrentUser()->getId(),
                                ]);

                                $groupFields['ADDITIONAL_DATA'] = ($additionalData[$groupId] ?? []) ;
                        }

[jabir-sabitov]

У параметра select есть ключ THEME_DATA, который, как я понимаю, должен возвращать информацию о теме группы. Однако ключ возвращает null. В связи с этим была создана заявка в отдел разработок 199764.

Информацию об этом ключе пока не стал вносить в документацию, т.к. он нерабочий.