english description

composer.json

@@ -1,6 +1,7 @@
 {
     "name": "mirzaev/arangodb",
-    "description": "Реализация управления хранилищем данных ArangoDB",
+    "description": "Simple PHP-framework for ArangoDB",
+    "readme": "README.md",
     "keywords": [
         "ArangoDB"
     ],
@@ -15,6 +16,17 @@
             "role": "Developer"
         }
     ],
+    "support": {
+        "email": "arsen@mirzaev.sexy",
+        "wiki": "https://git.mirzaev.sexy/mirzaev/arangodb/manual",
+        "issues": "https://git.mirzaev.sexy/mirzaev/arangodb/issues"
+    },
+    "funding": [
+        {
+            "type": "funding",
+            "url": "https://fund.mirzaev.sexy"
+        }
+    ],
     "require": {
         "php": "^8.1",
         "triagens/arangodb": "~3.8"

mirzaev/arangodb/system/collection.php

@@ -25,11 +25,12 @@ class collection
      *
      * @param _connection $session Сессия соединения с базой данных
      * @param string $name Название
-     * @param bool $edge Это ребро? (иначе: вершина)
+     * @param bool $edge Обрабатывать как ребро? (иначе: вершина)
+     * @param ?terminal $terminal Инстанция терминала
      *
      * @return string|null Идентификатор коллекции
      */
-    public static function init(_connection $session, string $name, bool $edge = false): ?string
+    public static function init(_connection $session, string $name, bool $edge = false, ?terminal $terminal = null): ?string
     {
         // Инициализация
         $collections = new _collection_handler($session);
@@ -38,7 +39,7 @@ class collection
             // Не найдана коллекция
 
             // Запись в вывод
-            terminal::write("Коллекция \"$name\" не найдена");
+            if ($terminal instanceof terminal) $terminal::write("Коллекция \"$name\" не найдена");
 
             // Запись коллекции на сервер и его ответ в буфер возврата
             $id = $collections->create($name, ['type' => $edge ? _collection::TYPE_EDGE : _collection::TYPE_DOCUMENT]);
@@ -47,7 +48,7 @@ class collection
                 // Коллекция найдена (записана)
 
                 // Запись в вывод
-                terminal::write("Создана коллекция \"$name\" с типом " . ($edge ? 'ребро' : 'документ'));
+                if ($terminal instanceof terminal) $terminal::write("Создана коллекция \"$name\" с типом " . ($edge ? 'ребро' : 'документ'));
 
                 // Возврат идентификатора коллекции
                 return $id;

mirzaev/arangodb/system/document.php

@@ -26,17 +26,17 @@ class document
      * @param _connection $session Сессия соединения с базой данных
      * @param string $collection Коллекция
      * @param ?array $data Данные
-     * @param ?array $metadata Метаданные
      * @param bool $check Проверка на запись в базу данных
+     * @param ?terminal $terminal Инстанция терминала
      *
      * @return string|null Идентификатор
      */
-    public static function write(_connection $session, string $collection, ?array $data = null, ?array $metadata = null, bool $check = true): ?string
+    public static function write(_connection $session, string $collection, ?array $data = [], bool $check = false, ?terminal $terminal = null): ?string
     {
         // Инициализация коллекции
         collection::init($session, $collection, isset($data['_from'], $data['_to']));
 
-        if (isset($metadata['_from'], $metadata['_to'])) {
+        if (isset($data['_from'], $data['_to'])) {
             // Ребро
 
             // Инициализация обработчика рёбер
@@ -46,11 +46,11 @@ class document
             $document = new _edge();
 
             // Инициализация вершин
-            $_from = $metadata['_from'];
+            $_from = $data['_from'];
-            $_to = $metadata['_to'];
+            $_to = $data['_to'];
 
             // Деинициализация из входных данных
-            unset($metadata['_from'], $metadata['_to']);
+            unset($data['_from'], $data['_to']);
         } else {
             // Вершина
 
@@ -61,7 +61,7 @@ class document
             $document = new _document();
         }
 
-        foreach (['data' => $data, 'metadata' => ($metadata ?? []) + ['created' => time()]] as $key => $value) {
+        foreach (['created' => time()] + $data as $key => $value) {
             // Перебор параметров
 
             // Запись в инстанцию документа
@@ -72,10 +72,17 @@ class document
         $id = isset($_from, $_to) ? $documents->saveEdge($collection, $_from, $_to, $document) : $documents->insert($collection, $document);
 
         if ($check && $documents->has($collection, $id)) {
-            // Документ записан
+            // Найден записанный документ
 
             // Запись в вывод
-            terminal::write("В коллекции \"$collection\" создан документ \"$id\"");
+            if ($terminal instanceof terminal) $terminal::write("В коллекции \"$collection\" создан документ \"$id\"");
+        } else if ($check) {
+            // Не найден записанный документ
+
+            // Запись в вывод
+            if ($terminal instanceof terminal) $terminal::write("В коллекции \"$collection\" не удалось найти созданный или создать документ");
+
+            return null;
         }
 
         // Возврат идентификатора коллекции
@@ -90,7 +97,8 @@ class document
      *
      * @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);
 

mirzaev/arangodb/system/terminal.php

@@ -18,14 +18,6 @@ class terminal
      */
     public static function write(string $text): void
     {
-        echo self::generate_prefix() . ' ' . $text . PHP_EOL;
+        echo sprintf("[%s] $text\n", self::PREFIX);
-    }
-
-    /**
-     * Генерация префикса
-     */
-    public static function generate_prefix(): string
-    {
-        return '[' . self::PREFIX . ']';
     }
 }