Правильно ли делать такую структуру проекта?

Question

[rad_li]

Учу php, делаю сайт с админкой. Правильно ли делать структуру в таком виде?

В корне index.php, в нем подключаю

include 'inc/functions.php';
include 'inc/get_functions.php';
include 'inc/main_tpl.php';

В functions.php специфичные функции вроде перевода строки в транслит, кропа и ресайза фоток.

В get_functions.php функции для получения данных из БД. Например:

• get_page_list для получения списка страниц,
  
• get_page получения страницы по ее id,
  
• get_page_title заголовок страницы по ее id,
  
• и т. д.
  

В main_tpl.php выводится содержимое страницы модуля (страницы, фото, каталог) в зависимости от $_GET запроса:

$_GET['section']) ? include 'modules/' . $_GET['section'] . '/index.php'

Каждый модуль в отдельной папке. Например, модуль фотогалереи в /modules/photo/*.
У каждого модуля свой index.php и файлы с шаблонами для вывода:

• photos_list_tpl.php выводит список фотографий,
  
• photos_add_tpl.php форма загрузки фотографий
  
• photos_view_tpl.php просмотр выбранной фотографии
  
• и т. п.
  

Для запросов в БД использую библиотеку SafeMySQL.

Стоит ли так дробить и все get функции собирать в файле inc/get_functions.php? Или будет правильней функции каждого модуля писать в самих модулях? И в целом как можно улучшить структуру?

Answer 1

[FanatPHP]

Нет, неправильно.

- get_functions.php ужасное название, винегрет внутри. все эти функции разложить по своим модулям.
- inc/main_tpl.php подключается слишком рано. сначала надо закончить работу с данными, а только потом начинать вывод. Это азбука.
- 'modules/' . $_GET['section'] . '/index.php' инклюдится слишком поздно. модуль надо инклюдить ДО начала вывода. При этом основной шаблон должен вызываться не в индексе, а в модуле. модуль решает, бует ли он что-то выводить, если да - то присваивает переменной имя своего шаблона и вызывает основной шаблон, который в себе инклюдит шаблон модуля. Подробнее: phpfaq.ru/tech/tpl
- в include 'modules/' . $_GET['section'] . '/index.php' тебе напихают такого, что на ежика станешь похож. имя модуля надо обязательно валидировать. в идеале по белому списку.

В остальном нормально, только обычно все кроме индекса кладут выше корня.

Comments

[rad_li]

Ну, название поменять не долго. Перемещу все по модулям.

Почему вы пишите, что inc/main_tpl.php рано подключается? Он же последним идет, а modules/' . $_GET['section'] . '/index.php' уже внутри main_tpl.

Проверка $_GET['section'] есть. Выбор идет из массива со списком имеющихся модулей.

И последнюю строку поясните, пожалуйста. Что значит "все кроме индекса кладут выше корня"?

[FanatPHP]

Прочтите по ссылке, там все написано.

[FanatPHP]

плюс я отредактировал ответ чтобы было понятнее

[rad_li]

FanatPHP, в целом вроде все понял.
Тоже поясню. В include 'modules/' . $_GET['section'] . '/index.php в index.php не идет вывод страницы. Там есть обработка действий вроде удаление страницы, добавление новой и т. п. И в зависимости от этих действий уже выводится шаблон для показа страницы, списка или загрузки фото.

То есть структурно все идет так:
подключаю functions.php, get_functions.php, main_tpl.php.

В main_tpl подключаю index.php нужного модуля через $_GET['section']) ? include 'modules/' . $_GET['section'] . '/index.php' (с проверкой разрешенных ['section']).

И у каждого модуля индекс файл, после получения данных из БД или записи в нее, подключает хедер, меню, футер и нужный шаблон страницы.
Что вроде как соответствует прочитанному по phpfaq.ru/tech/tpl.

[FanatPHP]

Что-то я не понял. Вообще ничего.
Если "каждый модуль подключает хедер, меню, футер и нужный шаблон страницы.", то что такое main_tpl.php и зачем оно нужно? И почему так называется?

[rad_li]

FanatPHP, извините, плохо объяснил. Уже сам начинаю путаться.

В самом основном index.php подключаю functions.php, get_functions.php, main_tpl.php. Здесь же получаю $_GET['section']. Html код хедеров и футеров (с тегами ...) находятся в main_tpl.php. Там же делаю include $tpl, где подключается индексный файл какого-либо модуля в зависимости от $_GET['section']), в котором уже вызывается шаблон нужной страницы модуля. Кроме выбора модуля, вся php логика находится в индексах модулей.

У всех страниц модулей есть свой хедер, футер (баннеры, ссылки, кнопки соцсетей). Правильно было бы их по другому назвать...

Как вы и написали основной шаблон страницы, не считая боковых менюшек и прочего, вызывается в самом модуле. А вся логика идет до шаблонов.

[FanatPHP]

Я тогда не понимаю, какой смысл инклюдить модуль в main_tpl.php а не в индексе.
Если main_tpl.php - это шаблон, то что в нем делает логика?
А если после выполнения модуля не нужно будет ничего выводить, а надо будет сделать редирект - зачем вообще инклюдить шаблон?

Нужно сделать структуру последовательной и логичной. В шаблонах - вывод, в модулях - логика.

[rad_li]

FanatPHP, в main_tpl.php в начале идут , весь остальной не изменяющийся html-код, в середине как раз добавляю нужный шаблон и в конце закрывающие . Так сделал, чтобы не делить html-часть на два файла. И да, есть одна строчка с логикой. Возможно не лучшее решение. В споре рождается истина.

Спасибо за советы. Пойду переделывать.

[FanatPHP]

Эти два утверждения,

в main_tpl.php в начале идут , весь остальной не изменяющийся html-код,

и

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

на мой взгляд противоречат друг другу.
и второе, как я понимаю - неверное.
Так что да - лучше переделать.
модуль может вернуть НТТР заголовок, джейсон, ошибку. Может поменять отображение в шаблоне. Все это должно происходить до начала любого вывода.
Я думаю вы это уже усвоили, но на всякий случай.

Answer 2

[Lander]

Для начала делайте как делается, а не как правильно. Всякие RightWay потом учить будете. Пока вам нужно получить общие представления как всё работает, набить СВОИХ шишек и уже с пониманием всего переходить к "тяжёлой артиллерии".

Comments

[АртемЪ]

Алексей, Ага, в итоге новичок нахватается паттернов и новомодных фишек и сует их везде, совершенно не понимая для чего вообще они нужны и в каких случаях их нужно понимать.

[FanatPHP]

Абсолютно дурацкий и бесполезный ответ.
Никто и не спрашивал про "тяжёлую артиллерию".
А посмотреть код и подсказать что поправить в текущей парадигме всегда можно.

[Lander]

FanatPHP, Ну вы дали свой "не дурацкий" ответ (сделали всё верно). Думаю полезность/бесполезность оценивать не нам с Вами.

[Lander]

Алексей, Кстати, Вашего ответа так и не увидел.

Answer 3

[Антон Р.]

Нет. Сейчас тебе расскажут про PSR, MVC и всё остальное.
Держись. Желательно обеими руками.

Comments

[rad_li]

Про MVC я немного в курсе, но сложновато для понимания. А PSR это вообще болото((

[irishmann]

rad_li, PSR - болото? Ничего не путаете?
https://www.php-fig.org/psr/

[rad_li]

irishmann, и да, и нет. Оказывается я читал лишь отрывок - psr-7 и то не в оригинале. Я его не дочитал, т. к. многого не понимал. Надо остальное прочитать. Спасибо за подсказку.

[Дмитрий]

MVC это простая концепция, достаточно изучить и попробовать.

[FanatPHP]

ага, особенно если бы каждый не понимал это слово по-своему. А так -то простая конечно :)

[Кирилл Несмеянов]

Дмитрий, простая? А вы ведь в курсе что в вебе невозможно реализовать MVC без использования вебсокетов?))

[Kovalsky]

Кирилл Несмеянов, MVC это архитектурный паттерн, к транспорту он не имеет никакого отношения.

[FanatPHP]

Никита Полевой, я подозреваю, что это такой сарказм был, шутка для посвящённых.

[Kovalsky]

FanatPHP, самурай в поту, мысли в роят голове, так сложен прикол.

[Кирилл Несмеянов]

Никита Полевой, ага, только хочу напомнить, что view должен отображать данные в тот самый момент, когда они изменяются в модели ( https://ru.wikipedia.org/wiki/Model-View-Controlle... ). А значит транспорт тут как раз имеет отношение ;)

[Kovalsky]

Кирилл Несмеянов, ну да, они будут чуть поближе к идеалу, но о моментальной доставке речи всё равно нет. MVC и без сокетов спокойно существует

[Кирилл Несмеянов]

Никита Полевой, ну так в этом и фича же. Создаём, например, объект модели "текстовое поле", там курсор. Курсор - это всего лишь изменение bool значения показывать\скрывать раз в секунду. Вот он и мигает. Модель изменяется, изменяется и отображение.

Хз как такое сделать без моментальной доставки.

[FanatPHP]

Кирилл Несмеянов, троллинг 80 уровня, уважаю! :)

[Kovalsky]

FanatPHP, а для меня сложно было