add files

Author: andkom

.gitignore

@@ -0,0 +1 @@
+.idea

CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 1.0.0 (19-07-17)
+
+- first public release

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Andrei K.
+Copyright (c) 2018 Andrei Komarov.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -0,0 +1,166 @@
+# PHP Berkeley DB
+
+Simple Berkeley DB wrapper for PHP.
+
+## Installation
+
+**Download Berkeley DB source:**
+
+```bash
+wget 'http://download.oracle.com/berkeley-db/db-x.x.x.tar.gz'
+tar -xzvf db-x.x.x.tar.gz
+```
+
+**Build Berkeley DB libraries and headers:** 
+
+```bash
+cd db-x.x.x/build_unix/
+../dist/configure --enable-cxx
+make
+make install
+```
+
+**Install php_db4 extension for "phpdb4" adapter (better):**
+
+Build db4 extension:
+
+```bash
+cd ../lang/php4_db
+phpize
+./configure --with-db4=/usr/local/BerkeleyDB.x.x
+make
+make install
+```
+
+Add db4 extension to php.ini:
+
+```ini
+extension=db4.so
+```
+
+**Or install db4 DBA handler for "dba" adapter:**
+
+Build PHP with db4 support:
+
+```bash
+./configure --with-db4=/usr/local/BerkeleyDB.x.x
+make
+sudo make install
+```
+
+**Install composer package:**
+
+```bash
+composer install andkom/php-berkeley-db
+```
+
+## Usage
+
+**Create instance:**
+
+```PHP
+use AndKom\PhpBerkeleyDb\Adapter\AdapterFactory;
+
+$adapter = AdapterFactory::create(); // use first available adapter
+$adapter = AdapterFactory::create("phpdb4"); // use phpdb4 adapter
+$adapter = AdapterFactory::create("dba"); // use dba adapter
+```
+
+**Open database for reading:**
+
+```PHP
+$adapter->open("filename", "r");
+```
+
+**Open database with optional database name:**
+
+```PHP
+$adapter->open("filename", "r", "main");
+```
+
+**Open database for writing:**
+
+```PHP
+$adapter->open("filename", "w");
+```
+
+**Close database:**
+
+```PHP
+$adapter->close();
+```
+
+**Sync changes to database:**
+
+```PHP
+$adapter->sync();
+```
+
+**Read key value:**
+
+```PHP
+$value = $adapter->get("key");
+```
+
+**Write key value:**
+
+```PHP
+$adapter->put("key", "value");
+```
+
+**Delete key:**
+
+```PHP
+$adapter->delete("key");
+```
+
+**Returns first key and moves cursor to the next position:**
+
+```PHP
+$adapter->firstKey();
+```
+
+**Read next key and moves cursor to the next position:**
+
+```PHP
+$adapter->nextKey();
+```
+
+**Read all database keys:**
+
+```PHP
+foreach ($adapter->read() as $key => $value) {
+    ...
+}
+```
+
+### Laravel Service Provider
+
+**Publish configuration to app config:**
+
+```bash
+./artisan vendor:publish --provider=AndKom\\PhpBerkeleyDb\\ServiceProvider
+```
+
+**Edit app/config/berkeleydb.php:**
+
+```PHP
+<?php
+ 
+return [
+    'adapter' => 'phpdb4',
+ 
+    'filename' => database_path('database.dat'),
+ 
+    'database' => null,
+ 
+    'mode' => 'w',
+];
+
+```
+
+**Use BDB facade to access database methods:**
+
+```PHP
+$value = BDB::get("key");
+```

composer.json

@@ -0,0 +1,44 @@
+{
+  "name": "andkom/php-berkeley-db",
+  "description": "A simple Berkeley DB library for PHP.",
+  "type": "library",
+  "keywords": [
+    "berkeley",
+    "database",
+    "db",
+    "db4"
+  ],
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Andrei Komarov"
+    }
+  ],
+  "require": {
+    "php": "^7.0",
+    "ext-db4": ">=4.0"
+  },
+  "require-dev": {
+    "phpunit/phpunit": ">=5.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "AndKom\\PhpBerkeleyDb\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "AndKom\\PhpBerkeleyDb\\Tests\\": "tests/"
+    }
+  },
+  "extra": {
+    "laravel": {
+      "providers": [
+        "AndKom\\PhpBerkeleyDb\\ServiceProvider"
+      ],
+      "aliases": {
+        "BDB": "AndKom\\PhpBerkeleyDb\\Facade\\BDB"
+      }
+    }
+  }
+}

config/berkeleydb.php

@@ -0,0 +1,23 @@
+<?php
+
+return [
+    /**
+     * Adapter to use: "phpdb4", "dba" or null.
+     */
+    'adapter' => null,
+
+    /**
+     * Path to database filename.
+     */
+    'filename' => database_path('database.dat'),
+
+    /**
+     * Database name (optional).
+     */
+    'database' => null,
+
+    /**
+     * Database open mode (r - read, w - write).
+     */
+    'mode' => 'w',
+];

phpunit.xml.dist

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         colors="true"
+         verbose="true">
+    <testsuites>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Adapter/AbstractAdapter.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AndKom\PhpBerkeleyDb\Adapter;
+
+use AndKom\PhpBerkeleyDb\Exception;
+
+/**
+ * Class AbstractAdapter
+ * @package AndKom\PhpBerkeleyDb\Adapter
+ */
+abstract class AbstractAdapter implements AdapterInterface
+{
+    /**
+     * Read database keys.
+     * @return \Generator
+     * @throws Exception
+     */
+    public function read(): \Generator
+    {
+        if ($key = $this->firstKey()) {
+            yield $key => $this->get($key);
+        }
+
+        while ($key = $this->nextKey()) {
+            yield $key => $this->get($key);
+        }
+    }
+}

src/Adapter/AdapterFactory.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AndKom\PhpBerkeleyDb\Adapter;
+
+/**
+ * Class AdapterFactory
+ * @package AndKom\PhpBerkeleyDb\Adapter
+ */
+class AdapterFactory
+{
+    /**
+     * @param string|null $adapter
+     * @return AdapterInterface
+     */
+    public static function create(string $adapter = null): AdapterInterface
+    {
+        if (is_null($adapter)) {
+            $adapter = static::getDefaultAdapter();
+        }
+
+        switch ($adapter) {
+            case 'phpdb4':
+                return new PhpDb4Adapter();
+
+            case 'dba':
+                return new DbaAdapter();
+        }
+
+        throw new \InvalidArgumentException("Unsupported adapter $adapter.");
+    }
+
+    /**
+     * @return string
+     */
+    public static function getDefaultAdapter(): string
+    {
+        if (class_exists('\Db4')) {
+            return 'phpdb4';
+        } elseif (extension_loaded('dba') && in_array('db4', dba_handlers())) {
+            return 'dba';
+        } else {
+            throw new \RuntimeException("Your PHP installation doesn't support Berkeley DB.");
+        }
+    }
+}