CML Framework

CML - Framework [PHP]

Эта структура представляет собой мощный инструмент, который плавно объединяет эффективную систему маршрутизации с HTML -строителем, предоставляя вам многочисленные варианты настройки для ваших веб -маршрутов и страниц. Более того, он предлагает простой и надежный способ подключения к базам данных, что делает управление данными на бриз. Эта структура также оснащена различными встроенными функциями для упрощения процесса программирования. Кроме того, комплексная онлайн -документация гарантирует, что вы всегда можете вернуться к ней для руководства.

Оглавление

• Документация
• Начиная
  • Установка
• Функции
  • Маршрутизатор
  • ДБ
  • Htmlbuilder

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

https://docs.callmeleon.de/

Начиная

Установка

composer create-project callmeleon167/cml-framework my-app

или

• Клонировать репо
• Установить композитор
• Запустите Build.sh
• Дублируйте файл cml-config.template.php в каталоге App/Config, а затем удалите расширение .template из имени файла, чтобы получить файл cml-config.php
• Настройте свои настройки, и все готово!

Функции

Маршрутизатор

Класс Router в этом коде PHP предоставляет мощную и гибкую систему маршрутизации для веб -приложений. Вот основные функции и возможности:

1. Обработка маршрута: класс управляет определенными маршрутами, позволяя вам отображать URL -адреса с конкретными функциями обратного вызова на основе методов HTTP -запроса (Get, Post и т. Д.).

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

3. Обработка ошибок: класс обрабатывает 404 ошибок путем перенаправления на указанный URL и предоставляет четкое сообщение об ошибке, когда маршрут не найден.

4.

5. Псевдонимы маршрута: псевдонимы маршрута могут быть установлены для более удобных URL-адресов, а оригинальный URL может быть извлечен из псевдонима.

6. Заголовки безопасности: класс устанавливает важные заголовки безопасности, повышая безопасность вашего веб -приложения. Эти заголовки включают Политику безопасности контента (CSP), X-контент-тип-OPTIONS, X-FRAME-OPTIONS, X-XSS-защита, строгая транспортная безопасность HTTP (HSTS) и политика рефералов.

7. Обработка параметров маршрута.

8. Маршрутизация AJAX: маршруты могут быть настроены как доступные только с помощью запросов AJAX.

9. Обработка параметров запроса: класс предоставляет метод фильтрации и извлечения параметров запроса из текущего URI запроса.

10. Обработка среды: она инициализирует конфигурации отчетности об ошибках на основе среды (производство или разработка) и использует файлы .ENV для конфигурации.

11. Поддержка API: вы можете установить маршрут в качестве маршрута API, возвращая ответы в формате JSON.

12. Ограничение ставок: ограничение скорости на основе IP -адресов поддерживается для предотвращения злоупотреблений и чрезмерных запросов.

13. Интеграция с HTMLBuilder: класс расширяет класс HTMLBuilder, позволяя вам работать с шаблонами HTML и создавать веб -страницы.

Эти функции делают универсальный инструмент класса маршрутизатора для создания веб -приложений с гибкой маршрутизацией, улучшенной безопасностью и обработкой ошибок. Он упрощает управление маршрутами, средним уровнем и заголовками безопасности, поддерживая различные методы запроса HTTP и запросы AJAX.

ДБ

Класс DB в этом коде PHP предоставляет функции для взаимодействия с базой данных. Вот описание функции для вашего github readme.md:

1. Соединение базы данных: класс устанавливает соединение с базой данных, позволяя вам выполнять запросы SQL.

2. Загрузка переменной среды: он загружает переменные среды из файла .env для конфигурации базы данных.

3. Управление соединением:

• Он может переключаться между различными подключениями к базе данных, позволяя вам работать с несколькими базами данных.
• Он предоставляет возможность восстановить подключение к базе данных по умолчанию.

4. Выполнение запроса SQL:

• Класс позволяет вам выполнять запросы SQL и получить результаты в качестве массива.
• Он поддерживает параметризованные запросы, повышение безопасности и предотвращение инъекции SQL.

5. SQL -запрос из файла: Вы можете выполнить SQL -запросы, хранящиеся в файле, предоставляя удобный способ управления и запуска сложных запросов.

6. Генерация ответов JSON: класс может выполнять запросы SQL и вернуть результаты в виде строк, кодируемых JSON, что делает его подходящим для строительства API. Входные данные дезинфицировались: класс включает в себя методы очистки входных данных для предотвращения проблем безопасности, таких как инъекция SQL.

7. Декодирование объектов HTML: вы можете декодировать HTML -сущности в строке, что полезно при работе с HTML -контентом.

Класс DB упрощает взаимодействие базы данных, поддерживает параметризованные запросы для безопасности и может управлять несколькими подключениями к базе данных. Это ценный инструмент для работы с базами данных и эффективной и надежной выполнения запросов SQL.

Htmlbuilder

Класс HTMLBuilder предназначен для оказания помощи в построении HTML -документов. Вот описание функции для вашего github readme.md:

1. Структура документа: он генерирует основную структуру HTML -документа, включая элементы <!DOCTYPE html> , <html> , <head> и <body> .

2. Название и FAVICON:

• Вы можете установить заголовок документа HTML, используя метод setTitle .
• Класс включает значок по умолчанию.

3. Стили и сценарии:

• Это позволяет добавлять внешние таблицы стилей и файлы JavaScript в документ HTML.
• Эти активы связаны с документом с соответствующими тегами HTML.

4 assetUrl

5. Комментарии для читаемости:

• Он генерирует комментарии для документа HTML, включая центрированное приветственное сообщение и информацию о проекте и его программистах.
• Комментарии предоставляют визуально привлекательное и информативное введение в исходный код.

6. Центр center_comment

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

Этот класс полезен для быстрого создания хорошо структурированных документов HTML, включая настройки, добавление стилей и сценариев, а также улучшение читаемости с помощью привлекательных комментариев. Он обеспечивает элегантный и информативный начало вашего исходного кода HTML. При использовании в сочетании с классом Router вы можете легко создавать динамические веб -приложения и веб -сайты.