Структура папок и файлов
-
index.php - Точка входа в движок, распределяет все запросы к нужным компонентам и организует работу приложения в целом.
-
.htaccess - Файл для веб сервера Apache. Предназначен для переадресации всех http запросов на сайт к файлу /index.php (чтобы он появился, распакуйте в корень unzipme.zip файл).
По умолчанию имя страницы (компонента) для запуска через /index.php нужно передавать в переменной $_GET[q]. По этой причине ссылки выглядят следующим образом: www.example.com/?q=about, www.example.com/?q=contacts и пр. Стоит отметить, что это явно не красиво, и, чтобы избавиться от данной /?q=, вы можете установить правило для своего веб-сервера, чтобы он автоматом вставлял эти /?q=
Это означает, что когда пользователь будет набирать в браузере строчку www.example.com/about, то ваш web-сервер, получив эту страницу, в соотвествии с правилами заданными в .htaccess, перепишет её в виде: www.example.com/?q=about, который и нужен нашему движку. -
robots.txt - Файл для поисковых систем, по умолчанию позволяющий индексировать все страницы сайта (впишите свои данные при необходимости).
-
favicon.ico - Иконка для закладок (замените на свою).
-
COPYING.TXT - Файл лицензии, не накладывающий никаких ограничений на использование или копирование (удалите чтобы не мешался).
-
core - Файлы ядра движка (конфиги, файлы инициализации, функции движка и функции помощники (хелперы)).
-
config - Все конфигурационные файлы сайта первым грузится main.php
main.php - содержит главные настройки движка.
db.php - содержит настройки подключения к БД на основе DSN записей (класс DbSimple).
-
func - Функции движка и хелперы первым подключается main.php
main.php - главные функции движка.
messages.php - функции MsgOk, MsgErr, Msg для вывода сообщений с оформлением.
debug.php - функции помогающие при дебаге сайта.
validation.php - функции для валидации приходящих данных (проверка правильности почты, пароля и пр).
-
init - Инициализационные файлы движка первым подключается main.php
main.php - Запускной файл самого движка.
db.php - Инициализация работы с базами данных.
-
core.php - Инициализация всего движка.
-
-
i - Папка для хранения ресурсов сайта.
-
css - Папка для css файлов сайта (можно писать на Less, но расширение файлов всё равно должно быть css)
-
dev - Папка для css файлов которые являются только частью компонентов сайта.
debug_panel.css - Оформление нижней debug-панели сайта (информация о запросах, времени работы, памяти и пр.).
funcs.css - Less функции для css файлов упрощающие работу с css3.
msg.css - Оформление сообщений для функций Msg, MsgOk, MsgErr.
main.css - Главный css файл сайта, обычно используется для написания css к главному шаблону сайта.
normalize.css - Предназначен для приведения базовых css стилей к едином виду для различных браузеров.
home.css - Пример стилистического оформления для страницы home (оформление непосредственно того html который записан в tpl/home.php).
page_status_label.css - Оформление большой надписи кода ошибки на страницах (404 и 500)
-
-
image - Изображения используемые на сайте.
-
dev - Для хранения изображения применяемых только в компонентах.
-
touch_icon - Иконки для закладок на сайт (ссылка на сайт) в системах ios и android.
load.gif - Гифка для индикации загрузки чего-либо (предполагается, что на сайте ради единого стиля для индикации загрузки везде используется одна гифка).
-
-
js - JavaScript файлы сайта.
-
dev - Скрипты используемые в компонентах.
jquery-1.7.1.js - Библиотека jQuery (подключается компонентом dev/jquery).
msg.js - Для сворачивания сообщений от функций MsgOk, MsgErr, Msg.
-
-
data - Для хранения остальных данных-ресурсов (например flash, fonts, video и пр.).
-
-
lang - Языковые файлы сайта, все текстовые данные используемые на сайте (которые не предполагается хранить в БД) выносятся в них.
-
en - Файлы для английской языковой версии.
-
autoload - Все файлы, которые здесь находятся грузятся, если страница сайта открывается на английском языке (или всегда если в DEF_LANG записан английский язык).
main.php - Главный языковой файл, здесь по умолчанию определены такие важные для SEO параметры, как title / description / key words. Языковой файл запрашиваемой страницы может их переопределить.
-
dev - Языковые файлы компонентов
404.php - Языковой файл для 404-ой страницы сайта (tpl/404.php)
_500.php - Текста к шаблону _500 который вызывается внутри компонента 500 сингализирующего на ошибку на сайте (tpl/_500.php)
home.php - Языковой файл для home страницы сайта (данная страница грузится по умолчанию, если в $_GET[q] не пришло имя страницы. Её html-контент находится в tpl/home.php).
-
-
ru - Аналогична en, но только для русской версии сайта.
-
-
lib - Библиотеки сайта.
-
Db - Библиотека для работы с DbSimple, класс для настройки и инициализации.
Db.php - Класс для инициализации всех объектов БД и подключения в них логгера и обработчика ошибок из MyDataBaseLog (/lib/Db/DbSimple/my/MyDataBaseLog.php)
-
DbSimple - Библиотека DbSimple
-
my - Папка для дополнительных скриптов DbSimple от разработчиков Micron
MyDataBaseLog.php - Логгер запросов и ошибок в запросах к БД
-
-
Debug - Отлавливатель ошибок. В зависимости от DEBUG_MODE либо выводит их на экран, либо записывает в лог файл (+ отправляет на почту письмо с тексом ошибки, но не чаще чем раз в 3 минуты. И время и почтовый адрес можно изменить в настройках).
-
ExtraPacker - Склеиватель и паковщик css/js файлов в единый css и единый js файл.
DebugPanel.php - Библиотека для нижней debug-панели на сайте.
FileLogger.php - Работа с лог-файлами.
FileSys.php - Работа с файловой системой.
HtmlValidate.php - Склеиватель всех head-блоков в один, с возможностью встройки валидатора html кода.
InputClean.php - Класс для очистки входных данных от XSS инъекций.
Php.php - Настройщик PHP.
-
-
model - Модели сайта.
Model.php - Модель по умолчанию.
-
src - Папка где хранятся все контроллеры компонентов сайта (компонентов и страниц).
dev - Папка для котроллеров служебных компонентов, т.е. тех компонентов которые нельзя открыть как страницы. Эти компоненты могут быть лишь частью других компонентов (см. pagesbar или меню).
-
tmp - Для хранения всех временных файлов, например склеенных js и css, логов и пр. Подразумевается, что после чистки этой папки сайт будет работать всё так же корркетно.
-
tpl - Шаблоны компонентов (страниц) сайта.
dev - Папка для шаблонов служебных компонентов.
-
upl - Для загрузки пользовательских файлов, или прочих загрузок файлов на сайт.