Prepare release

Author: Marco Bunge

CHANGELOG.md

@@ -1,8 +1,16 @@
-# Hawkbit Persistence Changelog
+# Hawkbit Database Changelog
 
 ## 1.0.0
 
 ### Added
 
- - Add persistence service, service provider and documentation
+ - Add mapper
+ - Add connection service
+ - Add gateway
+ - Add hydrator
+ - Add mapper
+ - Add identity map
+ - Add data mapper
+ - Add unit of work
+ 
 

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 Contributions are **welcome** and will be fully **credited**.
 
-We accept contributions via Pull Requests on [Github](https://github.com/HawkBitPhP/persistence).
+We accept contributions via Pull Requests on [Github](https://github.com/HawkBitPhP/database).
 
 ## Pull Requests
 

README.md

@@ -1,13 +1,12 @@
-# Hawkbit Persistence
+# Hawkbit Database
 
 [![Latest Version on Packagist][ico-version]][link-packagist]
 [![Software License][ico-license]](LICENSE.md)
 [![Build Status][ico-travis]][link-travis]
 [![Total Downloads][ico-downloads]][link-downloads]
 [![Coverage Status][ico-coveralls]][link-coveralls]
 
-Persistence layer for Hawkbit PSR-7 Micro PHP framework.
-Features unit of work, identity map, object graph, popo's and mapper. 
+Object orientated database handling with POPO's, unit of work, identity map and data mapper. 
 
 ## Install
 
@@ -39,7 +38,7 @@ require __DIR__ . '/vendor/autoload.php';
 
 ### Downloading .zip file
 
-This project is also available for download as a `.zip` file on GitHub. Visit the [releases page](https://github.com/hawkbit/persistence/releases), select the version you want, and click the "Source code (zip)" download button.
+This project is also available for download as a `.zip` file on GitHub. Visit the [releases page](https://github.com/hawkbit/database/releases), select the version you want, and click the "Source code (zip)" download button.
 
 ### Requirements
 
@@ -50,91 +49,9 @@ The following versions of PHP are supported by this version.
 * PHP 7.0
 * HHVM
 
-## Setup
+## Usage
 
-Create a Mapper and an entity. See 
-
-Create a Connection and register mappers
-
-```php
-<?php
-
-use Hawkbit\Database\ConnectionManager;
-use Application\Persistence\Mappers\PostMapper;
-
-$connection = ConnectionManager::create([
-    'url' => 'sqlite:///:memory:',
-    'memory' => 'true'
-]);
-
-$connection->getMapperLocator()->register(PostMapper::class);
-```
-
-Load Mapper by mapper class or entity class
-
-```php
-<?php
-
-use Application\Persistence\Mappers\PostMapper;
-use Application\Persistence\Entities\Post;
-
-// load by mapper
-$mapper = $connection->loadMapper(PostMapper::class);
-
-// load by entity
-$mapper = $connection->loadMapper(Post::class);
-
-```
-
-## Data manipulation
-
-### Create entity
-
-```php
-<?php
-
-use Application\Persistence\Entities\Post;
-
-$entity = new Post();
-
-$entity->setContent('cnt');
-
-/** @var Post $createdEntity */
-$mapper->create($entity);
-
-```
-
-
-### Load entity
-
-```php
-<?php
-
-$entity = $mapper->find(['id' => 1]);
-
-```
-
-
-### Update entity
-
-```php
-<?php
-
-$entity->setContent('FOO');
-$mapper->update($entity);
-
-```
-
-### Delete entity
-
-```php
-<?php
-
-$mapper->delete($entity);
-
-```
-
-## Transactions
+View [Examples](examples) for usage.
 
 ## Change log
 
@@ -157,17 +74,17 @@ If you discover any security related issues, please email <[email protected]> instead
 ## Credits
 
 - [Marco Bunge](https://github.com/mbunge)
-- [All contributors](https://github.com/hawkbit/persistence/graphs/contributors)
+- [All contributors](https://github.com/hawkbit/database/graphs/contributors)
 
 ## License
 
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
 
-[ico-version]: https://img.shields.io/packagist/v/hawkbit/persistence.svg?style=flat-square
+[ico-version]: https://img.shields.io/packagist/v/hawkbit/database.svg?style=flat-square
 [ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
-[ico-travis]: https://img.shields.io/travis/HawkBitPhp/hawkbit-persistence/master.svg?style=flat-square
-[ico-downloads]: https://img.shields.io/packagist/dt/hawkbit/persistence.svg?style=flat-square
-[ico-coveralls]: https://img.shields.io/coveralls/HawkBitPhp/hawkbit-persistence/master.svg?style=flat-square
+[ico-travis]: https://img.shields.io/travis/HawkBitPhp/hawkbit-database/master.svg?style=flat-square
+[ico-downloads]: https://img.shields.io/packagist/dt/hawkbit/database.svg?style=flat-square
+[ico-coveralls]: https://img.shields.io/coveralls/HawkBitPhp/hawkbit-database/master.svg?style=flat-square
 
 [link-packagist]: https://packagist.org/packages/hawkbit/hawkbit
 [link-travis]: https://travis-ci.org/HawkBitPhp/hawkbit

composer.json

@@ -1,7 +1,6 @@
 {
-  "name": "hawkbit/persistence",
-  "type": "hawkbit-component",
-  "description": "Persistence layer for Hawkbit PSR-7 Micro PHP framework",
+  "name": "hawkbit/database",
+  "description": "Object orientated database handling",
   "keywords": [
     "doctrine",
     "orm",
@@ -18,13 +17,11 @@
   ],
   "require": {
     "php": ">=5.5.0",
-    "doctrine/collections": "~1.3",
     "doctrine/dbal": "~2.5",
     "doctrine/inflector": "~1.1"
   },
   "require-dev": {
-    "phpunit/phpunit": "~4.8",
-    "hawkbit/hawkbit": "~2.0"
+    "phpunit/phpunit": "~4.8"
   },
   "autoload": {
     "psr-4": {

example/bootstrap.php renamed to example/mapper.php

@@ -26,6 +26,9 @@
 $entity = new Post();
 $mapper = $connection->loadMapper($entity);
 
+// or create entity from mapper
+//$entity = $mapper->createEntity();
+
 // create entity
 $entity->setContent('cnt');
 $mapper->create($entity);

example/unitOfWork.php

@@ -0,0 +1,63 @@
+<?php
+
+use Application\Persistence\Entities\Post;
+use Application\Persistence\Mappers\PostMapper;
+use Hawkbit\Database\ConnectionManager;
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+/*
+ * Tis is only an example. All steps are separated in their specific logic
+ */
+
+// setup connection
+$connection = ConnectionManager::create([
+    'url' => 'sqlite:///:memory:',
+    'memory' => 'true'
+]);
+
+// setup schema
+$connection->exec('CREATE TABLE post (id int, title VARCHAR(255), content TEXT, date DATETIME DEFAULT CURRENT_DATE )');
+
+// register mappers
+$connection->getMapperLocator()->register(PostMapper::class);
+
+// load mapper
+$mapper = $connection->loadMapper(Post::class);
+$unitOfWork = $connection->createUnitOfWork();
+$entity = new Post();
+
+// or create entity from mapper
+//$entity = $mapper->createEntity();
+
+// create entity
+$entity->setContent('cnt');
+$unitOfWork->create($entity);
+
+// commit transaction
+if(false === $unitOfWork->commit()){
+    //handle exception
+    $unitOfWork->getException();
+
+    // get last processed entity
+    $unitOfWork->getLastProcessed();
+}
+
+// get all modified entities
+$unitOfWork->getModified();
+
+// get a list of all entities by state
+$unitOfWork->getProcessed();
+
+// find entity by primary key or compound key
+$mapper->find(['id' => 1]);
+
+// update entity
+$entity->setContent('FOO');
+$unitOfWork->update($entity);
+
+// delete entity
+$unitOfWork->delete($entity);
+
+// commit transaction
+$unitOfWork->commit();

src/Connection.php

@@ -56,7 +56,7 @@ public function setPrefix($prefix)
 
     /**
      * @param $entityOrMapper
-     * @return Mapper
+     * @return Mapper|AbstractMapper
      */
     public function loadMapper($entityOrMapper){
 

src/UnitOfWork.php

@@ -37,6 +37,11 @@ final class UnitOfWork
      */
     private $processed = [];
 
+    /**
+     * @var
+     */
+    private $lastProcessed = null;
+
     /**
      * @var Connection
      */
@@ -81,6 +86,22 @@ public function getException()
         return $this->exception;
     }
 
+    /**
+     * @return mixed
+     */
+    public function getLastProcessed()
+    {
+        return $this->lastProcessed;
+    }
+
+    /**
+     * @return array
+     */
+    public function getProcessed()
+    {
+        return $this->processed;
+    }
+
     /**
      * @param $object
      */
@@ -184,6 +205,7 @@ public function commit()
         $connection = $this->connection;
         $this->processed = [];
         $this->modified = [];
+        $this->lastProcessed = null;
 
         try {
             $connection->beginTransaction();
@@ -220,6 +242,7 @@ protected function process($label, &$entities, callable $task)
     {
         foreach ($entities as $key => $entity) {
             $task($entity);
+            $this->lastProcessed = $entity;
             $this->processed[$label][] = $entity;
             if(IdentityMap::REMOVED !== $label){
                 $this->modified[] = $entity;