Контроллеры {namespace}

Контроллер - класс с методами (или обычный скрипт), который будет отработан при входящем запросе.

Контроллеры указываются в карте роутов при описании роута. По умолчанию, контроллеры располагаются в папке модуля /bitrix/modules/artamonov.rest/lib/controllers/. Но, также, контроллер может располагаться за пределами модуля, главное чтобы он был доступен через пространство имён.

Начиная с версии 2.3.0 можно указать путь к PHP-скрипту, вместо указания неймспейса контроллера.

Для использования контроллеров из собственной директории, необходимо:

  1. Создать директорию, например, /local/api/controllers/;

  2. Создать файл с классом, например, /local/api/controllers/product.php;

  3. Указать для класса корректный namespace (согласно PSR);

<?php
/**
 * Copyright (c) 2019 Denis Artamonov
 * Created: 3/18/19 12:13 PM
 * Author: Denis Artamonov
 */

namespace Local\Api\Controllers;


class Product
{
    public function __construct()
    {
        // code ...
    }

    public function _get()
    {
        // code ...
    }

    public function _post()
    {
        // code ...
    }

    public function _put()
    {
        // code ...
    }

    public function _patch()
    {
        // code ...
    }

    public function _delete()
    {
        // code ...
    }

    public function _head()
    {
        // code ...
    }
}
  1. Указать в карте роутов, в качестве контроллера, собственный класс через его namespace.

<?php
/**
 * Copyright (c) 2019 Denis Artamonov
 * Created: 3/18/19 12:19 PM
 * Author: Denis Artamonov
 */

return [
    'GET' => [
        'product/get' => [
            'controller' => '\Local\Api\Controllers\Product@_get'
        ]
    ],
    'POST' => [
        'product/post' => [
            'controller' => '\Local\Api\Controllers\Product@_post'
        ]
    ],
    'PUT' => [
        'product/put' => [
            'controller' => '\Local\Api\Controllers\Product@_put'
        ]
    ],
    'PATCH' => [
        'product/patch' => [
            'controller' => '\Local\Api\Controllers\Product@_patch'
        ]
    ],
    'DELETE' => [
        'product/delete' => [
            'controller' => '\Local\Api\Controllers\Product@_delete'
        ]
    ],
    'HEAD' => [
        'product/head' => [
            'controller' => '\Local\Api\Controllers\Product@_head'
        ]
    ]
];

Last updated