9 Commits
3.5.0 ... 3.7.1

9 changed files with 321 additions and 164 deletions

View File

@@ -1,14 +1,8 @@
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. Routes sorting `router::sort()`
## Installation
Execute: `composer require mirzaev/minimal`
@@ -16,49 +10,19 @@ 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
### ebala
**Repository:** https://git.mirzaev.sexy/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_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>
**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>

View File

@@ -1,14 +1,14 @@
{
"name": "mirzaev/minimal",
"type": "framework",
"description": "My vision of a good framework",
"description": "The best code-to-utility framework",
"keywords": [
"mvc",
"framework",
"lightweight"
],
"license": "WTFPL",
"homepage": "https://git.mirzaev.sexy/mirzaev/minimal",
"homepage": "https://git.svoboda.works/mirzaev/minimal",
"authors": [
{
"name": "Arsen Mirzaev Tatyano-Muradovich",
@@ -18,8 +18,8 @@
}
],
"support": {
"docs": "https://git.mirzaev.sexy/mirzaev/minimal/wiki",
"issues": "https://git.mirzaev.sexy/mirzaev/minimal/issues"
"docs": "https://git.svoboda.works/mirzaev/minimal/wiki",
"issues": "https://git.svoboda.works/mirzaev/minimal/issues"
},
"require": {
"php": "~8.4"

View File

@@ -14,7 +14,8 @@ use mirzaev\minimal\router,
mirzaev\minimal\http\enumerations\status;
// Built-in libraries
use exception,
use Closure as closure,
Exception as exception,
RuntimeException as exception_runtime,
BadMethodCallException as exception_method,
DomainException as exception_domain,
@@ -113,7 +114,27 @@ final class core
*/
public function start(): ?string
{
// Handle request and exit (success)
if (php_sapi_name() === 'cli') {
// Processing from CLI
// Initializing options
$options = getopt('', [
'method::',
'uri::',
'protocol::'
]);
// Writing method into the environment constant
$_SERVER["REQUEST_METHOD"] = $options['method'] ?? 'GET';
// Writing URI into the environment constant
$_SERVER['REQUEST_URI'] = $options['uri'] ?? '/';
// Writing verstion of HTTP protocol into the environment constant
$_SERVER['SERVER_PROTOCOL'] = $options['protocol'] ?? 'CLI';
}
// Processing the request and exit (success)
return $this->request(new request(environment: true));
}
@@ -123,30 +144,59 @@ final class core
* Handle request
*
* @param request $request The request
* @paam array $parameters parameters for merging with route parameters
* @param array $parameters parameters for merging with route parameters
*
* @return string|null Response
*/
public function request(request $request, array $parameters = []): ?string
{
// Matching a route
// Matching the route
$route = $this->router->match($request);
if ($route) {
// Initialized a route
// Initialized the route
if (!empty($parameters)) {
// Recaived parameters
// Merging parameters with route parameters
// Merging parameters with the route parameters
$route->parameters = $parameters + $route->parameters;
}
// Writing request options from route options
// Preparing the route function
$action = function() use ($request, $route): string {
// Writing the request options from the route options
$request->options = $route->options;
// Handling a route and exit (success)
return $this->route($route, $request);
// Preparing the route function
$action = fn(): string => (string) $this->route($route, $request);
foreach ($route->middlewares as $middleware) {
// Iterating over the route middlewares
// Preparing the middleware function
$action = fn(): string => $middleware(next: $action);
}
// Processing middlewares and the route functions
$response = $action();
// Exit (success)
return $response;
};
foreach ($this->router->middlewares as $middleware) {
// Iterating over the router middlewares
// Preparing the middleware function
$action = fn(): string => $middleware(next: $action);
}
// Processing middlewares and the router request function
$response = $action();
// Exit (success)
return $response;
}
// Exit (fail)
@@ -240,7 +290,6 @@ final class core
// Exit (fail)
throw new exception_runtime('Caught an error while processing the route', status::internal_server_error->value, $exception);
}
} else {
// Not found the method of the controller

View File

@@ -19,6 +19,8 @@ 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';
case cli = 'CLI';
}

View File

@@ -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
@@ -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
@@ -187,7 +187,7 @@ final class request
*/
public array $parameters {
// Write
set (array $value) {
set(array $value) {
if (isset($this->{__PROPERTY__})) {
// The property is already initialized
@@ -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
@@ -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
@@ -324,21 +324,27 @@ 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($headers)) {
// Received headers
if (isset($protocol))
$this->protocol = $protocol;
// Declaring the buffer of headers
$buffer = [];
foreach ($headers ?? [] as $name => $value) {
foreach (
match (true) {
isset($headers) => $headers,
php_sapi_name() !== 'cli' => getallheaders(),
default => []
} as $name => $value
) {
// Iterating over headers
// Normalizing name of header (https://www.rfc-editor.org/rfc/rfc7540#section-8.1.2)
@@ -355,18 +361,23 @@ final class request
$buffer[$name] = $value;
}
// Writing headers from argument into the property
if (!empty($buffer)) {
// Initialized at lease one header
// Writing headers into the property
$this->headers = $buffer;
}
// Deinitializing the buffer of headers
unset($buffer);
}
// 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
@@ -380,37 +391,7 @@ final class request
// Writing verstion of HTTP protocol from environment into the property
$this->protocol ??= $_SERVER['SERVER_PROTOCOL'];
if (!isset($headers)) {
// Received headers
// Declaring the buffer of headers
$buffer = [];
foreach (getallheaders() ?? [] as $name => $value) {
// Iterating over headers
// Normalizing name of header (https://www.rfc-editor.org/rfc/rfc7540#section-8.1.2)
$name = mb_strtolower($name, 'UTF-8');
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;
}
// Writing headers from environment into the property
$this->headers = $buffer;
// Deinitializing the buffer of headers
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
@@ -441,7 +422,10 @@ final class request
} 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 +448,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);
}
/**

View File

@@ -0,0 +1,63 @@
<?php
declare(strict_types=1);
namespace mirzaev\minimal;
// Files of the project
use mirzaev\minimal\http\request,
mirzaev\minimal\route;
// Built-in libraries
use Closure as closure;
/**
* Middleware
*
* @see https://en.wikipedia.org/wiki/Middleware Middlewares
*
* @package mirzaev\minimal
*
* @param closure $function Function
*
* @method void __construct(closure $function) Constructor
*
* @license http://www.wtfpl.net/ Do What The Fuck You Want To Public License
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
final class middleware
{
/**
* Function
*
* @var closure $function Function
*/
public readonly closure $function;
/**
* Constructor
*
* @param closure $function Function
*
* @return void
*/
public function __construct(closure $function)
{
// Writing the function
$this->function = $function;
}
/**
* Invoke
*
* @param callable $next
*
* @return string Output
*/
public function __invoke(callable $next): string
{
// Processing the middleware (entering into recursion)
return (string) ($this->function)(next: $next);
}
}

View File

@@ -4,6 +4,11 @@ declare(strict_types=1);
namespace mirzaev\minimal;
// Files of the project
use mirzaev\minimal\controller,
mirzaev\minimal\middleware,
mirzaev\minimal\traits\middleware as middleware_trait;
/**
* Route
*
@@ -14,14 +19,18 @@ namespace mirzaev\minimal;
* @param string|model $model Name of the model
* @param array $parameters Arguments for the $this->method (will be concatenated together with generated request parameters)
* @param array $options Options for `request_parse_body($options)`
* @param array $middlewares Stack of middlewares
*
* @method void __construct(string|controller $controller, ?string $method, string|model|null $model, array $parameters, array $options) Constructor
* @method void __construct(string|controller $controller, ?string $method, string|model|null $model, array $parameters, array $options, array $middlewares) Constructor
* @method self middleware(middleware $middleware) Middleware
*
* @license http://www.wtfpl.net/ Do What The Fuck You Want To Public License
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
final class route
{
use middleware_trait;
/**
* Controller
*
@@ -37,7 +46,7 @@ final class route
*
* @var string $method Name of the method of the method of $this->controller
*/
public string $method{
public string $method {
// Read
get => $this->method;
}
@@ -69,8 +78,8 @@ final class route
*
* Required if $this->method !== method::post
*
* @see https://wiki.php.net/rfc/rfc1867-non-post about request_parse_body()
* @see https://wiki.php.net/rfc/property-hooks (find a table about backed and virtual hooks)
* @see https://wiki.php.net/rfc/rfc1867-non-post About request_parse_body()
* @see https://wiki.php.net/rfc/property-hooks Hooks (find a table about backed and virtual hooks)
*
* @throws exception_runtime if reinitialize the property
*
@@ -78,7 +87,7 @@ final class route
*/
public array $options {
// Write
set (array $value) {
set(array $value) {
if (isset($this->{__PROPERTY__})) {
// The property is already initialized
@@ -113,6 +122,7 @@ final class route
* @param string|model|null $model Name of the model
* @param array $parameters Arguments for the $method (will be concatenated together with generated request parameters)
* @param array $options Options for `request_parse_body` (Only for POST method)
* @param array $middlewares Middlewares stack
*
* @return void
*/
@@ -121,7 +131,8 @@ final class route
?string $method = 'index',
string|model|null $model = null,
array $parameters = [],
array $options = []
array $options = [],
array $middlewares = []
) {
// Writing name of the controller
$this->controller = $controller;
@@ -135,6 +146,32 @@ final class route
// Writing parameters
$this->parameters = $parameters;
// Declaring the register of the middlewares stack validity
$stack = true;
foreach ($middlewares as $middleware) {
// Iterating over middlewares
if ($middleware instanceof middleware) {
// Initialized the middleware
} else {
// Not initialized the middleware
// Writing the register of the middlewares stack validity
$stack = false;
// Exit (fail)
break;
}
}
if ($stack) {
// The middlewares stack is valid
// Writing the middlewares stack
$this->middlewares = $middlewares;
}
// Writing options
if (match ($method) {
'GET', 'PUT', 'PATCH', 'DELETE' => true,

View File

@@ -7,7 +7,8 @@ namespace mirzaev\minimal;
// Files of the project
use mirzaev\minimal\route,
mirzaev\minimal\http\request,
mirzaev\minimal\traits\singleton;
mirzaev\minimal\traits\singleton,
mirzaev\minimal\traits\middleware as middleware_trait;
// Build-ing libraries
use InvalidArgumentException as exception_argument;
@@ -21,15 +22,17 @@ use InvalidArgumentException as exception_argument;
*
* @method self write(string $urn, route $route, string|array $method) Write route to registry of routes (fluent interface)
* @method route|null match(request $request) Match request URI with registry of routes
* @method self sort() Sort routes (DEV)
* @method self sort() Sort routes (DEVELOPMENT)
* @method string universalize(string $urn) Universalize URN
* @method self middleware(middleware $middleware) Middleware
* @param array $middlewares Stack of middlewares
*
* @license http://www.wtfpl.net/ Do What The Fuck You Want To Public License
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
final class router
{
use singleton;
use singleton, middleware_trait;
/**
* Routes

View File

@@ -0,0 +1,53 @@
<?php
declare(strict_types=1);
namespace mirzaev\minimal\traits;
// Files of the project
use mirzaev\minimal\middleware as instance;
/**
* Trait of middleware
*
* @see https://en.wikipedia.org/wiki/Middleware Middlewares
*
* @package mirzaev\minimal\traits
*
* @param array $middlewares Stack of middlewares
*
* @method self middleware(middleware $middleware) Middleware
*
* @license http://www.wtfpl.net/ Do What The Fuck You Want To Public License
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
trait middleware
{
/**
* Middlewares
*
* @var array $middlewares The middlewares stack
*/
public array $middlewares = [] {
// Read
&get => $this->middlewares;
}
/**
* Middleware
*
* Write the middleware into the middlewares stack
*
* @param instance $middleware The middleware
*
* @return self The instance from which the method was called (fluent interface)
*/
public function middleware(instance $middleware): self
{
// Writing into the middlewares stack
$this->middlewares[] = $middleware;
// Exit (success)
return $this;
}
}