forked from mirzaev/minimal
Compare commits
8 Commits
Author | SHA1 | Date | |
---|---|---|---|
e93ea5825e | |||
c841250933 | |||
beaf55f00b | |||
7ae1d6ac70 | |||
d9e4e0af6c | |||
d5f4955070 | |||
74c3decaa6 | |||
e9f7cd39b6 |
72
README.md
72
README.md
@@ -1,14 +1,10 @@
|
||||
The MINIMAL framework that does **not limit your project with its own rules**, has **no dependencies**, implements the **best practices** of popular MVC-frameworks, it **VERY fast** and **optimized** for all the innovations in **PHP 8.2** 🤟
|
||||
# MINIMAL
|
||||
The best code-to-utility Framework
|
||||
|
||||
Can be configured to work with **any database** `core::$session` and **any HTML template engine** `$this->view`
|
||||
*personally, i prefer **ArangoDB** and **Twig***
|
||||
|
||||
## Nearest plans (first half of 2025)
|
||||
1. Add **middlewares** technology
|
||||
2. Route sorting in the router `router::sort()`
|
||||
3. Add trigger routes from within routes
|
||||
4. Think about adding asynchronous executions
|
||||
5. Write an article describing the principles of the framework
|
||||
## Nearest plans (2025)
|
||||
1. **Middlewares** technology
|
||||
2. Route sorting `router::sort()`
|
||||
3. Processing routes from within routes (request emulation)
|
||||
|
||||
## Installation
|
||||
Execute: `composer require mirzaev/minimal`
|
||||
@@ -16,49 +12,37 @@ Execute: `composer require mirzaev/minimal`
|
||||
## Usage
|
||||
*index.php*
|
||||
```php
|
||||
// Initializing the router
|
||||
$router = new router;
|
||||
|
||||
// Initializing of routes
|
||||
$router
|
||||
->write('/', 'catalog', 'index', 'GET')
|
||||
->write('/search', 'catalog', 'search', 'POST')
|
||||
->write('/session/connect/telegram', 'session', 'telegram', 'POST')
|
||||
->write('/product/$id', 'catalog', 'product', 'POST')
|
||||
->write('/$categories...', 'catalog', 'index', 'POST'); // Collector (since 0.3.0)
|
||||
|
||||
// Initializing the core
|
||||
$core = new core(namespace: __NAMESPACE__, router: $router, controller: new controller(false), model: new model(false));
|
||||
$core = new core(namespace: __NAMESPACE__);
|
||||
|
||||
// Handle the request
|
||||
echo $core->start();
|
||||
// Initializing routes
|
||||
$core->router
|
||||
->write('/', new route('index', 'index'), 'GET')
|
||||
->write('/search', new route('search', 'search'), 'POST')
|
||||
->write('/product/create', new route('product', 'create'), 'PUT')
|
||||
->write('/product/$id', new route('product', 'read'), 'GET')
|
||||
->write('/product/$id', new route('product', 'read'), 'POST')
|
||||
->write('/$categories', new route('categories', 'read'), 'GET') // Collector (since 0.3.0)
|
||||
;
|
||||
|
||||
// Handling the request
|
||||
$core->start();
|
||||
```
|
||||
|
||||
## Examples of projects based on MINIMAL
|
||||
## Projects based on MINIMAL
|
||||
|
||||
### ebala
|
||||
**Repository:** https://git.mirzaev.sexy/mirzaev/ebala<br>
|
||||
**Repository:** https://git.svoboda.works/mirzaev/ebala<br>
|
||||
**Github mirror:** https://github.com/mature-woman/ebala<br>
|
||||
*I earned more than a **million rubles** from this project*<br>
|
||||
*Repositories **may** be closed at the request of the customer*<br>
|
||||
|
||||
### huesos
|
||||
**Repository:** https://git.mirzaev.sexy/mirzaev/huesos<br>
|
||||
**Guthub mirror:** https://github.com/mature-woman/huesos<br>
|
||||
*The basis for developing chat-robots with Web App technology (for example for Telegram)*<br>
|
||||
### Arming
|
||||
**Repository:** https://git.svoboda.works/weby/arming<br>
|
||||
**Guthub mirror:** https://github.com/WEBY-GROUP/arming<br>
|
||||
*Telegram chat-robot marketplace*<br>
|
||||
|
||||
### arming_bot
|
||||
**Repository:** https://git.mirzaev.sexy/mirzaev/arming_bot<br>
|
||||
**Guthub mirror:** https://github.com/mature-woman/arming_bot<br>
|
||||
*Chat-robot based on huesos*<br>
|
||||
|
||||
### notchat
|
||||
**Repository:** https://git.mirzaev.sexy/mirzaev/notchat<br>
|
||||
### not.chat
|
||||
**Repository:** https://git.svoboda.works/mirzaev/notchat<br>
|
||||
**Github mirror:** https://github.com/mature-woman/notchat<br>
|
||||
*P2P chat project with different blockchains and smart stuff*<br>
|
||||
|
||||
### site-repression
|
||||
**Link:** https://repression.mirzaev.sexy<br>
|
||||
**Repository:** https://git.mirzaev.sexy/mirzaev/site-repression<br>
|
||||
**Github mirror:** https://github.com/mature-woman/site-repression<br>
|
||||
*A simple site for my article about **political repressions in Russia** and my **kidnapping by Wagner PMC operatives** from my house*<br>
|
||||
*P2P chat project with blockchains and smart stuff*<br>
|
||||
|
@@ -195,36 +195,36 @@ final class core
|
||||
unset($controller);
|
||||
|
||||
if (!isset($route->controller->model)) {
|
||||
//
|
||||
// Not initialized the model in the controller
|
||||
|
||||
// Initializing name if the model class
|
||||
$model = $route->model;
|
||||
// Initializing name if the model class
|
||||
$model = $route->model;
|
||||
|
||||
if ($route->model instanceof model) {
|
||||
// Initialized the model
|
||||
} else if (class_exists($model = "$this->namespace\\models\\$model")) {
|
||||
// Found the model by its name
|
||||
if ($route->model instanceof model) {
|
||||
// Initialized the model
|
||||
} else if (class_exists($model = "$this->namespace\\models\\$model")) {
|
||||
// Found the model by its name
|
||||
|
||||
// Initializing the model
|
||||
$route->model = new $model;
|
||||
} else if (!empty($route->model)) {
|
||||
// Not found the model and $route->model has a value
|
||||
// Initializing the model
|
||||
$route->model = new $model;
|
||||
} else if (!empty($route->model)) {
|
||||
// Not found the model and $route->model has a value
|
||||
|
||||
// Exit (fail)
|
||||
throw new exception_domain("Failed to find the model: $model", status::not_implemented->value);
|
||||
// Exit (fail)
|
||||
throw new exception_domain("Failed to find the model: $model", status::not_implemented->value);
|
||||
}
|
||||
|
||||
// Deinitializing name of the model class
|
||||
unset($model);
|
||||
|
||||
if ($route->model instanceof model) {
|
||||
// Initialized the model
|
||||
|
||||
// Writing the model to the controller
|
||||
$route->controller->model = $route->model;
|
||||
}
|
||||
}
|
||||
|
||||
// Deinitializing name of the model class
|
||||
unset($model);
|
||||
|
||||
if ($route->model instanceof model) {
|
||||
// Initialized the model
|
||||
|
||||
// Writing the model to the controller
|
||||
$route->controller->model = $route->model;
|
||||
}
|
||||
}
|
||||
|
||||
// Writing the request to the controller
|
||||
$route->controller->request = $request;
|
||||
|
||||
@@ -234,11 +234,11 @@ final class core
|
||||
try {
|
||||
// Executing method of the controller and exit (success)
|
||||
return $route->controller->{$route->method}(...($route->parameters + $request->parameters));
|
||||
} catch (exception $e) {
|
||||
} catch (exception $exception) {
|
||||
// Catched an exception
|
||||
|
||||
// Exit (fail)
|
||||
throw new exception_runtime(...$e);
|
||||
throw new exception_runtime('Caught an error while processing the route', status::internal_server_error->value, $exception);
|
||||
}
|
||||
|
||||
} else {
|
||||
|
@@ -115,6 +115,7 @@ enum content: string
|
||||
return match ($this) {
|
||||
self::jpeg => 'jpg',
|
||||
self::png => 'png',
|
||||
self::webp => 'webp',
|
||||
self::form, self::mixed, self::alternative, self::related => throw new exception_argument('Content can not have file extension', status::internal_server_error->value),
|
||||
default => throw new exception_domain('Failed to recognize content: ' . $this->value, status::not_found->value)
|
||||
};
|
||||
|
@@ -19,6 +19,6 @@ enum protocol: string
|
||||
case http_3 = 'HTTP/3.0';
|
||||
case http_2 = 'HTTP/2.0';
|
||||
case http_1_1 = 'HTTP/1.1';
|
||||
case http_1 = 'hTTP/1.0';
|
||||
case http_1 = 'HTTP/1.0';
|
||||
case http_0_9 = 'HTTP/0.9';
|
||||
}
|
||||
|
@@ -6,16 +6,16 @@ namespace mirzaev\minimal\http;
|
||||
|
||||
// Files of the project
|
||||
use mirzaev\minimal\http\enumerations\method,
|
||||
mirzaev\minimal\http\enumerations\protocol,
|
||||
mirzaev\minimal\http\enumerations\status,
|
||||
mirzaev\minimal\http\enumerations\content,
|
||||
mirzaev\minimal\http\response;
|
||||
mirzaev\minimal\http\enumerations\protocol,
|
||||
mirzaev\minimal\http\enumerations\status,
|
||||
mirzaev\minimal\http\enumerations\content,
|
||||
mirzaev\minimal\http\response;
|
||||
|
||||
// Built-in libraries
|
||||
use DomainException as exception_domain,
|
||||
InvalidArgumentException as exception_argument,
|
||||
RuntimeException as exception_runtime,
|
||||
LogicException as exception_logic;
|
||||
InvalidArgumentException as exception_argument,
|
||||
RuntimeException as exception_runtime,
|
||||
LogicException as exception_logic;
|
||||
|
||||
/**
|
||||
* Request
|
||||
@@ -51,7 +51,7 @@ final class request
|
||||
*/
|
||||
public method $method {
|
||||
// Write
|
||||
set (method|string $value) {
|
||||
set(method|string $value) {
|
||||
if (isset($this->{__PROPERTY__})) {
|
||||
// The property is already initialized
|
||||
|
||||
@@ -61,23 +61,23 @@ final class request
|
||||
|
||||
if ($value instanceof method) {
|
||||
// Received implementation of the method
|
||||
|
||||
|
||||
// Writing
|
||||
$this->method = $value;
|
||||
} else {
|
||||
// Received a string literal (excected name of the method)
|
||||
|
||||
|
||||
// Initializing implementator of the method
|
||||
$method = method::{strtolower($value)};
|
||||
|
||||
if ($method instanceof method) {
|
||||
// Initialized implementator of the method
|
||||
|
||||
|
||||
// Writing
|
||||
$this->method = $method;
|
||||
} else {
|
||||
// Not initialized implementator of the method
|
||||
|
||||
|
||||
// Exit (fail)
|
||||
throw new exception_domain('Failed to recognize method: ' . $value, status::not_implemented->value);
|
||||
}
|
||||
@@ -96,7 +96,7 @@ final class request
|
||||
*/
|
||||
public string $uri {
|
||||
// Write
|
||||
set (string $value) {
|
||||
set(string $value) {
|
||||
if (isset($this->{__PROPERTY__})) {
|
||||
// The property is already initialized
|
||||
|
||||
@@ -121,7 +121,7 @@ final class request
|
||||
*/
|
||||
public protocol $protocol {
|
||||
// Write
|
||||
set (protocol|string $value) {
|
||||
set(protocol|string $value) {
|
||||
if (isset($this->{__PROPERTY__})) {
|
||||
// The property is already initialized
|
||||
|
||||
@@ -131,23 +131,23 @@ final class request
|
||||
|
||||
if ($value instanceof protocol) {
|
||||
// Received implementation of HTTP version
|
||||
|
||||
|
||||
// Writing
|
||||
$this->protocol = $value;
|
||||
} else {
|
||||
// Received a string literal (excected name of HTTP version)
|
||||
|
||||
|
||||
// Initializing implementator of HTTP version
|
||||
$protocol = protocol::tryFrom($value);
|
||||
|
||||
if ($protocol instanceof protocol) {
|
||||
// Initialized implementator of HTTP version
|
||||
|
||||
|
||||
// Writing
|
||||
$this->protocol = $protocol;
|
||||
} else {
|
||||
// Not initialized implementator of HTTP version
|
||||
|
||||
|
||||
// Exit (fail)
|
||||
throw new exception_domain('Failed to recognize HTTP version: ' . $value, status::http_version_not_supported->value);
|
||||
}
|
||||
@@ -187,16 +187,16 @@ final class request
|
||||
*/
|
||||
public array $parameters {
|
||||
// Write
|
||||
set (array $value) {
|
||||
set(array $value) {
|
||||
if (isset($this->{__PROPERTY__})) {
|
||||
// The property is already initialized
|
||||
|
||||
// Exit (fail)
|
||||
throw new exception_runtime('The property is already initialized: ' . __PROPERTY__, status::internal_server_error->value);
|
||||
}
|
||||
|
||||
|
||||
// Writing
|
||||
$this->parameters = $value;
|
||||
$this->parameters = $value;
|
||||
}
|
||||
|
||||
// Read
|
||||
@@ -222,7 +222,7 @@ final class request
|
||||
*/
|
||||
public array $files {
|
||||
// Write
|
||||
set (array $value) {
|
||||
set(array $value) {
|
||||
if (isset($this->{__PROPERTY__})) {
|
||||
// The property is already initialized
|
||||
|
||||
@@ -233,14 +233,14 @@ final class request
|
||||
if (isset($this->method)) {
|
||||
// Initialized method
|
||||
|
||||
if ($this->method->body()) {
|
||||
if ($this->method->body()) {
|
||||
// Request with this method can has body
|
||||
|
||||
// Writing
|
||||
$this->files = $value;
|
||||
$this->files = $value;
|
||||
} else {
|
||||
// Request with this method can not has body
|
||||
|
||||
|
||||
// Exit (fail)
|
||||
throw new exception_logic('Request with ' . $this->method->value . ' method can not has body therefore can not has files', status::internal_server_error->value);
|
||||
}
|
||||
@@ -270,7 +270,7 @@ final class request
|
||||
*/
|
||||
public array $options {
|
||||
// Write
|
||||
set (array $value) {
|
||||
set(array $value) {
|
||||
if (isset($this->{__PROPERTY__})) {
|
||||
// The property is already initialized
|
||||
|
||||
@@ -280,16 +280,16 @@ final class request
|
||||
|
||||
// Writing
|
||||
$this->options = array_filter(
|
||||
$value,
|
||||
fn(string $key) => match ($key) {
|
||||
'post_max_size',
|
||||
'max_input_vars',
|
||||
'max_multipart_body_parts',
|
||||
'max_file_uploads',
|
||||
'upload_max_filesize' => true,
|
||||
default => throw new exception_domain("Failed to recognize option: $key", status::internal_server_error->value)
|
||||
},
|
||||
ARRAY_FILTER_USE_KEY
|
||||
$value,
|
||||
fn(string $key) => match ($key) {
|
||||
'post_max_size',
|
||||
'max_input_vars',
|
||||
'max_multipart_body_parts',
|
||||
'max_file_uploads',
|
||||
'upload_max_filesize' => true,
|
||||
default => throw new exception_domain("Failed to recognize option: $key", status::internal_server_error->value)
|
||||
},
|
||||
ARRAY_FILTER_USE_KEY
|
||||
);
|
||||
}
|
||||
|
||||
@@ -324,17 +324,20 @@ final class request
|
||||
bool $environment = false
|
||||
) {
|
||||
// Writing method from argument into the property
|
||||
if (isset($method)) $this->method = $method;
|
||||
if (isset($method))
|
||||
$this->method = $method;
|
||||
|
||||
// Writing URI from argument into the property
|
||||
if (isset($uri)) $this->uri = $uri;
|
||||
if (isset($uri))
|
||||
$this->uri = $uri;
|
||||
|
||||
// Writing verstion of HTTP protocol from argument into the property
|
||||
if (isset($protocol)) $this->protocol = $protocol;
|
||||
if (isset($protocol))
|
||||
$this->protocol = $protocol;
|
||||
|
||||
if (isset($headers)) {
|
||||
// Received headers
|
||||
|
||||
|
||||
// Declaring the buffer of headers
|
||||
$buffer = [];
|
||||
|
||||
@@ -346,10 +349,10 @@ final class request
|
||||
|
||||
if (empty($name)) {
|
||||
// Not normalized name of header
|
||||
|
||||
|
||||
// Exit (fail)
|
||||
throw new exception_domain('Failed to normalize name of header', status::internal_server_error->value);
|
||||
}
|
||||
}
|
||||
|
||||
// Writing into the buffer of headers
|
||||
$buffer[$name] = $value;
|
||||
@@ -363,10 +366,12 @@ final class request
|
||||
}
|
||||
|
||||
// Writing parameters from argument into the property
|
||||
if (isset($parameters)) $this->parameters = $parameters;
|
||||
if (isset($parameters))
|
||||
$this->parameters = $parameters;
|
||||
|
||||
// Writing files from argument into the property
|
||||
if (isset($files)) $this->files = $files;
|
||||
if (isset($files))
|
||||
$this->files = $files;
|
||||
|
||||
if ($environment) {
|
||||
// Requested to write values from environment
|
||||
@@ -382,7 +387,7 @@ final class request
|
||||
|
||||
if (!isset($headers)) {
|
||||
// Received headers
|
||||
|
||||
|
||||
// Declaring the buffer of headers
|
||||
$buffer = [];
|
||||
|
||||
@@ -394,10 +399,10 @@ final class request
|
||||
|
||||
if (empty($name)) {
|
||||
// Not normalized name of header
|
||||
|
||||
|
||||
// Exit (fail)
|
||||
throw new exception_domain('Failed to normalize name of header', status::internal_server_error->value);
|
||||
}
|
||||
}
|
||||
|
||||
// Writing into the buffer of headers
|
||||
$buffer[$name] = $value;
|
||||
@@ -410,7 +415,7 @@ final class request
|
||||
unset($buffer);
|
||||
}
|
||||
|
||||
if ($this->headers['content-type'] === content::json->value) {
|
||||
if (str_starts_with($this->headers['content-type'] ?? '', content::json->value)) {
|
||||
// The body contains "application/json"
|
||||
|
||||
// Initializing data from the input buffer
|
||||
@@ -438,10 +443,13 @@ final class request
|
||||
|
||||
// Writing files from environment into the property
|
||||
$this->files = $_FILES ?? [];
|
||||
} else if ($this->method->body()) {
|
||||
} else if ($this->method->body()) {
|
||||
// Non POST method and can has body
|
||||
|
||||
if (match($this->headers['content-type']) { content::form->value, content::encoded->value => true, default => false }) {
|
||||
if (
|
||||
str_starts_with($this->headers['content-type'], content::form->value) ||
|
||||
str_starts_with($this->headers['content-type'], content::encoded->value)
|
||||
) {
|
||||
// Non POST method and the body content type is "multipart/form-data" or "application/x-www-form-urlencoded"
|
||||
|
||||
// Writing parameters and files from environment into the properties
|
||||
@@ -464,8 +472,10 @@ final class request
|
||||
}
|
||||
|
||||
// Validating of required properties
|
||||
if (empty($this->method)) throw new exception_argument('Failed to initialize method of the request', status::internal_server_error->value);
|
||||
if (empty($this->uri)) throw new exception_argument('Failed to initialize URI of the request', status::internal_server_error->value);
|
||||
if (empty($this->method))
|
||||
throw new exception_argument('Failed to initialize method of the request', status::internal_server_error->value);
|
||||
if (empty($this->uri))
|
||||
throw new exception_argument('Failed to initialize URI of the request', status::internal_server_error->value);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -475,13 +485,13 @@ final class request
|
||||
*
|
||||
* @return response Reponse for request
|
||||
*/
|
||||
public function response(): response
|
||||
public function response(): response
|
||||
{
|
||||
// Exit (success)
|
||||
return new response(protocol: $this->protocol, status: status::ok);
|
||||
}
|
||||
|
||||
/**
|
||||
/**
|
||||
* Header
|
||||
*
|
||||
* Write a header to the headers property
|
||||
@@ -493,7 +503,7 @@ final class request
|
||||
*
|
||||
* @return self The instance from which the method was called (fluent interface)
|
||||
*/
|
||||
public function header(string $name, string $value): self
|
||||
public function header(string $name, string $value): self
|
||||
{
|
||||
// Normalizing name of header and writing to the headers property (https://www.rfc-editor.org/rfc/rfc7540#section-8.1.2)
|
||||
$this->headers[mb_strtolower($name, 'UTF-8')] = $value;
|
||||
|
@@ -320,7 +320,7 @@ final class response
|
||||
*/
|
||||
public function validate(request $request): self|false
|
||||
{
|
||||
if (str_contains($request->headers['accept'], $this->headers['content-type'] ?? '')) {
|
||||
if (str_contains($request->headers['accept'] ?? '', $this->headers['content-type'] ?? '')) {
|
||||
// Validated with "accept" and "content-type"
|
||||
|
||||
// Exit (success)
|
||||
@@ -453,10 +453,10 @@ final class response
|
||||
flush();
|
||||
|
||||
// Deinitializing headers property
|
||||
unset($this->headers);
|
||||
$this->headers = [];
|
||||
|
||||
// Deinitializing headers
|
||||
header_remove();
|
||||
/* header_remove(); */
|
||||
|
||||
// Exit (success)
|
||||
return $this;
|
||||
|
Reference in New Issue
Block a user