7 Commits
0.5.1 ... 1.2.2

9 changed files with 312 additions and 284 deletions

2
.gitignore vendored Normal file → Executable file
View File

@@ -1 +1,3 @@
vendor vendor
composer.lock
!.gitignore

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.

3
README.md Normal file
View File

@@ -0,0 +1,3 @@
# PHP 8.2 Framework for working with ArangoDB
🤟 Very simple and flexible, easy to scale and integrate

82
composer.json Normal file → Executable file
View File

@@ -1,35 +1,47 @@
{ {
"name": "mirzaev/arangodb", "name": "mirzaev/arangodb",
"description": "Реализация управления хранилищем данных ArangoDB", "description": "Simple PHP-framework for ArangoDB",
"keywords": [ "readme": "README.md",
"ArangoDB" "keywords": [
], "ArangoDB"
"type": "library", ],
"license": "WTFPL", "type": "library",
"homepage": "https://git.hood.su/mirzaev/arangodb", "license": "WTFPL",
"authors": [ "homepage": "https://git.hood.su/mirzaev/arangodb",
{ "authors": [
"name": "Arsen Mirzaev Tatyano-Muradovich", {
"email": "arsen@mirzaev.sexy", "name": "Arsen Mirzaev Tatyano-Muradovich",
"homepage": "https://mirzaev.sexy", "email": "arsen@mirzaev.sexy",
"role": "Developer" "homepage": "https://mirzaev.sexy",
} "role": "Developer"
], }
"require": { ],
"php": "^8.1", "support": {
"triagens/arangodb": "~3.8" "email": "arsen@mirzaev.sexy",
}, "wiki": "https://git.mirzaev.sexy/mirzaev/arangodb/manual",
"require-dev": { "issues": "https://git.mirzaev.sexy/mirzaev/arangodb/issues"
"phpunit/phpunit": "^9.3.3" },
}, "funding": [
"autoload": { {
"psr-4": { "type": "funding",
"mirzaev\\arangodb\\": "mirzaev/arangodb/system" "url": "https://fund.mirzaev.sexy"
} }
}, ],
"autoload-dev": { "require": {
"psr-4": { "php": "^8.2",
"mirzaev\\arangodb\\tests\\": "mirzaev/arangodb/tests" "triagens/arangodb": "~3.8"
} },
} "require-dev": {
} "phpunit/phpunit": "^9.3.3"
},
"autoload": {
"psr-4": {
"mirzaev\\arangodb\\": "mirzaev/arangodb/system"
}
},
"autoload-dev": {
"psr-4": {
"mirzaev\\arangodb\\tests\\": "mirzaev/arangodb/tests"
}
}
}

0
composer.lock generated Normal file → Executable file
View File

236
mirzaev/arangodb/system/collection.php Normal file → Executable file
View File

@@ -1,118 +1,118 @@
<?php <?php
declare(strict_types=1); declare(strict_types=1);
namespace mirzaev\arangodb; namespace mirzaev\arangodb;
use mirzaev\arangodb\terminal; use mirzaev\arangodb\terminal;
use ArangoDBClient\Connection as _connection; use ArangoDBClient\Connection as _connection;
use ArangoDBClient\Collection as _collection; use ArangoDBClient\Collection as _collection;
use ArangoDBClient\Statement as _statement; use ArangoDBClient\Statement as _statement;
use ArangoDBClient\Document as _document; use ArangoDBClient\Document as _document;
use ArangoDBClient\CollectionHandler as _collection_handler; use ArangoDBClient\CollectionHandler as _collection_handler;
/** /**
* Коллекция * Коллекция
* *
* @package mirzaev\arangodb * @package mirzaev\arangodb
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy> * @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/ */
class collection class collection
{ {
/** /**
* Инициализация * Инициализация
* *
* @param _connection $session Сессия соединения с базой данных * @param _connection $session Сессия соединения с базой данных
* @param string $name Название * @param string $name Название
* @param bool $edge Обрабатывать как ребро? (иначе: вершина) * @param bool $edge Обрабатывать как ребро? (иначе: вершина)
* @param ?terminal $terminal Инстанция терминала * @param ?terminal $terminal Инстанция терминала
* *
* @return string|null Идентификатор коллекции * @return string|null Идентификатор коллекции
*/ */
public static function init(_connection $session, string $name, bool $edge = false, ?terminal $terminal = null): ?string public static function init(_connection $session, string $name, bool $edge = false, ?terminal $terminal = null): ?string
{ {
// Инициализация // Инициализация
$collections = new _collection_handler($session); $collections = new _collection_handler($session);
if (!$collections->has($name)) { if (!$collections->has($name)) {
// Не найдана коллекция // Не найдана коллекция
// Запись в вывод // Запись в вывод
if ($terminal instanceof terminal) $terminal::write("Коллекция \"$name\" не найдена"); if ($terminal instanceof terminal) $terminal::write("Коллекция \"$name\" не найдена");
// Запись коллекции на сервер и его ответ в буфер возврата // Запись коллекции на сервер и его ответ в буфер возврата
$id = $collections->create($name, ['type' => $edge ? _collection::TYPE_EDGE : _collection::TYPE_DOCUMENT]); $id = $collections->create($name, ['type' => $edge ? _collection::TYPE_EDGE : _collection::TYPE_DOCUMENT]);
if ($collections->has($name)) { if ($collections->has($name)) {
// Коллекция найдена (записана) // Коллекция найдена (записана)
// Запись в вывод // Запись в вывод
if ($terminal instanceof terminal) $terminal::write("Создана коллекция \"$name\" с типом " . ($edge ? 'ребро' : 'документ')); if ($terminal instanceof terminal) $terminal::write("Создана коллекция \"$name\" с типом " . ($edge ? 'ребро' : 'документ'));
// Возврат идентификатора коллекции // Возврат идентификатора коллекции
return $id; return $id;
} }
} else { } else {
// Найдена коллекция // Найдена коллекция
// Возврат идентификатора коллекции // Возврат идентификатора коллекции
return $name; return $name;
} }
return null; return null;
} }
/** /**
* Поиск * Поиск
* *
* @param _connection $session Сессия соединения с базой данных * @param _connection $session Сессия соединения с базой данных
* @param string $query AQL-запрос * @param string $query AQL-запрос
* *
* @return _document|null Инстанция документа * @return _document|array|string|int|null Инстанция документа
*/ */
public static function search(_connection $session, string $query): ?_document public static function search(_connection $session, string $query): _document|string|array|int|null
{ {
// Поиск журнала // Поиск журнала
$journal = (new _statement( $journal = (new _statement(
$session, $session,
[ [
'query' => $query, 'query' => $query,
"batchSize" => 1000, "batchSize" => 1000,
"sanitize" => true "sanitize" => true
] ]
))->execute(); ))->execute();
// Инициализация буфера вывода // Инициализация буфера вывода
$buffer = []; $buffer = [];
foreach ($journal as $key => $value) { foreach ($journal as $key => $value) {
$buffer[$key] = $value; $buffer[$key] = $value;
} }
return $buffer[0] ?? null; return is_array($buffer) && count($buffer) > 1 ? $buffer : $buffer[0] ?? null;
} }
/** /**
* Очистка * Очистка
* *
* @param _connection $session Сессия соединения с базой данных * @param _connection $session Сессия соединения с базой данных
* @param string $name Название * @param string $name Название
* *
* @return bool Статус выполнения * @return bool Статус выполнения
*/ */
public static function truncate(_connection $session, string $name): bool public static function truncate(_connection $session, string $name): bool
{ {
// Инициализация // Инициализация
$collections = new _collection_handler($session); $collections = new _collection_handler($session);
if ($collections->has($name)) { if ($collections->has($name)) {
// Найдена коллекция // Найдена коллекция
// Очистка // Очистка
return $collections->truncate($name); return $collections->truncate($name);
} }
return false; return false;
} }
} }

0
mirzaev/arangodb/system/connection.php Normal file → Executable file
View File

216
mirzaev/arangodb/system/document.php Normal file → Executable file
View File

@@ -1,108 +1,108 @@
<?php <?php
declare(strict_types=1); declare(strict_types=1);
namespace mirzaev\arangodb; namespace mirzaev\arangodb;
use mirzaev\arangodb\terminal; use mirzaev\arangodb\terminal;
use ArangoDBClient\Connection as _connection; use ArangoDBClient\Connection as _connection;
use ArangoDBClient\Document as _document; use ArangoDBClient\Document as _document;
use ArangoDBClient\Edge as _edge; use ArangoDBClient\Edge as _edge;
use ArangoDBClient\DocumentHandler as _document_handler; use ArangoDBClient\DocumentHandler as _document_handler;
use ArangoDBClient\EdgeHandler as _edge_handler; use ArangoDBClient\EdgeHandler as _edge_handler;
/** /**
* Документ * Документ
* *
* @package mirzaev\arangodb * @package mirzaev\arangodb
* @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy> * @author Arsen Mirzaev Tatyano-Muradovich <arsen@mirzaev.sexy>
*/ */
class document class document
{ {
/** /**
* Записать * Записать
* *
* @param _connection $session Сессия соединения с базой данных * @param _connection $session Сессия соединения с базой данных
* @param string $collection Коллекция * @param string $collection Коллекция
* @param ?array $data Данные * @param ?array $data Данные
* @param ?array $metadata Метаданные * @param bool $check Проверка на запись в базу данных
* @param bool $check Проверка на запись в базу данных * @param ?terminal $terminal Инстанция терминала
* @param ?terminal $terminal Инстанция терминала *
* * @return string|null Идентификатор
* @return string|null Идентификатор */
*/ public static function write(_connection $session, string $collection, ?array $data = [], bool $check = false, ?terminal $terminal = null): ?string
public static function write(_connection $session, string $collection, ?array $data = [], ?array $metadata = [], bool $check = false, ?terminal $terminal = null): ?string {
{ // Инициализация коллекции
// Инициализация коллекции collection::init($session, $collection, isset($data['_from'], $data['_to']));
collection::init($session, $collection, isset($metadata['_from'], $metadata['_to']));
if (isset($data['_from'], $data['_to'])) {
if (isset($metadata['_from'], $metadata['_to'])) { // Ребро
// Ребро
// Инициализация обработчика рёбер
// Инициализация обработчика рёбер $documents = new _edge_handler($session);
$documents = new _edge_handler($session);
// Инициализация ребра
// Инициализация ребра $document = new _edge();
$document = new _edge();
// Инициализация вершин
// Инициализация вершин $_from = $data['_from'];
$_from = $metadata['_from']; $_to = $data['_to'];
$_to = $metadata['_to'];
// Деинициализация из входных данных
// Деинициализация из входных данных unset($data['_from'], $data['_to']);
unset($metadata['_from'], $metadata['_to']); } else {
} else { // Вершина
// Вершина
// Инициализация обработчика вершин
// Инициализация обработчика вершин $documents = new _document_handler($session);
$documents = new _document_handler($session);
// Инициализация вершины
// Инициализация вершины $document = new _document();
$document = new _document(); }
}
foreach (['created' => time()] + $data as $key => $value) {
foreach (['data' => $data, 'metadata' => ($metadata ?? []) + ['created' => time()]] as $key => $value) { // Перебор параметров
// Перебор параметров
// Запись в инстанцию документа
// Запись в инстанцию документа $document->set($key, $value);
$document->set($key, $value); }
}
// Запись на сервер и его ответ в буфер возврата
// Запись на сервер и его ответ в буфер возврата $id = isset($_from, $_to) ? $documents->saveEdge($collection, $_from, $_to, $document) : $documents->insert($collection, $document);
$id = isset($_from, $_to) ? $documents->saveEdge($collection, $_from, $_to, $document) : $documents->insert($collection, $document);
if ($check && $documents->has($collection, $id)) {
if ($check && $documents->has($collection, $id)) { // Найден записанный документ
// Найден записанный документ
// Запись в вывод
// Запись в вывод if ($terminal instanceof terminal) $terminal::write("В коллекции \"$collection\" создан документ \"$id\"");
if ($terminal instanceof terminal) $terminal::write("В коллекции \"$collection\" создан документ \"$id\""); } else if ($check) {
} else if ($check) { // Не найден записанный документ
// Не найден записанный документ
// Запись в вывод
// Запись в вывод if ($terminal instanceof terminal) $terminal::write("В коллекции \"$collection\" не удалось найти созданный или создать документ");
if ($terminal instanceof terminal) $terminal::write("В коллекции \"$collection\" не удалось найти созданный или создать документ");
return null;
return null; }
}
// Возврат идентификатора коллекции
// Возврат идентификатора коллекции return $id;
return $id; }
}
/**
/** * Обновить
* Обновить *
* * @param _connection $session Сессия соединения с базой данных
* @param _connection $session Сессия соединения с базой данных * @param _document $document Инстанция документа вершины
* @param _document $document Инстанция документа вершины *
* * @return bool Статус обработки
* @return bool Статус обработки */
*/ public static function update(_connection $session, _document $document): bool
public static function update(_connection $session, _document $document): bool { {
// Инициализация обработчика вершин // Инициализация обработчика вершин
$documents = new _document_handler($session); $documents = new _document_handler($session);
// Запись в базу данных // Запись в базу данных
return $documents->update($document); return $documents->update($document);
} }
} }

46
mirzaev/arangodb/system/terminal.php Normal file → Executable file
View File

@@ -1,23 +1,23 @@
<?php <?php
declare(strict_types=1); declare(strict_types=1);
namespace mirzaev\arangodb; namespace mirzaev\arangodb;
class terminal class terminal
{ {
/** /**
* Префикс * Префикс
*/ */
protected const PREFIX = 'arangodb'; protected const PREFIX = 'arangodb';
/** /**
* Запись в вывод * Запись в вывод
* *
* @param string $text Текст сообщения * @param string $text Текст сообщения
*/ */
public static function write(string $text): void public static function write(string $text): void
{ {
echo sprintf("[%s] $text\n", self::PREFIX); echo sprintf("[%s] $text\n", self::PREFIX);
} }
} }