13 Commits
3.1.0 ... 3.7.1

18 changed files with 479 additions and 243 deletions

0
LICENSE Normal file → Executable file
View File

70
README.md Normal file → Executable file
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

@@ -11,12 +11,15 @@ use mirzaev\minimal\model,
mirzaev\minimal\http\request,
mirzaev\minimal\http\enumerations\status;
// Build-in libraries
use exception;
// Built-in libraries
use exception,
RuntimeException as exception_runtime;
/**
* Controller
*
* @package mirzaev\minimal
*
* @var core $core An instance of the core
* @var request $request Request
* @var model $model An instance of the model connected in the core
@@ -24,8 +27,6 @@ use exception;
*
* @method void __construct(core $core) Constructor
*
* @package mirzaev\minimal
*
* @license http://www.wtfpl.net/ Do What The Fuck You Want To Public License
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
@@ -56,12 +57,32 @@ class controller
/**
* Model
*
* @throws exception_runtime if reinitialize the property
* @throws exception_runtime if an attempt to write null
*
* @var model $model An instance of the model connected in the core
*/
public model $model {
public ?model $model = null {
// Write
set (model $model) {
$this->model ??= $model;
set (model|null $model) {
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);
}
if ($model instanceof model) {
// Validated model
// Writing
$this->model = $model;
} else {
// Not validated model
// Exit (fail)
throw new exception_runtime('The property must be an instance of model', status::internal_server_error->value);
}
}
// Read

View File

@@ -14,7 +14,9 @@ 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,
InvalidArgumentException as exception_argument,
@@ -25,6 +27,8 @@ use exception,
/**
* Core
*
* @package mirzaev\minimal
*
* @param string $namespace Namespace where the core was initialized from
* @param controller $controller An instance of the controller
* @param model $model An instance of the model
@@ -36,8 +40,6 @@ use exception,
* @method string|null request(request $request, array $parameters = []) Handle request
* @method string|null route(route $route, string $method) Handle route
*
* @package mirzaev\minimal
*
* @license http://www.wtfpl.net/ Do What The Fuck You Want To Public License
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
@@ -112,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));
}
@@ -122,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
$request->options = $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)
@@ -193,31 +244,35 @@ final class core
// Deinitializing name of the controller class
unset($controller);
// Initializing name if the model class
$model = $route->model;
if (!isset($route->controller->model)) {
// Not initialized the model in the controller
if ($route->model instanceof model) {
// Initialized the model
} else if (class_exists($model = "$this->namespace\\models\\$model")) {
// Found the model by its name
// Initializing name if the model class
$model = $route->model;
// Initializing the model
$route->model = new $model;
} else if (!empty($route->model)) {
// Not found the model and $route->model has a value
if ($route->model instanceof model) {
// Initialized the model
} else if (class_exists($model = "$this->namespace\\models\\$model")) {
// Found the model by its name
// Exit (fail)
throw new exception_domain("Failed to find the model: $model", status::not_implemented->value);
}
// Initializing the model
$route->model = new $model;
} else if (!empty($route->model)) {
// Not found the model and $route->model has a value
// Deinitializing name of the model class
unset($model);
// Exit (fail)
throw new exception_domain("Failed to find the model: $model", status::not_implemented->value);
}
if ($route->model instanceof model) {
// Initialized the model
// Deinitializing name of the model class
unset($model);
// Writing the model to the controller
$route->controller->model = $route->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
@@ -226,8 +281,15 @@ final class core
if (method_exists($route->controller, $route->method)) {
// Found the method of the controller
// Executing method of the controller and exit (success)
return $route->controller->{$route->method}(...($route->parameters + $request->parameters));
try {
// Executing method of the controller and exit (success)
return $route->controller->{$route->method}(...($route->parameters + $request->parameters));
} catch (exception $exception) {
// Catched an exception
// 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

43
mirzaev/minimal/system/http/enumerations/content.php Normal file → Executable file
View File

@@ -4,6 +4,13 @@ declare(strict_types=1);
namespace mirzaev\minimal\http\enumerations;
// Files of the project
use mirzaev\minimal\http\enumerations\status;
// Built-in libraries
use InvalidArgumentException as exception_argument,
DomainException as exception_domain;
/**
* Content
*
@@ -18,7 +25,7 @@ enum content: string
{
case any = '*/*';
// Text
// Text
case txt = 'text/plain';
case css = 'text/css';
@@ -26,7 +33,7 @@ enum content: string
case html = 'text/html';
case js = 'text/javascript'; // js + mjs (https://www.rfc-editor.org/rfc/rfc9239#name-text-javascript)
// Applications
// Applications
case binary = 'application/octet-stream';
case encoded = 'application/x-www-form-urlencoded';
@@ -49,7 +56,7 @@ enum content: string
case sh = 'application/x-sh';
case xhtml = 'application/xhtml+xml';
// Audio
// Audio
case aac = 'audio/aac';
case mp3 = 'audio/mpeg';
@@ -57,7 +64,7 @@ enum content: string
case oga = 'audio/ogg';
case weba = 'audio/webm';
// Images
// Images
case gif = 'image/gif';
case jpeg = 'image/jpeg';
@@ -70,7 +77,7 @@ enum content: string
case bmp = 'image/bmp';
case ico = 'image/vnd.microsoft.icon';
// Videos
// Videos
case avi = 'video/x-msvideo';
case mp4 = 'video/mp4';
@@ -78,17 +85,39 @@ enum content: string
case ogv = 'video/ogg';
case ts = 'video/mp2t';
// Fonts
// Fonts
case otf = 'font/otf';
case ttf = 'font/ttf';
case woff = 'font/woff';
case woff2 = 'font/woff2';
// Multipart
// Multipart
case form = 'multipart/form-data';
case mixed = 'multipart/mixed';
case alternative = 'multipart/alternative';
case related = 'multipart/related';
/**
* Extension
*
* Returns the file extension without a dot
*
* @throws exception_argument if content can not have file extension
* @throws exception_domain if failed to recognize content
*
* @return string File extension
*/
public function extension(): string
{
// Exit (success)
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)
};
}
}

0
mirzaev/minimal/system/http/enumerations/method.php Normal file → Executable file
View File

12
mirzaev/minimal/system/http/enumerations/protocol.php Normal file → Executable file
View File

@@ -16,9 +16,11 @@ namespace mirzaev\minimal\http\enumerations;
*/
enum protocol: string
{
case HTTP_3 = 'HTTP/3';
case HTTP_2 = 'HTTP/2';
case HTTP_1_1 = 'HTTP/1.1';
case HTTP_1_0 = 'hTTP/1.0';
case HTTP_0_9 = 'HTTP/0.9';
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_0_9 = 'HTTP/0.9';
case cli = 'CLI';
}

0
mirzaev/minimal/system/http/enumerations/status.php Normal file → Executable file
View File

View File

@@ -20,6 +20,8 @@ use DomainException as exception_domain,
/**
* Request
*
* @package mirzaev\minimal\http
*
* @param method $method Method
* @param string $uri URI
* @param protocol $protocol Version of HTTP protocol
@@ -32,8 +34,6 @@ use DomainException as exception_domain,
* @method response response() Generate response for request
* @method self header(string $name, string $value) Write a header to the headers property
*
* @package mirzaev\minimal\http
*
* @license http://www.wtfpl.net/ Do What The Fuck You Want To Public License
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
@@ -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
@@ -233,7 +233,7 @@ 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
@@ -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,49 +324,60 @@ 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 = [];
// Declaring the buffer of headers
$buffer = [];
foreach (
match (true) {
isset($headers) => $headers,
php_sapi_name() !== 'cli' => getallheaders(),
default => []
} as $name => $value
) {
// Iterating over headers
foreach ($headers ?? [] 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');
// 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
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;
// Exit (fail)
throw new exception_domain('Failed to normalize name of header', status::internal_server_error->value);
}
// Writing headers from argument into the property
$this->headers = $buffer;
// Deinitializing the buffer of headers
unset($buffer);
// Writing into the buffer of headers
$buffer[$name] = $value;
}
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
@@ -438,10 +419,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 +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);
}
/**
@@ -481,7 +467,7 @@ final class request
return new response(protocol: $this->protocol, status: status::ok);
}
/**
/**
* Header
*
* Write a header to the headers property

View File

@@ -20,6 +20,8 @@ use DomainException as exception_domain,
/**
* Response
*
* @package mirzaev\minimal\http
*
* @param protocol $protocol Version of HTTP protocol
* @param status $status Status
* @param array $headers Headers
@@ -37,8 +39,6 @@ use DomainException as exception_domain,
* @method self clean() Delete everything in the output buffer
* @method self end() Initializes response headers and flushes the output buffer
*
* @package mirzaev\minimal\http
*
* @license http://www.wtfpl.net/ Do What The Fuck You Want To Public License
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
@@ -49,7 +49,6 @@ final class response
*
* @see https://wiki.php.net/rfc/property-hooks (find a table about backed and virtual hooks)
*
* @throws exception_runtime if reinitialize the property
* @throws exception_domain if failed to recognize HTTP version
*
* @var protocol $protocol Version of HTTP protocol
@@ -57,12 +56,6 @@ final class response
public protocol $protocol {
// Write
set (protocol|string $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);
}
if ($value instanceof protocol) {
// Received implementation of HTTP version
@@ -95,7 +88,6 @@ final class response
*
* @see https://wiki.php.net/rfc/property-hooks (find a table about backed and virtual hooks)
*
* @throws exception_runtime if reinitialize the property
* @throws exception_domain if failed to recognize status
*
* @var status $status Status
@@ -103,12 +95,6 @@ final class response
public status $status {
// Write
set (status|string $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);
}
if ($value instanceof status) {
// Received implementation of status
@@ -161,10 +147,10 @@ final class response
set (string $value) {
// Writing
$this->body = $value;
};
}
// Read
&get => $this->body;
get => $this->body;
}
/**
@@ -334,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)
@@ -353,12 +339,42 @@ final class response
*
* Generates the status line (HTTP/2 200 OK)
*
* @param protocol|null $protocol Version of HTTP
* @param status|null $status Status code and status text
*
* @return string The status line
*/
public function status(): string
public function status(?protocol $protocol = null, ?status $status = null): string
{
// Declaring buffer of status line
$buffer = '';
if ($protocol instanceof protocol) {
// Received version of HTTP
// Writing to buffer of status line
$buffer .= $protocol->value . ' ';
} else {
// Not received version of HTTP
// Writing to buffer of status line
$buffer .= $this->protocol->value . ' ';
}
if ($status instanceof status) {
// Received status
// Writing to buffer of status line
$buffer .= $status->value . ' ' . $status->label();
} else {
// Not received status
// Writing to buffer of status line
$buffer .= $this->status->value . ' ' . $this->status->label();
}
// Exit (success)
return $this->protocol->value . ' ' . $this->status->value . ' ' . $this->status->label();
return $buffer;
}
/**
@@ -437,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;

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

@@ -10,10 +10,10 @@ use mirzaev\minimal\traits\magic;
/**
* Model
*
* @method void __construct() Constructor
*
* @package mirzaev\minimal
*
* @method void __construct() Constructor
*
* @license http://www.wtfpl.net/ Do What The Fuck You Want To Public License
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/

View File

@@ -4,24 +4,33 @@ 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
*
* @package mirzaev\minimal
*
* @param string|controller $controller Name of the controller
* @param string $method Name of the method of the method of $this->controller
* @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
*
* @package mirzaev\minimal
* @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;
@@ -15,21 +16,23 @@ use InvalidArgumentException as exception_argument;
/**
* Router
*
* @package mirzaev\minimal
*
* @param array $routes Registry of routes
*
* @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
*
* @package mirzaev\minimal
* @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

@@ -13,13 +13,13 @@ use exception;
/**
* Trait of magical methods
*
* @package mirzaev\minimal\traits
*
* @method void __set(string $name, mixed $value) Write property
* @method mixed __get(string $name) Read property
* @method void __unset(string $name) Delete property
* @method bool __isset(string $name) Check property for initialization
*
* @package mirzaev\minimal\traits
*
* @license http://www.wtfpl.net/ Do What The Fuck You Want To Public License
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/

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;
}
}

4
mirzaev/minimal/system/traits/singleton.php Normal file → Executable file
View File

@@ -10,10 +10,10 @@ use exception;
/**
* Trait of singleton
*
* @method static initialize() Initialize an instance
*
* @package mirzaev\minimal\traits
*
* @method static initialize() Initialize an instance
*
* @license http://www.wtfpl.net/ Do What The Fuck You Want To Public License
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/