yamf php

Ямф

YAMF (еще одна структура MVC) представляет собой небольшую структуру PHP MVC, предназначенная для того, чтобы вы начали быстро использовать парадигму MVC без большой работы. Все, что вам нужно, - это веб -сервер, который принимает файлы .htaccess , и вы в значительной степени хороши!

Настраивать

Минимальные требования: PHP 7,0+.

1. Клонируйте репозиторий и/или используйте этот проект в качестве шаблона для своего собственного проекта, нажав на эту ссылку или нажав кнопку « Use this template на странице «Репо главной проект».
2. Убедитесь, что ваш веб -сервер настроен для чтения и использования файлов .htaccess. (Если вы не знаете, что это значит, пожалуйста, Google Google! Может быть, мы добавим сюда несколько вспомогательных ссылок.
3. Настройте config.php если это необходимо. Отрегулируйте любые параметры, которые вы хотите там, или добавьте новые параметры в $app , такие как логика сеанса. По умолчанию вам не нужно ничего настроить, чтобы поднять ваш сайт.
4. Если у вас есть какие-либо учетные данные базы данных, частные ключи и т. Д., Которые необходимо использовать на веб-сайте, скопируйте config-private.sample.php в config-private.php и настраивать его в соответствии с вашими потребностями. Например, вы можете настроить $app->db для экземпляра PDO для вашей локальной базы данных. Обратите внимание, что config-private.php будет загружен до того, как произойдет что-либо в config.php .
5. Для того, чтобы использовать операторы use Yamf/XYZ , вам нужно использовать композитор. Использовать композитор довольно просто: просто перейдите на страницу загрузки и запустите скрипт вверху. (Примечание: если вы находитесь в Windows, вы захотите следовать инструкциям здесь, на вступительной странице.)
6. composer install (если у вас есть файл composer.phar в вашем каталоге, запустите php composer.phar install ). Он будет сидеть и думать на минуту.
7. Ты закончил! Наслаждайтесь вашим веб-сайтом на основе MVC! Конечно, вы можете вырвать примерные элементы и CSS по умолчанию!

Ждать! Где библиотека миграции базы данных / библиотека шаблона представления / библиотека тестирования модулей / {другие структуры здесь}?!

Их здесь нет, а их не специально! Ямф был целенаправленно записан, чтобы не использовать никаких внешних зависимостей, кроме автозазагрузчика композитора, чтобы снизить барьер въезда на использование парадигмы MVC в PHP. Если вы хотите что -то из этих вещей, просто потяните их со своим любимым менеджером зависимостей (например, композитор). Поскольку композитор уже необходим для запуска этого проекта для автозагрузки PSR-4, мы рекомендуем использовать Composer. vendor/autoload.php уже включен для вас в init.php .

Примечание, касающееся шаблона представления, см. Раздел о подкласке.

Документация

Если вы прочитаете следующую документацию на YAMF, вам, вероятно, будет намного лучше, чем просто запрыгнуть и попытаться прочитать код самостоятельно. :) Это займет всего несколько минут, и это того стоит!

Примечания по приложению $

Чтобы облегчить простую передачу параметров конфигурации, таких как настройки базы данных и т. Д., YAMF передает переменную $app класса YamfAppConfig для каждой функции контроллера. Вы можете настроить эту переменную для хранения объекта PDO в базе данных, изменить расширение вашего представления или местоположение папки, а также многие другие настройки. Если вы хотите добавить свои собственные значения в $app , вы можете создать класс, который вытекает из YamfAppConfig и изменить настройку appConfigClass в config.php , чтобы указать на свой пользовательский класс. Обратите внимание, что ваш пользовательский класс должен получить от YamfAppConfig ! См. config.php чтобы увидеть все настройки и значения, которые передаются $app . Примечательно, вы можете:

• Измените местоположение своей папки Views ( viewsFolderName )
• Измените расширение файлов вашего представления ( viewExtension )
• Изменить заголовок по умолчанию или имя нижнего колонтитула ( defaultHeaderName / defaultFooterName )
• Иметь легкий доступ к вашей базе данных PDO/другой (настроенной на config-private.php )

$app автоматически доступно в ваших представлениях для вас.

Добавление нового маршрута

Первое, что вы, вероятно, захотите сделать, это добавить новый маршрут. Для этого следуйте этим шагам:

1. Если у вас еще нет класса контроллера для вашего нового маршрута, добавьте его в папку app/Controllers проекта. Подпапки в порядке. Контроллер на самом деле не должен иметь Controller в имени, но убедитесь, что имя класса соответствует имени файла.
2. Добавьте заглушку для метода контроллера. По крайней мере, это должна быть public функция, которая принимает два параметра: $app и $request (в этом порядке).
3. Откройте routes.php и убедитесь, что вы понимаете документацию и примеры того, как работают маршруты.
4. Добавьте свой маршрут в массив routes .
   • Обязательно обозначите POST , если это необходимо.
   • Строка имени контроллера должна соответствовать имени файла и имени класса для контроллера с первого шага.
   • Если контроллер находится в подпапке (или подпапке), убедитесь, что у вас есть имя в формате Parent-Folder/Controller-Name .
   • Имя функции должно соответствовать имени функции с шага 2.
5. На этом этапе маршрут работает, но ваш метод контроллера должен вернуть какой -то yamf/Responses/Response , который может быть чем угодно, от View до ответа JSON, ну, в общем, что бы вы ни хотите, на самом деле. Смотрите следующий раздел для получения дополнительной информации здесь.
6. Ваш обычный вариант использования, вероятно, возвращает yamf/Responses/View . Создайте файл PHP (представление) в папке views - опять же, подпапки в порядке - и, в вашем методе контроллера, return new View('name/of/view'); Полем
7. Маршрут теперь должен быть функциональным!

Суммируя:

1. Добавить метод контроллера и контроллера в папку app/Controllers
2. Добавить маршрут к routes.php
3. Создайте представление в папке views если это необходимо, при необходимости
4. Изменить метод контроллера, чтобы return new View('name/of/view');

Типы возврата из функций контроллера

Все методы контроллера, которые называются в результате маршрута, должны возвращать yamf/Responses/Response или подклассы указанного класса. Вот некоторые описания того, как использовать каждый из них. Большинство из них можно использовать в одной линии только с конструктором.

• Response - базовый класс для ответа с маршрута.
  • Формат конструктора: new Response($statusCode = 200)
  • Выводит код состояния.
  • Поскольку все остальные подкласс yamf/Responses/Response из этого родительского класса могут вернуть пользовательский код состояния HTTP, если хотите!
• ErrorMessage - Простая обертка вокруг представления, чтобы отправить код состояния 400 и представление error.php.
  • Формат конструктора: new ErrorMessage($msg = '', $name = 'error', $title = '', $headerName = '', $footerName = '') . $name - это имя представления.
  • Обратите внимание, что первый параметр - это сообщение об ошибке, а не имя представления!
  • По умолчанию имя переменной для ошибки для вывода в вашем представлении - это $error . Вы не можете изменить это без подкласса.
  • По умолчанию используемые заголовка и нижний колонтитул являются views/header.php и views/footer.php .
  • Код статуса, конечно, может быть изменен.
• JsonResponse - Пример того, как вы можете отправить ответ JSON от вашего контроллера
  • Формат конструктора: new JsonResponse($data, $jsonEncodeOptions = 0)
  • Выводит $data через echo json_encode($this->data, $this->jsonEncodeOptions);
• NotFound - используется для возврата 404 не найденного сообщения обратно клиенту.
  • Формат конструктора: new NotFound($name = '404', $data = [], $title = '', $headerName = '', $footerName = '') . $name - это имя представления.
  • По умолчанию используемые заголовка и нижний колонтитул являются views/header.php и views/footer.php .
  • Если вы хотите отправить только 404 (например, для API), используйте Response .
• Redirect - позволяет перенаправить 302 на какую -то другую страницу или маршрут
  • Формат конструктора: new Redirect($redirectPath, $isInternalRedirect = true)
  • Код состояния по умолчанию равен 302
  • $isInternalRedirect используется для перенаправления на маршрут в текущем веб -сайте/ routes.php . Если вы хотите перенаправить на внутренний маршрут, используйте Redirect , например: new Redirect('/route/name); (Обратите внимание на начало / ). Если нет, используйте Redirect , например: new Redirect('https://example.com', false); Полем
• View -используется для возврата некоторого HTML-представления на основе PHP.
  • Формат конструктора: new View($name, $data = [], $title = '', $headerName = '', $footerName = '') . $name - это имя представления.
  • Чтобы отправить данные в ваш взгляд, самый простой способ - это использовать compact функцию. Смотрите образец BlogController .
  • По умолчанию используемые заголовка и нижний колонтитул являются views/header.php и views/footer.php .

Если у вас есть идеи для большего количества типов Response , которые должны быть включены в YAMF, откройте запрос на функции (через вкладку «Проблемы») или откройте запрос на привлечение!

Данные, отправленные методам контроллера

Две основные переменные отправляются в ваши методы контроллера с маршрута: $app и $request . Обратите внимание, что все выходные данные View будут иметь $app и $request , доступные для использования. Вам не нужно отправлять их в качестве параметра $data .

AppConfig $app

$app - это в основном переменные конфигурации, которые вы настраиваете в config.php . Проверьте этот файл для быстрого взгляда на то, что доступно. Некоторые из наиболее важных предметов:

• $app->db для подключения к базе данных
• Имена файлов заголовка по умолчанию для всех представлений, страницы 404 и страницы ошибки. Вы можете установить их на null , чтобы вообще не использовать их.

В дополнение к этим, есть две переменные, которые установлены в init.php :

• $app->isLocalHost -независимо от того, работает ли приложение на локальном хосте ( 127.0.0.1 или ::1 )
• $app->basePath -базовый каталог для вашего текущего веб-приложения. Это можно использовать для разрешения вложенных веб -приложений на вашем веб -сервере. Я настоятельно рекомендую использовать эту переменную в ваших views при выполнении локальных ссылок на веб -сайт, чтобы, если вы перемещаете файлы или позже перемещают вещи в подпапку, все не сломается. Чтобы ссылаться на другую страницу на вашем сайте, просто используйте функцию $app->yurl(string) (yamf url), подобная следующей: <?= $app->yurl('/path/to/page') ?> .

$request

$request будет иметь все ваши данные о вашем маршруте и различных параметрах, которые пришли с вашим запросом. Это тип yamf/Request . У него есть эти публичные члены:

• $request->route -raw route string для этого запроса
• $request->controller -название строки контроллера
• $request->function -название строки функции контроллера для вызова
• $request->routeParams -любые параметры в маршруте, такие как {id}. Формат: ['id' => value]
• $request->get -ey Get Params, найденный в URL-адресе-тот же формат, что и $ _get (не выполнена дополнительная обработка)
• $request->post -любой Post Params-тот же формат, что и $ _post (не выполнена дополнительная обработка)
• $request->anchor -если используется, # часть URL (без #). Маршрутизатор достаточно умный, чтобы не соответствовать URL -адресам, таким как /blah/#/foo .

Подкласс для расширения структуры

Самый простой способ расширить эту структуру - это извлечь из Response (или какого -то другого класса для детей Response ) и/или создать родительский класс для некоторых из ваших контроллеров. Например, выбираясь из View , вы можете изменить выходной выход для использования шаблонного двигателя TWIG вместо простого выхода PHP. Создавая родительский класс для ваших контроллеров, вы можете добавить такие вещи, как проверка или другая дополнительная обработка данных, которые должны произойти для всех ваших маршрутов API, таких как проверка имени пользователя/пароля или токена. Варианты бесконечны, а потенциал отличный!

Есть пример использования веточки вместо необработанного PHP на ветви Twig!

Статическая страница простота

Одна изящная функция, которую поддерживает YAMF, - это статические веб -страницы, которые не требуют route или controller . Если вы хотите /about просто стать простой страницей, добавьте страницу about.php в views/static/ папке и - Bam! - /about работах на вашем сайте. Как насчет подпадок, таких как /blog/post-name ? Это тоже работает! Добавьте файл views/static/blog/post-name.php и он просто работает (TM)! Вы можете использовать это, чтобы по -прежнему иметь красивые URL -адреса на вашем веб -сайте, не беспокоясь о добавлении маршрутов и контроллеров.

Вы можете настроить местоположение статических представлений в config.php .

Обратите внимание, что маршрутизатор пытается соответствовать маршруту router.php , прежде чем проверить статические страницы.

Укороченный URL

Функцией, которую поддерживает маршрутизатор, который не сразу не включен, является укорочение URL-например, https://example.com/short-url . Это требует подключения к базе данных, но если вы добавите подключение к базе данных и имеете соответствующую таблицу базы данных (схема находится в config.sample.php ), можно использовать укорочение URL, если хотите. Вы не обязаны включать эту функцию.

Логика сеанса по умолчанию

Я включил некоторую логику сеанса по умолчанию, прокомментированную в config.sample.php . Не стесняйтесь использовать его, изменить или выбросить. Если у вас есть предложения о том, как улучшить эту функциональность, пожалуйста, откройте запрос на привлечение или проблему для получения дальнейшего обсуждения.

Могу ли я помочь внести свой вклад?

Рад, что ты спросил! Всегда есть вещи, которые можно сделать на проекте с открытым исходным кодом: исправить ошибки, новые функции и многое другое! Ознакомьтесь с вкладкой «Проблемы этого репозитория» и посмотрите, какие ошибки сообщались, а какие функции были запрошены. Есть больше информации о внесении вклад в документ.

Лицензия

MIT Лицензия. Пожалуйста, обязательно включите лицензию на эту структуру (вместе со ссылкой GitHub, если вы чувствуете себя щедрым!) При использовании ее на своем сайте. Спасибо! :)

Особая благодарность

Особая благодарность Bootswatch за тема Bootstrap Paper, используемую в примере.