Merge pull request #1 from activecollab/manager

Rename Objects to Entities, deprecate old Object class and ObjectInterface, and add concept of Entity Manager

Author: ilijastuden

README.md

@@ -5,25 +5,26 @@
 DatabaseObject library is a set of classes that make work with database just a bit easier. Here are the key concepts:
 
 1. Types - entities that map to a single table,
-2. Objects - type instances that map to a single row of a type table,
-3. Collections - a group of objects that meets the given criteria. This group is perfect for HTTP responses because collections support data tagging and tag validation (ETag and HTTP 304),
-4. Pool - manage registered types and make multi-type interaction possible,
-6. Producers - customise the way pool produces new instances,
-7. Validators - validate object properties before saving them to the database.
+1. Entities - type instances that map to a single row of a type table,
+1. Entity Manager - instances that provide access to custom type specific manipulation methods,
+1. Collections - a group of objects that meets the given criteria. This group is perfect for HTTP responses because collections support data tagging and tag validation (ETag and HTTP 304),
+1. Pool - manage registered types and make multi-type interaction possible,
+1. Producers - customise the way pool produces new instances,
+1. Validators - validate object properties before saving them to the database.
 
 ## CRUD
 
 If you wish to work with entire tables, use CRUD methods provided by `ConnectionInterface`:
 
 1. `ConnectionInterface::insert()` - insert one or more rows
-2. `ConnectionInterface::update()` - update a set of rows that match the given conditions, if any
-3. `ConnectionInterface::delete()` - drop a set of rows taht match the given conditions, if any
+1. `ConnectionInterface::update()` - update a set of rows that match the given conditions, if any
+1. `ConnectionInterface::delete()` - drop a set of rows taht match the given conditions, if any
 
 When you need to work with individual instances, `PoolInterface` provides following handy methods:
 
 1. `PoolInterface::produce()` - create a new record based on the given parameters,
-2. `PoolInterface::modify()` - change the given object with a set of parameters,
-3. `PoolInterface::scrap()` - trash or permanently delete the given object.
+1. `PoolInterface::modify()` - change the given object with a set of parameters,
+1. `PoolInterface::scrap()` - trash or permanently delete the given object.
 
 ## Scrap
 

src/Collection/Type.php

@@ -10,7 +10,7 @@
 
 use ActiveCollab\DatabaseConnection\Result\ResultInterface;
 use ActiveCollab\DatabaseObject\Collection;
-use ActiveCollab\DatabaseObject\ObjectInterface;
+use ActiveCollab\DatabaseObject\Entity\EntityInterface;
 use Doctrine\Common\Inflector\Inflector;
 use InvalidArgumentException;
 use LogicException;
@@ -159,7 +159,7 @@ public function getTimestampHash($timestamp_field)
     /**
      * Run the query and return DB result.
      *
-     * @return ResultInterface|ObjectInterface[]
+     * @return ResultInterface|EntityInterface[]
      */
     public function execute()
     {

src/CollectionInterface.php

@@ -9,6 +9,7 @@
 namespace ActiveCollab\DatabaseObject;
 
 use ActiveCollab\DatabaseConnection\Result\ResultInterface;
+use ActiveCollab\DatabaseObject\Entity\EntityInterface;
 use ActiveCollab\Etag\EtagInterface;
 use JsonSerializable;
 
@@ -35,7 +36,7 @@ public function &setApplicationIdentifier($value);
     /**
      * Run the query and return DB result.
      *
-     * @return ResultInterface|ObjectInterface[]
+     * @return ResultInterface|EntityInterface[]
      */
     public function execute();