10 Commits

15 changed files with 253 additions and 180 deletions

0
LICENSE Normal file → Executable file
View File

72
README.md Normal file → Executable file
View File

@@ -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>

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

@@ -15,6 +15,7 @@ use mirzaev\minimal\router,
// Built-in libraries
use exception,
RuntimeException as exception_runtime,
BadMethodCallException as exception_method,
DomainException as exception_domain,
InvalidArgumentException as exception_argument,
@@ -25,6 +26,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 +39,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>
*/
@@ -193,6 +194,9 @@ final class core
// Deinitializing name of the controller class
unset($controller);
if (!isset($route->controller->model)) {
// Not initialized the model in the controller
// Initializing name if the model class
$model = $route->model;
@@ -219,6 +223,7 @@ final class core
// Writing the model to the controller
$route->controller->model = $route->model;
}
}
// Writing the request to the controller
$route->controller->request = $request;
@@ -226,8 +231,16 @@ final class core
if (method_exists($route->controller, $route->method)) {
// Found the method of the controller
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

29
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
*
@@ -91,4 +98,26 @@ enum content: string
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

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

@@ -16,9 +16,9 @@ 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';
}

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

View File

@@ -6,20 +6,22 @@ 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
*
* @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
@@ -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,13 +324,16 @@ 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
@@ -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
@@ -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
@@ -441,7 +446,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 +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);
}
/**

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

@@ -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

@@ -7,6 +7,8 @@ namespace mirzaev\minimal;
/**
* 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
@@ -15,8 +17,6 @@ namespace mirzaev\minimal;
*
* @method void __construct(string|controller $controller, ?string $method, string|model|null $model, array $parameters, array $options) 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>
*/

View File

@@ -15,6 +15,8 @@ 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)
@@ -22,8 +24,6 @@ use InvalidArgumentException as exception_argument;
* @method self sort() Sort routes (DEV)
* @method string universalize(string $urn) Universalize URN
*
* @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>
*/

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>
*/

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>
*/