Skip to content

folders.md

Latest commit

 

History

History
117 lines (81 loc) · 6.18 KB

folders.md

File metadata and controls

117 lines (81 loc) · 6.18 KB

Структура каталогов

Верхний уровень

Здесь всё просто:

  • всё, что относится к приложению находится в папке application,
  • все сторонние библиотеки и компоненты, включая Colibri, - в vendor;
  • также здесь находится composer.json, в котором вы можете прописывать свои зависимости для подключаемых библиотек.

Папка vendor исключена из коммитов в файле .gitignore. Если вы используете другую систему контроля версий, добавьте эту папку в исключения.
user@svn$ svn propset svn:ignore vendor .
user@hg$ echo vendor >> .hgignore

Application

configs

В этой папке храняться все конфигурационные файлы вашего приложения.
Feel free :) to пройтись по файлам и посмотреть какие настройки уже доступны для вас.

Также вы можете создавать свои файлы настроек или дополнять/изменять существующие. О настройках отдельных компонентов Colibri как то database или cache вы можете посмотреть в соответстующих разделах документации.

Подробнее об использовании настроек.

Command

В этой папке располагаются консольные команды вашего приложения. Используйте подпапки для обединения команд, относящихся к одной области, в так называемые неймспейсы. Для примера использования, здесь уже присутствует команда ./fly cache:clear

Foundation

Здесь вы можете раполагать классы общего назначения, которые будут использоваться во многих местах проекта - в разных модулях и разделах. Например, базовые котроллеры (расширения контроллера фрейворка) для разных разделов или базовую модель БД.

Папка classes добавлена в раздел autoload -> classmap файла composer.json, - т.о. ваши классы будут автоматически загружаться стандартным автозагрузчиком. Единственное, что вам нужно сделать после создания класса, - выполнить команду:
$ composer dump

logs

Как вы наверняка догадались, здесь хранятся логи вашего проекта.
Если для вашего веб-сервера вы использовали настройки приведённые в данной документации и не меняли место располжения логов веб-сервера, то здесь также будут располагаться error.log и access.log.

Папка logs исключена из коммитов в файле .gitignore. Если вы используете другую систему контроля версий, добавьте эту папку в исключения.
user@svn$ svn propset svn:ignore logs .
user@hg$ echo logs >> .hgignore

Model

Здесь хранятся модели БД вашего приложения. При создании новой модели расположите её здесь. Для примера, в этой папке уже находится модель User. Все ненужные вам методы вы можете удалить, актуализировать название таблицы, поля и их названия в соответствии с вашей базой данных и дополнить нужными вам методами.

modules

В данной папке находятся модули вашего приложения.

Структура модуля
  • <Module_name>ViewsController.php - [контроллер представлений](/controller.md#Views Controller)
  • <Module_name>MethodsController.php - [контроллер удалённых вызовов](/controller.md#Methods Controller)
  • views - шаблоны, относящиеся к модулю
  • css - css стили модуля
  • js - клиентские скрипты модуля

Подробнее о структуре и формировании имён файлов можно прочитать в разделе Сруктура модуля

public

Корень вашего виртуального хоста. Здесь располлагаются все файлы, котороые доступны напрямую по h_ttp://example.ru/path/to/file/in/public/folder :
css-ы, js-ы, картики, swf, ...
и конечно же единая точка запуска приложения
index.php

views

Шаблоны общего использования:

  • Каркасы (layout-ы) разделов (layout[.<division_name>].php)
  • Шаблоны постраничной навигации (pager.php)
  • Шаблоны вывода ошибок (validation_output.php)
  • ... и всё, что вы сами тут расположите.