5 Commits
2.2.0 ... 3.0.0

10 changed files with 1018 additions and 508 deletions

11
LICENSE Normal file
View File

@@ -0,0 +1,11 @@
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004
Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
Everyone is permitted to copy and distribute verbatim or modified copies of this license document, and changing it is allowed as long as the name is changed.
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. You just DO WHAT THE FUCK YOU WANT TO.

64
README.md Normal file
View File

@@ -0,0 +1,64 @@
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** 🤟
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
## Installation
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));
// Handle the request
echo $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,7 +1,7 @@
{
"name": "mirzaev/minimal",
"type": "framework",
"description": "Lightweight MVC framework that manages only the basic mechanisms, leaving the development of the programmer and not overloading the project",
"description": "My vision of a good framework",
"keywords": [
"mvc",
"framework",
@@ -14,7 +14,7 @@
"name": "Arsen Mirzaev Tatyano-Muradovich",
"email": "arsen@mirzaev.sexy",
"homepage": "https://mirzaev.sexy",
"role": "Developer"
"role": "Programmer"
}
],
"support": {
@@ -22,16 +22,11 @@
"issues": "https://git.mirzaev.sexy/mirzaev/minimal/issues"
},
"require": {
"php": "~8.2"
"php": "~8.4"
},
"autoload": {
"psr-4": {
"mirzaev\\minimal\\": "mirzaev/minimal/system"
}
},
"autoload-dev": {
"psr-4": {
"mirzaev\\minimal\\tests\\": "mirzaev/minimal/tests"
}
}
}

View File

@@ -4,121 +4,83 @@ declare(strict_types=1);
namespace mirzaev\minimal;
// Файлы проекта
use mirzaev\minimal\model;
// Files of the project
use mirzaev\minimal\model,
mirzaev\minimal\core,
mirzaev\minimal\traits\magic;
// Встроенные библиотеки
// Build-in libraries
use exception;
/**
* Контроллер
* Controller
*
* @var core $core An instance of the core
* @var model $model An instance of the model connected in the core
* @var view $view View template engine instance (twig)
* @var core $core An instance of the core
* @var core $core An instance of the core
*
* @method self __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>
*/
class controller
{
/**
* Постфикс
*/
private const POSTFIX = '_controller';
use magic;
/**
* Инстанция модели
* Core
*
* @var core $core An instance of the core
*/
protected model $model;
/**
* Инстанция шаблонизатора представления
*/
protected object $view;
/**
* Конструктор
*/
public function __construct()
{
public core $core {
// Read
get => $this->core;
}
/**
* Записать свойство
* Model
*
* @param string $name Название
* @param mixed $value Значение
*
* @return void
* @var model $model An instance of the model connected in the core
*/
public function __set(string $name, mixed $value = null): void
{
match ($name) {
'POSTFIX' => throw new exception('Запрещено реинициализировать постфикс ($this::POSTFIX)', 500),
'model' => (function () use ($value) {
if ($this->__isset('model')) throw new exception('Запрещено реинициализировать свойство с инстанцией модели ($this->model)', 500);
else {
// Свойство не инициализировано
if (is_object($value)) $this->model = $value;
else throw new exception('Свойство $this->model должно хранить инстанцию модели (объект)', 500);
public model $model {
// Write
set (model $model) {
$this->model ??= $model;
}
})(),
'view' => (function () use ($value) {
if ($this->__isset('view')) throw new exception('Запрещено реинициализировать свойство с инстанцией шаблонизатора представления ($this->view)', 500);
else {
// Свойство не инициализировано
if (is_object($value)) $this->view = $value;
else throw new exception('Свойство $this->view должно хранить инстанцию шаблонизатора представления (объект)', 500);
}
})(),
default => throw new exception("Свойство \"\$$name\" не найдено", 404)
};
// Read
get => $this->model;
}
/**
* Прочитать свойство
* View
*
* @param string $name Название
*
* @return mixed Содержимое
* @var view $view View template engine instance (twig)
*/
public function __get(string $name): mixed
{
return match ($name) {
'POSTFIX' => $this::POSTFIX ?? throw new exception("Свойство \"POSTFIX\" не инициализировано", 500),
'model' => $this->model ?? throw new exception("Свойство \"\$model\" не инициализировано", 500),
'view' => $this->view ?? throw new exception("Свойство \"\$view\" не инициализировано", 500),
default => throw new exception("Свойство \"\$$name\" не обнаружено", 404)
};
public object $view {
// Write
set (object $view) {
$this->view ??= $view;
}
// Read
get => $this->view;
}
/**
* Проверить свойство на инициализированность
* Constructor
*
* @param string $name Название
* @param core $core The instance of the core
*
* @return bool Инициализировано свойство?
* @return self
*/
public function __isset(string $name): bool
{
return match ($name) {
default => isset($this->{$name})
};
}
/**
* Удалить свойство
*
* @param string $name Название
*
* @return void
*/
public function __unset(string $name): void
{
match ($name) {
default => (function () use ($name) {
// Удаление
unset($this->{$name});
})()
};
public function __construct(core $core) {
// Writing the core into the property
$this->core = $core;
}
}

View File

@@ -4,227 +4,361 @@ declare(strict_types=1);
namespace mirzaev\minimal;
// Файлы проекта
// Files of the project
use mirzaev\minimal\router,
mirzaev\minimal\route,
mirzaev\minimal\controller,
mirzaev\minimal\model;
// Встроенные библиотеки
// Built-in libraries
use exception,
BadMethodCallException as exception_method,
DomainException as exception_domain,
InvalidArgumentException as exception_argument,
UnexpectedValueException as exception_value,
ReflectionClass as reflection;
/**
* Ядро
* Core
*
* @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
* @param router $router An instance of the router
*
* @mathod self __construct(?string $namespace) Constructor
* @method void __destruct() Destructor
* @method string|null request(?string $uri, ?string $method, array $variabls) Handle the request
* @method string|null route(route $route, string $method) Handle the route
*
* @package mirzaev\minimal
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*
* @todo
* 1. Добавить __isset() и __unset()
* @license http://www.wtfpl.net/ Do What The Fuck You Want To Public License
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/
final class core
{
/**
* Инстанция соединения с базой данных
*/
private object $db;
/**
* Инстанция маршрутизатора
*/
private readonly router $router;
/**
* Инстанция ядра контроллера
*/
private readonly controller $controller;
/**
* Инстанция ядра модели
*/
private readonly model $model;
/**
* Путь пространства имён (системное)
* Namespace
*
* Используется для поиска файлов по спецификации PSR-4
* @var string $namespace Namespace where the core was initialized from
*
* @see https://www.php-fig.org/psr/psr-4/
*/
private readonly string $namespace;
public string $namespace {
// Read
get => $this->namespace;
}
/**
* Конструктор
* Controller
*
* @var controller $controller An instance of the controller
*/
private controller $controller {
// Read
get => $this->controller ??= new controller;
}
/**
* Model
*
* @var model $model An instance of the model
*/
private model $model {
// Read
get => $this->model ??= new model;
}
/**
* Router
*
* @var router $router An instance of the router
*/
public router $router {
get => $this->router ??= router::initialize();
}
/**
* Constrictor
*
* @param ?object $db Инстанция соединения с базой данных
* @param ?router $router Маршрутизатор
* @param ?controller $controller Инстанция ядра контроллера
* @param ?model $model Инстанция ядра модели
* @param ?string $namespace Пространство имён системного ядра
*
* @return self Инстанция ядра
* @return self The instance of the core
*/
public function __construct(
?object $db = null,
?router $router = null,
?controller $controller = null,
?model $model = null,
?string $namespace = null
) {
// Инициализация свойств
if (isset($db)) $this->__set('db', $db);
if (isset($router)) $this->__set('router', $router);
if (isset($controller)) $this->__set('controller', $controller);
if (isset($model)) $this->__set('model', $model);
$this->__set('namespace', $namespace ?? (new reflection(self::class))->getNamespaceName());
// Writing a namespace to the property
$this->namespace = $namespace ?? (new reflection(self::class))->getNamespaceName();
}
/**
* Destructor
*/
public function __destruct() {}
/**
* Request
*
* Handle the request
*
* @param string|null $uri URI of the request (value by default: $_SERVER['REQUEST_URI'])
* @param string|null $method Method of the request (GET, POST, PUT...) (value by default: $_SERVER["REQUEST_METHOD"])
* @paam array $parameters parameters for merging with route parameters
*
* @return string|null Response
*/
public function request(?string $uri = null, ?string $method = null, array $parameters = []): ?string
{
// Matching a route
$route = $this->router->match($uri ??= $_SERVER['REQUEST_URI'] ?? '/', $method ??= $_SERVER["REQUEST_METHOD"]);
if ($route) {
// Initialized the route
if (!empty($parameters)) {
// Recaived parameters
// Merging parameters with route parameters
$route->parameters = $parameters + $route->parameters;
}
// Handling the route and exit (success)
return $this->route($route, $method);
}
// Exit (fail)
return null;
}
/**
* Деструктор
* Route
*
* Handle the route
*
* @param route $route The route
* @param string $method Method of requests (GET, POST, PUT, DELETE, COOKIE...)
*
* @return string|null Response, if generated
*/
public function __destruct()
public function route(route $route, string $method = 'GET'): ?string
{
// Initializing name of the controller class
$controller = $route->controller;
if ($route->controller instanceof controller) {
// Initialized the controller
} else if (class_exists($controller = "$this->namespace\\controllers\\$controller")) {
// Found the controller by its name
// Initializing the controller
$route->controller = new $controller(core: $this);
} else if (!empty($route->controller)) {
// Not found the controller and $route->controller has a value
// Exit (fail)
throw new exception_domain('Failed to found the controller: ' . $route->controller);
} else {
// Not found the controller and $route->controller is empty
// Exit (fail)
throw new exception_argument('Failed to initialize the controller: ' . $route->controller);
}
/**
* Запуск
*
* @param ?string $uri Маршрут
*
* @return string|int|null Ответ
*/
public function start(string $uri = null): string|int|null
{
// Обработка запроса
return $this->__get('router')->handle($uri, core: $this);
// Deinitializing name of the controller class
unset($controller);
// 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
// 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 initialize the model: ' . ($route->model ?? $route->controller));
}
/**
* Записать свойство
*
* @param string $name Название
* @param mixed $value Содержимое
*
* @return void
*/
public function __set(string $name, mixed $value = null): void
{
match ($name) {
'db', 'database' => (function () use ($value) {
if ($this->__isset('db')) throw new exception('Запрещено реинициализировать инстанцию соединения с базой данных ($this->db)', 500);
else {
// Свойство ещё не было инициализировано
// Deinitializing name of the model class
unset($model);
if (is_object($value)) $this->db = $value;
else throw new exception('Свойство $this->db должно хранить инстанцию соединения с базой данных', 500);
}
})(),
'router' => (function () use ($value) {
if ($this->__isset('router')) throw new exception('Запрещено реинициализировать инстанцию маршрутизатора ($this->router)', 500);
else {
// Свойство ещё не было инициализировано
if ($route->model instanceof model) {
// Initialized the model
if ($value instanceof router) $this->router = $value;
else throw new exception('Свойство $this->router должно хранить инстанцию маршрутизатора (mirzaev\minimal\router)"', 500);
}
})(),
'controller' => (function () use ($value) {
if ($this->__isset('controller')) throw new exception('Запрещено реинициализировать инстанцию ядра контроллеров ($this->controller)', 500);
else {
// Свойство не инициализировано
if ($value instanceof controller) $this->controller = $value;
else throw new exception('Свойство $this->controller должно хранить инстанцию ядра контроллеров (mirzaev\minimal\controller)', 500);
}
})(),
'model' => (function () use ($value) {
if ($this->__isset('model')) throw new exception('Запрещено реинициализировать инстанцию ядра моделей ($this->model)', 500);
else {
// Свойство не инициализировано
if ($value instanceof model) $this->model = $value;
else throw new exception('Свойство $this->model должно хранить инстанцию ядра моделей (mirzaev\minimal\model)', 500);
}
})(),
'namespace' => (function () use ($value) {
if ($this->__isset('namespace')) throw new exception('Запрещено реинициализировать путь пространства имён ($this->namespace)', 500);
else {
// Свойство не инициализировано
if (is_string($value)) $this->namespace = $value;
else throw new exception('Свойство $this->namespace должно хранить строку с путём пространства имён', 500);
}
})(),
default => throw new exception("Свойство \"\$$name\" не найдено", 404)
};
// Writing the model to the controller
$route->controller->model = $route->model;
}
/**
* Прочитать свойство
*
* Записывает значение по умолчанию, если свойство не инициализировано
*
* @param string $name Название
*
* @return mixed Содержимое
*/
public function __get(string $name): mixed
{
return match ($name) {
'db', 'database' => $this->db ?? throw new exception("Свойство \"\$$name\" не инициализировано", 500),
'router' => (function () {
// Инициализация со значением по умолчанию
if (!$this->__isset('router')) $this->__set('router', new router);
if ($method === 'POST') {
// POST
// Возврат (успех)
return $this->router;
})(),
'controller' => (function () {
// Инициализация со значением по умолчанию
if (!$this->__isset('controller')) $this->__set('controller', new controller);
if (method_exists($route->controller, $route->method)) {
// Found the method of the controller
// Возврат (успех)
return $this->controller;
})(),
'model' => (function () {
// Инициализация со значением по умолчанию
if (!$this->__isset('model')) $this->__set('model', new model);
// Executing method of the controller that handles the route and exit (success)
return $route->controller->{$route->method}($route->parameters + $_POST, $_FILES);
} else {
// Not found the method of the controller
// Возврат (успех)
return $this->model;
})(),
'namespace' => $this->namespace ?? throw new exception("Свойство \"\$$name\" не инициализировано", 500),
default => throw new exception("Свойство \"\$$name\" не найдено", 404)
};
// Exit (fail)
throw new exception('Failed to find the method of the controller: ' . $route->method);
}
} else if ($method === 'GET') {
// GET
if (method_exists($route->controller, $route->method)) {
// Found the method of the controller
if ($_SERVER["CONTENT_TYPE"] === 'multipart/form-data' || $_SERVER["CONTENT_TYPE"] === 'application/x-www-form-urlencoded') {
// The requeset content type is the "multipart/form-data" or "application/x-www-form-urlencoded"
// Analysis of the request
[$_GET, $_FILES] = request_parse_body($route->options);
}
/**
* Проверить свойство на инициализированность
*
* @param string $name Название
*
* @return bool Инициализировано свойство?
*/
public function __isset(string $name): bool
{
return match ($name) {
default => isset($this->{$name})
};
// Executing method of the controller that handles the route and exit (success)
return $route->controller->{$route->method}($route->parameters + $_GET, $_FILES);
} else {
// Not found the method of the controller
// Exit (fail)
throw new exception('Failed to find the method of the controller: ' . $route->method);
}
} else if ($method === 'PUT') {
// PUT
if (method_exists($route->controller, $route->method)) {
// Found the method of the controller
if ($_SERVER["CONTENT_TYPE"] === 'multipart/form-data' || $_SERVER["CONTENT_TYPE"] === 'application/x-www-form-urlencoded') {
// The requeset content type is the "multipart/form-data" or "application/x-www-form-urlencoded"
// Analysis of the request
[$_PUT, $_FILES] = request_parse_body($route->options);
}
/**
* Удалить свойство
*
* @param string $name Название
*
* @return void
*/
public function __unset(string $name): void
{
match ($name) {
default => (function () use ($name) {
// Удаление
unset($this->{$name});
})()
};
// Executing method of the controller that handles the route and exit (success)
return $route->controller->{$route->method}($route->parameters + $_PUT, $_FILES);
} else {
// Not found the method of the controller
// Exit (fail)
throw new exception('Failed to find the method of the controller: ' . $route->method);
}
} else if ($method === 'DELETE') {
// DELETE
if (method_exists($route->controller, $route->method)) {
// Found the method of the controller
if ($_SERVER["CONTENT_TYPE"] === 'multipart/form-data' || $_SERVER["CONTENT_TYPE"] === 'application/x-www-form-urlencoded') {
// The requeset content type is the "multipart/form-data" or "application/x-www-form-urlencoded"
// Analysis of the request
[$_DELETE, $_FILES] = request_parse_body($route->options);
}
// Executing method of the controller that handles the route and exit (success)
return $route->controller->{$route->method}($route->parameters + $_DELETE, $_FILES);
} else {
// Not found the method of the controller
// Exit (fail)
throw new exception('Failed to find the method of the controller: ' . $route->method);
}
} else if ($method === 'PATCH') {
// PATCH
if (method_exists($route->controller, $route->method)) {
// Found the method of the controller
if ($_SERVER["CONTENT_TYPE"] === 'multipart/form-data' || $_SERVER["CONTENT_TYPE"] === 'application/x-www-form-urlencoded') {
// The requeset content type is the "multipart/form-data" or "application/x-www-form-urlencoded"
// Analysis of the request
[$_PATCH, $_FILES] = request_parse_body($route->options);
}
// Executing method of the controller that handles the route and exit (success)
return $route->controller->{$route->method}($route->parameters + $_PATCH, $_FILES);
} else {
// Not found the method of the controller
// Exit (fail)
throw new exception('Failed to find the method of the controller: ' . $route->method);
}
} else if ($method === 'HEAD') {
// HEAD
if (method_exists($route->controller, $route->method)) {
// Found the method of the controller
// Executing method of the controller that handles the route and exit (success)
return $route->controller->{$route->method}($route->parameters);
} else {
// Not found the method of the controller
// Exit (fail)
throw new exception('Failed to find the method of the controller: ' . $route->method);
}
} else if ($method === 'OPTIONS') {
// OPTIONS
if (method_exists($route->controller, $route->method)) {
// Found the method of the controller
// Executing method of the controller that handles the route and exit (success)
return $route->controller->{$route->method}($route->parameters);
} else {
// Not found the method of the controller
// Exit (fail)
throw new exception('Failed to find the method of the controller: ' . $route->method);
}
} else if ($method === 'CONNECT') {
// CONNECT
if (method_exists($route->controller, $route->method)) {
// Found the method of the controller
// Executing method of the controller that handles the route and exit (success)
return $route->controller->{$route->method}($route->parameters);
} else {
// Not found the method of the controller
// Exit (fail)
throw new exception('Failed to find the method of the controller: ' . $route->method);
}
} else if ($method === 'TRACE') {
// TRACE
if (method_exists($route->controller, $route->method)) {
// Found the method of the controller
// Executing method of the controller that handles the route and exit (success)
return $route->controller->{$route->method}($route->parameters);
} else {
// Not found the method of the controller
// Exit (fail)
throw new exception('Failed to find the method of the controller: ' . $route->method);
}
} else {
// Not recognized method of the request
// Exit (fail)
throw new exception_value('Failed to recognize the method: ' . $method);
}
// Exit (fail)
return null;
}
}

View File

@@ -4,88 +4,27 @@ declare(strict_types=1);
namespace mirzaev\minimal;
// Встроенные библиотеки
use exception;
// Files of the project
use mirzaev\minimal\traits\magic;
/**
* Модель
* Model
*
* @method self __construct() 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>
*/
class model
{
/**
* Постфикс
*/
private const POSTFIX = '_model';
use magic;
/**
* Конструктор
* Constructor
*
* @return self
*/
public function __construct()
{
}
/**
* Записать свойство
*
* @param string $name Название
* @param mixed $value Содержимое
*
* @return void
*/
public function __set(string $name, mixed $value = null): void
{
match ($name) {
'POSTFIX' => throw new exception('Запрещено реинициализировать постфикс ($this::POSTFIX)', 500),
default => throw new exception("Свойство \"\$$name\" не найдено", 404)
};
}
/**
* Прочитать свойство
*
* @param string $name Название
*
* @return mixed Содержимое
*/
public function __get(string $name): mixed
{
return match ($name) {
'POSTFIX' => $this::POSTFIX ?? throw new exception("Свойство \"POSTFIX\" не инициализировано", 500),
default => throw new exception("Свойство \"\$$name\" не обнаружено", 404)
};
}
/**
* Проверить свойство на инициализированность
*
* @param string $name Название
*
* @return bool Инициализировано свойство?
*/
public function __isset(string $name): bool
{
return match ($name) {
default => isset($this->{$name})
};
}
/**
* Удалить свойство
*
* @param string $name Название
*
* @return void
*/
public function __unset(string $name): void
{
match ($name) {
default => (function () use ($name) {
// Удаление
unset($this->{$name});
})()
};
}
public function __construct() {}
}

127
mirzaev/minimal/system/route.php Executable file
View File

@@ -0,0 +1,127 @@
<?php
declare(strict_types=1);
namespace mirzaev\minimal;
/**
* Route
*
* @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)`
*
* @method self __construct(string $controller,?string $method, ?string $model, array $variables, 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>
*/
final class route
{
/**
* Controller
*
* @var string|model $controller Name of the controller or an instance of the controller
*/
public string|controller $controller {
// Read
get => $this->controller;
}
/**
* Method
*
* @var string $method Name of the method of the method of $this->controller
*/
public string $method{
// Read
get => $this->method;
}
/**
* Model
*
* @var string|model|null $model Name of the model of an instance of the model
*/
public string|model|null $model {
// Read
get => $this->model;
}
/**
* Parameters
*
* @var array $parameters Arguments for the $this->method (will be concatenated together with generated request parameters)
*/
public array $parameters {
// Read
get => $this->parameters;
}
/**
* Options
*
* Used only for GET, PUT, PATCH and DELETE
*
* @var string $options Options for `request_parse_body($options)`
*/
public array $options {
// Write
set (array $value) => 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 => false
},
ARRAY_FILTER_USE_KEY
);
// Read
get => $this->options;
}
/**
* Constructor
*
* @param string|controller $controller Name of the controller
* @param string|null $method Name of the method of the method of $controller
* @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)
*
* @return self
*/
public function __construct(
string|controller $controller,
?string $method = 'index',
string|model|null $model = null,
array $parameters = [],
array $options = []
) {
// Writing name of the controller
$this->controller = $controller;
// Writing name of the model
$this->model = $model;
// Writing name of the method of the controller
$this->method = $method;
// Writing parameters
$this->parameters = $parameters;
// Writing options
if (match ($method) {
'GET', 'PUT', 'PATCH', 'DELETE' => true,
default => false
}) $this->options = $options;
}
}

View File

@@ -4,172 +4,282 @@ declare(strict_types=1);
namespace mirzaev\minimal;
// Файлы проекта
use mirzaev\minimal\core;
// Files of the project
use mirzaev\minimal\route,
mirzaev\minimal\traits\singleton;
// Build-ing libraries
use InvalidArgumentException as exception_argument;
/**
* Маршрутизатор
* Router
*
* @param array $routes The registry of routes
*
* @method self write(string $uri, string $method)
* @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>
*/
final class router
{
use singleton;
/**
* @var array $router Реестр маршрутов
* Routes
*
* @var array $routes The registry of routes
*/
protected array $routes = [];
/**
* Записать маршрут
* Write a route
*
* @param string $route Маршрут
* @param string $handler Обработчик - инстанции контроллера и модели (не обязательно), без постфиксов
* @param ?string $method Вызываемый метод в инстанции контроллера обработчика
* @param ?string $request HTTP-метод запроса (GET, POST, PUT...)
* @param ?string $model Инстанция модели (переопределение инстанции модели в $target)
* @param string $urn URN of the route ('/', '/page', '/page/$variable', '/page/$collector...'...)
* @param route $route The route
* @param string|array $method Method of requests (GET, POST, PUT, DELETE, COOKIE...)
*
* @return void
* @return self The instance from which the method was called (fluent interface)
*/
public function write(
string $route,
string $handler,
?string $method = 'index',
?string $request = 'GET',
?string $model = null
): void {
// Запись в реестр
$this->routes[$route][$request] = [
'controller' => $handler,
'model' => $model ?? $handler,
'method' => $method
];
string $urn,
route $route,
null|string|array $method = 'GET'
): self {
foreach (is_array($method) ? $method : [$method] as $method) {
// Iterate over methods of requests
// Validating method
$method = match ($method) {
'POST', 'GET', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'CONNECT', 'TRACE' => $method,
default => throw new exception_argument("Failed to initialize method: \"$method\"")
};
// Writing to the registry of routes
$this->routes[$urn][$method] = $route;
}
// Exit (success) (fluent interface)
return $this;
}
/**
* Обработать маршрут
* Match
*
* @param ?string $uri URI запроса (https://domain.com/foo/bar)
* @param ?string $method Метод запроса (GET, POST, PUT...)
* @param ?core $core Инстанция системного ядра
* Match request URI with registry of routes
*
* @return string|int|null Ответ
* @param string $uri URI (protocol://domain/foo/bar)
* @param string $method Method of the request (GET, POST, PUT...)
*
* @return route|null Route, if found
*/
public function handle(?string $uri = null, ?string $method = null, ?core $core = new core): string|int|null
{
// Инициализация значений по умолчанию
$uri ??= $_SERVER['REQUEST_URI'] ?? '/';
$method ??= $_SERVER["REQUEST_METHOD"] ?? 'GET';
// Инициализация URL запроса (/foo/bar)
$url = parse_url($uri, PHP_URL_PATH);
// Универсализация маршрута
$url = self::universalize($url);
// Сортировка реестра маршрутов от большего ключа к меньшему (кешируется)
krsort($this->routes);
// Поиск директорий в ссылке
preg_match_all('/[^\/]+/', $url, $directories);
// Инициализация директорий
$directories = $directories[0];
public function match(string $uri, string $method): ?route {
// Declaration of the registry of routes directoies
$routes = [];
foreach ($this->routes as $route => $data) {
// Перебор маршрутов
// Iteration over routes
// Универсализация маршрута
// Search directories of route (explode() creates empty value in array)
preg_match_all('/(^\/$|[^\/]+)/', $route, $data['directories']);
$routes[$route] = $data['directories'][0];
}
if (count($routes) === count($this->routes)) {
// Initialized the registry of routes directoies
// Universalization of URN (/foo/bar)
$urn = self::universalize(parse_url(urldecode($uri), PHP_URL_PATH));
// Search directories of URN (explode() creates empty value in array)
preg_match_all('/(^\/$|[^\/]+)/', $urn, $directories);
$directories = $directories[0];
/**
* Initialization of the route
*/
// Initializing the buffer of matches of route directories with URN directories
$matches = [];
foreach ($directories as $i => $urn_directory) {
// Iteration over directories of URN
foreach ($this->routes as $route => $data) {
// Iteration over routes
if (isset($data[$method])) {
// The request method matches the route method
// Universalization of route
$route = self::universalize($route);
// Поиск директорий
preg_match_all('/[^\/]+/', $route, $data['directories']);
// Skipping unmatched routes based on results of previous iterations
if (isset($matches[$route]) && $matches[$route] === false) continue;
// Инициализация директорий
$data['directories'] = $data['directories'][0];
// Initializing of route directory
$route_directory = $routes[$route][$i] ?? null;
if (count($directories) === count($data['directories'])) {
// Входит в диапазон маршрут (совпадает количество директорий у ссылки и маршрута)
if (isset($route_directory)) {
// Initialized of route directory
// Инициализация реестра переменных
$data['vars'] = [];
if ($urn_directory === $route_directory) {
// The directory of URN is identical to the directory of route
foreach ($data['directories'] as $index => &$directory) {
// Перебор директорий
// Writing: end of URN directories XNOR end of route directories
$matches[$route] = !(isset($directories[$_i = $i + 1]) xor isset($routes[$route][$_i]));
} else if (preg_match('/^\$([a-zA-Z_\x80-\xff]+)$/', $route_directory) === 1) {
// The directory of route is a variable ($variable)
if (preg_match('/\$([a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]+)/', $directory) === 1) {
// Директория является переменной (.../$variable/...)
// Writing: end of URN directories XNOR end of route directories
$matches[$route] = !(isset($directories[$_i = $i + 1]) xor isset($routes[$route][$_i]));
} else if (
!isset($routes[$route][$i + 1])
&& preg_match('/^\$([a-zA-Z_\x80-\xff]+\.\.\.)$/', $route_directory) === 1
) {
// The directory of route is a collector ($variable...)
// AND this is the end of route directories
// Writing
$matches[$route] = 'collector';
} else $matches[$route] = false;
} else if ($matches[$route] === 'collector') {
} else $matches[$route] = false;
}
}
}
// Finding a priority route from match results
foreach ($matches as $route => $match) if ($match !== false) break;
if ($route && !empty($data = $this->routes[$route])) {
// Route found
// Universalization of route
$route = self::universalize($route);
/**
* Initialization of route variables
*/
foreach ($routes[$route] as $i => $route_directory) {
// Iteration over directories of route
if (preg_match('/^\$([a-zA-Z_\x80-\xff]+)$/', $route_directory) === 1) {
// The directory is a variable ($variable)
// Запись в реестр переменных и перещапись директории в маршруте
$data[$method]->variables[trim($route_directory, '$')] = $directories[$i];
} else if (preg_match('/^\$([a-zA-Z_\x80-\xff]+\.\.\.)$/', $route_directory) === 1) {
// The directory of route is a collector ($variable...)
// Инициализаия ссылки на массив сборщика
$collector = &$data[$method]->variables[trim($route_directory, '$.')];
// Инициализаия массива сборщика
$collector ??= [];
// Запись в реестр переменных
$directory = $data['vars'][trim($directory, '$')] = $directories[$index];
}
$collector[] = $directories[$i];
foreach (array_slice($directories, ++$i, preserve_keys: true) as &$urn_directory) {
// Перебор директорий URN
// Запись в реестр переменных
$collector[] = $urn_directory;
}
// Реиницилазция маршрута
$route = self::universalize(implode('/', $data['directories']));
// Проверка на пустой маршрут
if (empty($route)) $route = '/';
if (mb_stripos($route, $url, 0, "UTF-8") === 0 && mb_strlen($route, 'UTF-8') <= mb_strlen($url, 'UTF-8')) {
// Идентифицирован маршрут (длина не меньше длины запрошенного URL)
if (array_key_exists($method, $data)) {
// Идентифицирован метод маршрута (GET, POST, PUT...)
$route = $data[$method];
if (class_exists($controller = $core->namespace . '\\controllers\\' . $route['controller'] . $core->controller::POSTFIX)) {
// Найден контроллер
// Инициализация инстанции ядра контроллера
$controller = new $controller;
// Инициализация инстанции ядра модели
if (class_exists($model = $core->namespace . '\\models\\' . $route['model'] . $core->model::POSTFIX));
// Вызов связанного с маршрутом методв и возврат (успех)
return $controller->{$route['method']}($data['vars'] + $_REQUEST, $_FILES);
}
}
// Выход из цикла (провал)
break;
}
}
// Exit (success or fail)
return $data[$method] ?? null;
}
}
// Возврат (провал)
return $this->error($core);
// Exit (fail)
return null;
}
/**
* Сгенерировать ответ с ошибкой
* Sorting routes
*
* Вызывает метод error404 в инстанции контроллера ошибок
* 1. Short routes
* 2. Long routes
* 3. Short routes with variables (position of variables from "right" to "left")
* 4. Long routes with variables (position of variables from "right" to "left")
* 5. Short routes with collector
* 6. Long routes with collector
* 7. Short routes with variables and collector (position of variables from "right" to "left" then by amount)
* 8. Long routes with variables and collector (position of variables from "right" to "left")
*
* @param ?core $core Инстанция системного ядра
* Добавить чтобы сначала текст потом переменная затем после переменной первыми тексты и в конце перменные опять и так рекурсивно
*
* @return ?string HTML-документ
* @return self The instance from which the method was called (fluent interface)
*
* @todo ПЕРЕДЕЛАТЬ ПОЛНОСТЬЮ
*/
private function error(core $core = new core): ?string
public function sort(): self
{
return class_exists($class = '\\' . $core->namespace . '\\controllers\\errors' . $core->controller::POSTFIX)
&& method_exists($class, $method = 'error404')
? (new $class)->$method()
: null;
uksort($this->routes, function (string $a, string $b) {
// Sorting routes
// Initialization of string lengths (multibyte-safe)
$length = [
$a => mb_strlen($a),
$b => mb_strlen($b)
];
// Initialization of the presence of variables
$variables = [
$a => preg_match('/\$([a-zA-Z_\x80-\xff]+)(\/|$)/', $a) === 1,
$b => preg_match('/\$([a-zA-Z_\x80-\xff]+)(\/|$)/', $b) === 1
];
// Initialization of the presence of collectors
$collectors = [
$a => preg_match('/\$([a-zA-Z_\x80-\xff]+)\.\.\.$/', $a) === 1,
$b => preg_match('/\$([a-zA-Z_\x80-\xff]+)\.\.\.$/', $b) === 1
];
if ($variables[$a] && !$variables[$b]) return 1;
else if (!$variables[$a] && $variables[$b]) return -1;
else if ($variables[$a] && $variables[$b]) {
} else if ($collectors[$a] && !$collectors[$b]) return 1;
else if (!$collectors[$a] && $collectors[$b]) return -1;
else {
// NOR variables and XAND collectors (both are not found or both are found)
// The routes are the same length (no changes)
if ($length[$a] === $length[$b]) return 0;
// The longer route moves to the end
return $length[$a] > $length[$b] ? 1 : -1;
}
});
// Exit (success) (fluent interface)
return $this;
}
/**
* Универсализировать маршрут
* Universalize URN
*
* @param string $route Маршрут
* Always "/" at the beginning and never "/" at the end
*
* @return string Универсализированный маршрут
* @param string $urn URN (/foo/bar)
*
* @return string Universalized URN
*/
private function universalize(string $route): string
private function universalize(string $urn): string
{
// Если не записан "/" в начале, то записать, затем, если записан "/" в конце, то удалить
return preg_replace('/(.+)\/$/', '$1', preg_replace('/^([^\/])/', '/$1', $route));
// Universalization of URN and exit (success)
return (string) '/' . mb_trim($urn, '/');
}
}

View File

@@ -0,0 +1,83 @@
<?php
declare(strict_types=1);
namespace mirzaev\minimal\traits;
// Built-in libraries
use exception;
/**
* Trait of magical methods
*
* @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>
*/
trait magic
{
/**
* Write property
*
* @param string $name Name of the property
* @param mixed $value Value of the property
*
* @return void
*/
public function __set(string $name, mixed $value = null): void
{
match ($name) {
default => throw new exception('Property "' . static::class . "::\$$name\" not found", 404)
};
}
/**
* Read property
*
* @param string $name Name of the property
*
* @return mixed Value of the property
*/
public function __get(string $name): mixed
{
return match ($name) {
default => throw new exception('Property "' . static::class . "::\$$name\" not found", 404)
};
}
/**
* Delete property
*
* @param string $name Name of the property
*
* @return void
*/
public function __unset(string $name): void
{
match ($name) {
default => (function () use ($name) {
unset($this->{$name});
})()
};
}
/**
* Check property for initialization
*
* @param string $name Name of the property
*
* @return bool Is the property initialized?
*/
public function __isset(string $name): bool
{
return match ($name) {
default => isset($this->{$name})
};
}
}

View File

@@ -0,0 +1,85 @@
<?php
declare(strict_types=1);
namespace mirzaev\minimal\traits;
// Built-in libraries
use exception;
/**
* Trait of singleton
*
* @method static initialize() Initialize an instance
*
* @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>
*/
trait singleton
{
/**
* Constructor (blocked)
*
* @return void
*/
final private function __construct()
{
// Initializing the indicator that an instance of static::class has already been initialized
static $instance = false;
if ($instance) {
// An instance of static has already been initialized
// Exit (fail)
throw new exception('Has already been initialized an instance of the ' . static::class);
}
// Writing the indicator that the instance of static been initialized
$instance = true;
}
/**
* Initialize an instance
*
* Create an instance of static::class, or return an already created static::class instance
*
* @return static
*/
public static function initialize(): static
{
// Initialize the buffer of the instance of static::class
static $instance;
// Exit (success)
return $instance ??= new static;
}
/**
* Clone (blocked)
*/
private function __clone()
{
// Exit (fail)
throw new exception('Cloning is inadmissible');
}
/**
* Sleep (blocked)
*/
public function __sleep()
{
// Exit (fail)
throw new exception('Serialization is inadmissible');
}
/**
* Wake up (blocked)
*/
public function __wakeup()
{
// Exit (fail)
throw new exception('Deserialisation is inadmissible');
}
}