# Структура модуля

Модули располагаются в папке **modules**\
Обычно модуль для JohnCMS имеет следующую структуру:

* modules
  * vendor\_name
    * module\_name
      * config
        * routes.php
      * src
        * Controllers
        * Install
      * locale
      * templates
      * composer.json

Данная структура носит лишь рекомендательный характер и не является обязательной.\
Система не накладывает ограничений на разработчика и разработчик вправе использовать свою структуру модуля, которая для него будет удобнее. 

Давайте подробнее посмотрим на структуру и разберемся что и для чего предназначено.

* **modules** - это обычная системная папка с модулями.
  * **vendor\_name** - Имя разработчика модуля
    * **module\_name** - это папка с названием модуля (например forum, community и т.п.)
      * **config** - содержит конфигурационные файлы модуля.
        * **routes.php** - файл с настройками маршрутов модуля.
      * **src** - папка с классами модуля (используется для автозагрузки классов и будет иметь пространство имен VendorName\\*ModuleName*)
        * **Controllers** - папка с контроллерами. Пространство имен VendorName\\*ModuleName\Controllers*
        * **Install** - папка с установочными файлами. Пространство имен VendorName\\*ModuleName\Install*
      * **locale** - это папка в которой хранятся файлы локализации модуля. Если модуль мультиязычный, то эта папка обычно есть.
      * **templates** - в этой папке хранятся шаблоны модуля.
      * **composer.json** - файл с некоторыми основными параметрами. Подробнее смотрите ниже.

Автоматическая загрузка классов реализуется с помощью файла composer.json.

Пример файла composer.json:

{% code title="composer.json" %}

```json
{
    "name": "johncms/auth",
    "description": "Auth module",
    "minimum-stability": "dev",
    "homepage": "https://johncms.com",
    "license": "MIT",
    "type": "johncms-module",
    "authors": [
        {
            "name": "JohnCMS Contributors",
            "homepage": "https://github.com/johncms/johncms/graphs/contributors"
        }
    ],
    "require": {
        "php": "^8.0"
    },
    "autoload": {
        "psr-4": {
            "Johncms\\Auth\\": "src/"
        }
    }
}
```

{% endcode %}

В этом примере стоит обратить внимание на следующие значения:

* **name** - Название модуля с указанием разработчика vendor\_name/module\_name
* **type** - Обязательно должен быть **johncms-module**
* **autoload** - В этой секции описываются правила автозагрузки классов вашего модуля. Рекомендуется делать так же как указано в примере. Параметр **Johncms\\\Auth\\\\** это пространство имен, а **src/** это папка в папке с модулем из которой будут загружаться классы. Начальный сегмент пространства имен обычно содержит в себе имя разработчика (Johncms) и название модуля (Auth). Каждое слово следует начинать с заглавной буквы.

Более подробно про автозагрузку можно почитать в официальной документации composer <https://getcomposer.org/doc/04-schema.md#autoload>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.johncms.com/10.0/moduli/struktura-modulya.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.