Собственные контроллеры и генерация роутов к ним в модулях Битрикс

1. Добавляем в settings.php
   
   'routing' => ['value' => [ 'config' => ['api.php'] ]]

   1 2 3

   'routing' => ['value' => [         'config' => ['api.php']     ]]

   
   Это значит, что битрикс будет смотреть на конфигурацию роутов из файла
   
   \bitrix\routes\api.php

   1	\bitrix\routes\api.php

   
   или если он есть
   
   \local\routes\api.php

   1	\local\routes\api.php

   
   2. Добавляем в файл \local\routes\api.php путь к контроллеру модуля (обработчик ajax запросов)

   Пример для модуля с названием my.module

   PHP

   use Bitrix\Main\Routing\RoutingConfigurator; use My\Module\Controller\ReviewsController; use My\Module\Controller\AuthController; return static function (RoutingConfigurator $routes) { $routes->prefix('auth')->group(function (RoutingConfigurator $routes) { /** * Запрос смс кода авторизации */ $routes->post('', [AuthController::class, 'checkRequest']); }); };

   1 2 3 4 5 6 7 8 9 10 11 12 13

   use Bitrix\Main\Routing\RoutingConfigurator; use My\Module\Controller\ReviewsController; use My\Module\Controller\AuthController;   return static function (RoutingConfigurator $routes) {         $routes->prefix('auth')->group(function (RoutingConfigurator $routes) {             /**              * Запрос смс кода авторизации              */             $routes->post('', [AuthController::class, 'checkRequest']);   }); };

   Если запрос передаётся в формате json, то так же необходимо добавить пре фильтр на обработку этого формата

   use \Bitrix\Main\Engine\ActionFilter; /** * @return ActionFilter\HttpMethod[] */ protected function getDefaultPreFilters(): array { return [ new ActionFilter\ContentType([ActionFilter\ContentType::JSON]), ]; }

   1 2 3 4 5 6 7 8 9 10 11

   use \Bitrix\Main\Engine\ActionFilter;       /**      * @return ActionFilter\HttpMethod[]      */     protected function getDefaultPreFilters(): array     {         return [             new ActionFilter\ContentType([ActionFilter\ContentType::JSON]),         ];     }

2.  Название метода должно заканчиваться на Action, например checkRequestAction, при этом в роуте пешем обращение к методу без приставки Action, т.е.  checkRequest
3.  Аргументом метода должен передаваться корневой элемент запроса.
   Т.е. например

   SubscriptionItems

   PHP

   public function checkRequestAction($SubscriptionItems) { }

   1 2 3

   public function checkRequestAction($SubscriptionItems) { }

   Для запроса вида

   PHP

   { "SubscriptionItems": { "PartialResult": "1", "Count": "10" } }

   1 2 3 4 5 6

   {     "SubscriptionItems": {         "PartialResult": "1",         "Count": "10"         } }

   Пример заготовки, которая возвращает массив, который в неё передали

   <?php namespace My\Module\Controller; use Bitrix\Main\Engine\Controller; use \Bitrix\Main\Engine\ActionFilter; class AuthController extends Controller { /** * @return ActionFilter\HttpMethod[] */ protected function getDefaultPreFilters(): array { return [ new ActionFilter\ContentType([ActionFilter\ContentType::JSON]), ]; } /** * @return array */ public function checkRequestAction($SubscriptionItems) { return $SubscriptionItems; } }

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

   <?php   namespace My\Module\Controller;   use Bitrix\Main\Engine\Controller; use \Bitrix\Main\Engine\ActionFilter;   class AuthController extends Controller {       /**      * @return ActionFilter\HttpMethod[]      */     protected function getDefaultPreFilters(): array     {         return [             new ActionFilter\ContentType([ActionFilter\ContentType::JSON]),         ];     }         /**      * @return array      */     public function checkRequestAction($SubscriptionItems)     {           return $SubscriptionItems;       }   }

Подключить собственные пространства имен в файле include.php