Table of contents

Documentation



#Foreword

Introduction. A preface for studying the HLEB2 framework.


#Installation and Setup

Project Installation. Methods for deploying the project.

Framework Configuration. Basic configuration settings for the framework.

Configuration Parameters. Main global settings.


#Project Structure

Project Structure. An overview of the project's directories.


#Running the Application

PHP Server. The built-in PHP server.

Nginx. Using the popular web server.

Apache. A time-tested HTTP server.

RoadRunner. An asynchronous web server in Go.

Swoole. An asynchronous server as a PHP extension.

Hosting. Specifics of installing on hosting environments.


#Routing

Routing. Handlers for page address routes.


#Controllers

Controller. A standard class for route handling.

Module. An isolated part of the project.

Middleware. An auxiliary class for handling requests.


#Models

Model. The MVC component responsible for data.


#Templates

Standard Templates. Data structures returned.

Cached Templates. Utilizing template caching.

TWIG Template Engine. An alternative templating engine for the framework.


#Console Commands

Console Commands. Tasks to run from the terminal.


#Container

Container Structure. Accessing services.

Getting a Service. Ways to utilize the container.

Dependency Injection. DI implementation within the framework.


#Services

Request. An object for managing request data.

Response. Formulating return data.

Cache. File-based data caching.

Log. A universal logging mechanism.

Path. A manager for relative paths.

DB. A basic wrapper over PHP PDO.

Session. Convenient handling of HTTP sessions.

Cookies. Receiving and sending cookies.

Redirect. Redirecting to another page.

Router. Interacting with routing data.

Settings. Various framework settings.

Csrf. Cross-site request forgery protection.

Converter. Conversion to PSR standards.


#Events

Events. Supporting the execution of actions.


Additional

Special features of the framework that can be useful in certain cases.


#Console Commands

Custom Command Names, including shortcuts.

Customizable Command Parameters. Named arguments.

MVC Template Console Generation (Model-View-Controller).


#Asynchronous

Resetting State for asynchronous requests.


#Container and Services

Adding a Service to the Container. On a real example.

Overriding a Standard Service or removing it.

Custom usage of the container. More complex examples.


#Web Console

Web Console. A secured HTTP terminal.


#Testing

Testing framework-based software structures.


#Extensions

HLOGIN - Registration Module and authentication.

Administrative Panel Module or public site.

Traits for API Creation. Pagination and validator.


#Functions

Built-in functions of the framework.


#Project Information

Project Information as an afterword.



Back to top
;